summaryrefslogtreecommitdiffstats
path: root/java/sca/modules/node-impl-osgi/src/main/java/org/apache/tuscany/sca/osgi/remoteserviceadmin/ExportRegistration.java
blob: 231d7422202d9a0f9bd1c481e2b89c509d4a80d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
 * Copyright (c) OSGi Alliance (2008, 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.apache.tuscany.sca.osgi.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 <code>null</code>.
 * 
 * @ThreadSafe
 */
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() throws IllegalStateException;

    /**
     * Delete the local endpoint and disconnect any remote distribution
     * providers. After this method returns, all the methods must return
     * <code>null</code>.
     * 
     * 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 <code>Throwable</code> 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
     * <code>null</code>.
     * 
     * 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 <code>null</code> if no exception occurred.
     */
    Throwable getException();
}