summaryrefslogtreecommitdiffstats
path: root/branches/pre-spec-changes/kernel/spi/src/main/java/org/apache/tuscany/spi/component/SCAObject.java
blob: 668eb1f90a7071940592345b336dd697559340c3 (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
/*
 * 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.spi.component;

import java.util.Map;

import org.apache.tuscany.spi.Lifecycle;
import org.apache.tuscany.spi.event.EventPublisher;
import org.apache.tuscany.spi.model.Scope;

/**
 * Represents the base SCA artifact type in an assembly
 *
 * @version $Rev$ $Date$
 */
public interface SCAObject extends EventPublisher, Lifecycle {

    /**
     * Returns the artifact name
     */
    String getName();

    /**
     * Returns the canonical artifact name
     */
    String getCanonicalName();

    /**
     * Returns the parent composite, or null if the artifact does not have one
     */
    CompositeComponent getParent();

    /**
     * Returns the artifact scope
     */
    Scope getScope();

    /**
     * Returns true if the artifact is a system artifact
     *
     * @return true if the artifact is a system artifact
     */
    boolean isSystem();

    /**
     * The extensions map contains other runtime context such as type systems for various databindings
     *
     * @return A live map of extended context
     */
    Map<Object, Object> getExtensions();

    /**
     * Called to signal that the composite should perform any initizalization
     */
    void prepare() throws PrepareException;

}