summaryrefslogtreecommitdiffstats
path: root/sca-java-2.x/tags/2.0.1-RC1/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DomainRegistry.java
blob: 5fa38943ace4cc8b977109b2fb20c9684176aa08 (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.runtime;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;

import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.assembly.Endpoint;
import org.apache.tuscany.sca.assembly.EndpointReference;

/**
 * The DomainRegistry holds the active service endpoints for the SCA domain
 * @tuscany.spi.extension.inheritfrom
 */
public interface DomainRegistry {
    /**
     * Indicate if the domain is distributed
     * @return
     */
    boolean isDistributed();
    
    /**
     * Add an enpoint to the registry. If the endpoint URI is the same as an existing endpoint in the registry,
     * the existing one will be updated
     * @param endpoint
     */
    void addEndpoint(Endpoint endpoint);
    
    /**
     * Remove an enpoint from the registry
     * @param endpoint
     */
    void removeEndpoint(Endpoint endpoint);

    /**
     * Look up an enpoint from the registry
     * @param uri The endpoint URI
     * @return
     */
    Endpoint getEndpoint(String uri);
    
    /**
     * Get all endpoints in the registry
     * @return
     */
    Collection<Endpoint> getEndpoints();
    
    List<Endpoint> findEndpoint(String uri);
    List<Endpoint> findEndpoint(EndpointReference endpointReference);

    void addEndpointReference(EndpointReference endpointReference);
    void removeEndpointReference(EndpointReference endpointReference);
    // List<EndpointReference> findEndpointReference(Endpoint endpoint);
    List<EndpointReference> getEndpointReferences();
    
    boolean isOutOfDate(EndpointReference endpointReference);
    
    /** 
     * Returns a list of EndpointReferences that have a URI that matches a given URI
     * @param uri - the URI to match
     * @return a List of EndpointReferences that match the supplied URI - if there are none
     * an *empty* list is returned (not null)
     */
    public List<EndpointReference> findEndpointReferences( String uri );

    void addEndpointListener(EndpointListener listener);
    void removeEndpointListener(EndpointListener listener);

    String getDomainURI();
    String getDomainName();

    void installContribution(ContributionDescription cd);
    void uninstallContribution(String uri);
    List<String> getInstalledContributionURIs();
    ContributionDescription getInstalledContribution(String uri);
    void updateInstalledContribution(ContributionDescription cd);
    
    void addContributionListener(ContributionListener listener);
    void removeContributionListener(ContributionListener listener);

    void addRunningComposite(String contributionURI, Composite composite);
    void removeRunningComposite(String contributionURI, String compositeURI);
    Map<String, List<String>> getRunningCompositeURIs();
    Composite getRunningComposite(String contributionURI, String compositeURI);

    String getContainingCompositesContributionURI(String componentName);
    
    List<String> getNodeNames();
    String getLocalNodeName();
    String getRunningNodeName(String contributionURI, String compositeURI);
    
    String remoteCommand(String memberName, Callable<String> command);
    public Composite getDomainComposite();
}