diff options
Diffstat (limited to 'osgi/bundles/org.eclipse.osgi.services.remoteserviceadmin/src/org/osgi/service/remoteserviceadmin/ExportRegistration.java')
-rw-r--r-- | osgi/bundles/org.eclipse.osgi.services.remoteserviceadmin/src/org/osgi/service/remoteserviceadmin/ExportRegistration.java | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/osgi/bundles/org.eclipse.osgi.services.remoteserviceadmin/src/org/osgi/service/remoteserviceadmin/ExportRegistration.java b/osgi/bundles/org.eclipse.osgi.services.remoteserviceadmin/src/org/osgi/service/remoteserviceadmin/ExportRegistration.java new file mode 100644 index 000000000..012e38def --- /dev/null +++ b/osgi/bundles/org.eclipse.osgi.services.remoteserviceadmin/src/org/osgi/service/remoteserviceadmin/ExportRegistration.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) OSGi Alliance (2009, 2010). All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.osgi.service.remoteserviceadmin; + +import java.util.Map; + +import org.osgi.framework.ServiceReference; + +/** + * An Export Registration associates a service to a local endpoint. + * + * The Export Registration can be used to delete the endpoint associated with an + * this registration. It is created with the + * {@link RemoteServiceAdmin#exportService(ServiceReference,Map)} method. + * + * When this Export Registration has been closed, all methods must return + * {@code null}. + * + * @ThreadSafe + * @noimplement + * @version $Id: d215ae704a94dd944d2311c81fa32a4647351713 $ + */ +public interface ExportRegistration { + /** + * Return the Export Reference for the exported service. + * + * @return The Export Reference for this registration. + * @throws IllegalStateException When this registration was not properly + * initialized. See {@link #getException()}. + */ + ExportReference getExportReference(); + + /** + * Delete the local endpoint and disconnect any remote distribution + * providers. After this method returns, all methods must return + * {@code null}. + * + * This method has no effect when this registration has already been closed + * or is being closed. + */ + void close(); + + /** + * Return the exception for any error during the export process. + * + * If the Remote Service Admin for some reasons is unable to properly + * initialize this registration, then it must return an exception from this + * method. If no error occurred, this method must return {@code null}. + * + * The error must be set before this Export Registration is returned. + * Asynchronously occurring errors must be reported to the log. + * + * @return The exception that occurred during the initialization of this + * registration or {@code null} if no exception occurred. + */ + Throwable getException(); +} |