summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/Context.java
blob: 2eb70e8711290b62df6a138b373637b35e666437 (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
/**
 * 
 * Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 * 
 * 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.core.context;

/**
 * An entity that provides an execution context for a runtime artifact 
 * 
 * @version $Rev$ $Date$
 */
public interface Context {

    /* A configuration error state */
    public static final int CONFIG_ERROR = -1;

    /* Has not been initialized */
    public static final int UNINITIALIZED = 0;

    /* In the process of being configured and initialized */
    public static final int INITIALIZING = 1;

    /* Instantiated and configured */
    public static final int INITIALIZED = 2;

    /* Configured and initialized */
    public static final int RUNNING = 4;

    /* In the process of being shutdown */
    public static final int STOPPING = 5;

    /* Has been shutdown and removed from the module */
    public static final int STOPPED = 6;

    /* In an error state */
    public static final int ERROR = 7;

    /**
     * Returns the name of the context
     */
    public String getName();

    /**
     * Sets the name of the context
     */
    public void setName(String name);

    /**
     * Returns the lifecycle state
     * 
     * @see #UNINITIALIZED
     * @see #INITIALIZING
     * @see #INITIALIZED
     * @see #RUNNING
     * @see #STOPPING
     * @see #STOPPED
     */
    public int getLifecycleState();

    /**
     * Sets the lifecycle state
     * 
     * @see #UNINITIALIZED
     * @see #INITIALIZING
     * @see #INITIALIZED
     * @see #RUNNING
     * @see #STOPPING
     * @see #STOPPED
     */
    public void setLifecycleState(int state);

    /**
     * Starts the container
     * 
     * @throws CoreRuntimeException
     */
    public void start() throws CoreRuntimeException;

    /**
     * Stops the container
     * 
     * @throws CoreRuntimeException
     */
    public void stop() throws CoreRuntimeException;

    /**
     * Registers a listener for context events
     */
    public void addContextListener(LifecycleEventListener listener);

    /**
     * Deregisters a context event listener
     */
    public void removeContextListener(LifecycleEventListener listener);

}