/*
* Copyright (c) OSGi Alliance (2009). 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 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,java.util.Map)}
* method.
*
* When this Export Registration has been unregistered, the methods must all
* return null
.
*
* @ThreadSafe
* @version $Revision$
*/
public interface ExportRegistration {
/**
* Return the Export Reference for the exported service.
*
* @return An Export Reference for this registration
* @throws IllegalStateException Thrown when this object was not properly
* initialized, see {@link #getException()}
*/
ExportReference getExportReference();
/**
* Delete the local endpoint and disconnect any remote distribution
* providers. After this method returns, all the methods must return
* null
.
*
* This method has no effect when the endpoint is already destroyed or being
* destroyed.
*/
void close();
/**
* Exception for any error during the import process.
*
* If the Remote Admin for some reasons is unable to create a registration,
* then it must return a Throwable
from this method. In this
* case, all other methods must return on this interface must throw an
* Illegal State Exception. If no error occurred, this method must return
* null
.
*
* The error must be set before this Import Registration is returned.
* Asynchronously occurring errors must be reported to the log.
*
* @return The exception that occurred during the creation of the
* registration or null
if no exception occurred.
*/
Throwable getException();
}