summaryrefslogtreecommitdiffstats
path: root/sca-java-2.x/tags/2.0.1-RC1/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java
blob: 07824bd4d731ac81298d9c9a956899a7a0584cba (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * 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.contribution;

import java.util.List;
import java.util.Set;

import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.assembly.Extensible;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;

/**
 * The representation of an SCA contribution.
 *
 * @version $Rev$ $Date$
 * @tuscany.spi.extension.asclient
 */
public interface Contribution extends Artifact, Extensible {

    /**
     * Default location of contribution metadata in an SCA contribution.
     */
    String SCA_CONTRIBUTION_META = "META-INF/sca-contribution.xml";

    /**
     * Default location of a generated contribution metadata in an SCA contribution.
     */
    String SCA_CONTRIBUTION_GENERATED_META = "META-INF/sca-contribution-generated.xml";

    /**
     * Returns a list of exports based on the contribution metadata.
     *
     * @return The list of exports in this contribution
     */
    List<Export> getExports();

    /**
     * Returns a list of imports based on the contribution metadata.
     *
     * @return The list of imports in this contribution
     */
    List<Import> getImports();

    /**
     * Returns the list of deployable composites in the contribution.
     *
     * @return The list of deployable composites
     */
    List<Composite> getDeployables();

    /**
     * Returns the list of artifacts in the contribution.
     *
     * @return The list of artifacts in the contribution
     */
    List<Artifact> getArtifacts();

    /**
     * Returns the model resolver for the models representing the artifacts
     * visible in the scope of this contribution.
     *
     * @return The model resolver
     */
    ModelResolver getModelResolver();

    /**
     * Sets the model resolver for the models representing the artifacts
     * visible in the scope of this contribution.
     *
     * @param modelResolver The model resolver
     */
    void setModelResolver(ModelResolver modelResolver);

    /**
     * Returns the list of contributions that this contribution depends on.
     *
     * @return
     */
    List<Contribution> getDependencies();

    /**
     * Returns the ClassLoader used to load classes and resources from
     * this contribution
     *
     * FIXME Remove this, the base contribution model should not depend
     * on Java ClassLoaders.
     *
     * @return The contribution ClassLoader
     */
    ClassLoader getClassLoader();

    /**
     * Sets the ClassLoader used to load classes and resources from
     * this contribution
     *
     * FIXME Remove this, the base contribution model should not depend
     * on Java ClassLoaders.
     *
     * @param classLoader the contribution class loader
     */
    void setClassLoader(ClassLoader classLoader);

    /**
     * Get a list of mime types that apply to this contribution archive
     * @return
     */
    Set<String> getTypes();
    
    /**
     * Get an artifacts model object
     * @param uri The artifact uri
     * @return the model
     */
    <T> T getArtifactModel(String uri);

    void mergeMetaData(ContributionMetadata metaData);

    void addComposite(Composite composite);
}