Class RemoteServiceAdmin
java.lang.Object
org.eclipse.ecf.osgi.services.remoteserviceadmin.RemoteServiceAdmin
- All Implemented Interfaces:
RemoteServiceAdmin
ECF implementation of
OSGI 4.2
Remote Service Admin service. This service can be used by topology
managers to to export and/or import remote services with any
ECF
container that implements the
ECF remote
service API.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassclassclassclassprotected classclass -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRemoteServiceAdmin(Bundle clientBundle) RemoteServiceAdmin(Bundle clientBundle, Collection<ExportRegistration> exportedRegistrations, Collection<ImportRegistration> importedRegistrations) -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()exportService(ServiceReference<?> serviceReference, Map<String, ?> op) Export a service to a given Endpoint.protected IConsumerContainerSelectorReturn the currently active Export References.protected IHostContainerSelectorReturn the currently active Import References.importService(EndpointDescription endpointDescription) Import a service from an Endpoint.
-
Field Details
-
SERVICE_PROP
- See Also:
-
-
Constructor Details
-
RemoteServiceAdmin
-
RemoteServiceAdmin
public RemoteServiceAdmin(Bundle clientBundle, Collection<ExportRegistration> exportedRegistrations, Collection<ImportRegistration> importedRegistrations) - Parameters:
clientBundle- client bundle for RemoteServiceAdmin instanceexportedRegistrations- of exported registrationsimportedRegistrations- of imported registrations- Since:
- 4.1
-
-
Method Details
-
getExportedRegistrations
- Returns:
- List of exported registrations
- Since:
- 4.2
-
getImportedRegistrations
- Returns:
- List of imported registrations
- Since:
- 4.2
-
exportService
public Collection<ExportRegistration> exportService(ServiceReference<?> serviceReference, Map<String, ?> op) Description copied from interface:RemoteServiceAdminExport a service to a given Endpoint. The Remote Service Admin must create an Endpoint from the given description that can be used by other Distribution Providers to connect to this Remote Service Admin and use the exported service. The property keys of a Service Reference are case insensitive while the property keys of the specifiedpropertiesmap are case sensitive. A property key in the specifiedpropertiesmap must therefore override any case variant property key in the properties of the specified Service Reference.If the caller does not have the appropriate
EndpointPermission[endpoint,EXPORT]for an Endpoint, and the Java Runtime Environment supports permissions, then thegetExceptionmethod on the corresponding returnedExportRegistrationwill return aSecurityException.- Specified by:
exportServicein interfaceRemoteServiceAdmin- Parameters:
serviceReference- The Service Reference to export.op- The properties to create a local Endpoint that can be implemented by this Remote Service Admin. If this isnull, the Endpoint will be determined by the properties on the service. The properties are the same as given for an exported service. They override any properties in the specified Service Reference (case insensitive). The propertiesobjectClassandservice.id, in any case variant, are ignored. Those properties in the Service Reference cannot be overridden. This parameter can benull, this should be treated as an empty map.- Returns:
- A
CollectionofExportRegistrations for the specified Service Reference and properties. Multiple Export Registrations may be returned because a single service can be exported to multiple Endpoints depending on the available configuration type properties and the intents that they support. The result is nevernullbut may be empty if this Remove Service Admin does not recognize any of the configuration types, or if they Remote Service Admin cannot support the relevant intents.
-
importService
Description copied from interface:RemoteServiceAdminImport a service from an Endpoint. The Remote Service Admin must use the given Endpoint to create a proxy. This method can returnnullif the service could not be imported.- Specified by:
importServicein interfaceRemoteServiceAdmin- Parameters:
endpointDescription- The Endpoint Description to be used for import.- Returns:
- An Import Registration that combines the Endpoint Description and
the Service Reference or
nullif the Endpoint could not be imported.
-
getExportedServices
Description copied from interface:RemoteServiceAdminReturn the currently active Export References.If the caller does not have the appropriate
EndpointPermission[endpoint,READ]for an Endpoint, and the Java Runtime Environment supports permissions, then returned collection will not contain a reference to the exported Endpoint.- Specified by:
getExportedServicesin interfaceRemoteServiceAdmin- Returns:
- A
CollectionofExportReferences that are currently active.
-
getImportedEndpoints
Description copied from interface:RemoteServiceAdminReturn the currently active Import References.If the caller does not have the appropriate
EndpointPermission[endpoint,READ]for an Endpoint, and the Java Runtime Environment supports permissions, then returned collection will not contain a reference to the imported Endpoint.- Specified by:
getImportedEndpointsin interfaceRemoteServiceAdmin- Returns:
- A
CollectionofImportReferences that are currently active.
-
getHostContainerSelector
-
getConsumerContainerSelector
-
close
public void close()
-