summaryrefslogtreecommitdiffstats
path: root/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/scope/ModuleScopeContext.java
blob: 00f2747fae0b9244446c01d82474a9663876cb26 (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/**
 *
 *  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.scope;

import java.util.Map;
import java.util.Queue;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentLinkedQueue;

import org.apache.tuscany.core.builder.RuntimeConfiguration;
import org.apache.tuscany.core.context.Context;
import org.apache.tuscany.core.context.CoreRuntimeException;
import org.apache.tuscany.core.context.EventContext;
import org.apache.tuscany.core.context.InstanceContext;
import org.apache.tuscany.core.context.LifecycleEventListener;
import org.apache.tuscany.core.context.RuntimeEventListener;
import org.apache.tuscany.core.context.SimpleComponentContext;

/**
 * Manages component contexts whose implementations are module scoped
 * 
 * @version $Rev$ $Date$
 */
public class ModuleScopeContext extends AbstractScopeContext implements RuntimeEventListener, LifecycleEventListener {

    // ----------------------------------
    // Fields
    // ----------------------------------

    // Component contexts in this scope keyed by name
    private Map<String, InstanceContext> componentContexts;

    private Queue<SimpleComponentContext> destroyableContexts;

    // ----------------------------------
    // Constructor
    // ----------------------------------

    public ModuleScopeContext(EventContext eventContext) {
        super(eventContext);
        setName("Module Scope");
    }

    // ----------------------------------
    // Listener methods
    // ----------------------------------

    public void onEvent(int type, Object key) {
        if (type == EventContext.MODULE_START) {
            lifecycleState = RUNNING;
            initComponentContexts();
        } else if (type == EventContext.MODULE_STOP) {
            notifyInstanceShutdown(key);
        }
    }

    // ----------------------------------
    // Lifecycle methods
    // ----------------------------------

    public synchronized void start() {
        if (lifecycleState != UNINITIALIZED) {
            throw new IllegalStateException("Scope must be in UNINITIALIZED state [" + lifecycleState + "]");
        }
    }

    public synchronized void stop() {
        if (lifecycleState != RUNNING) {
            throw new IllegalStateException("Scope in wrong state [" + lifecycleState + "]");
        }
        super.stop();
        componentContexts = null;
        destroyableContexts = null;
        lifecycleState = STOPPED;
    }

    // ----------------------------------
    // Methods
    // ----------------------------------

    public boolean isCacheable() {
        return true;
    }

    public void registerConfiguration(RuntimeConfiguration<InstanceContext> configuration) {
        runtimeConfigurations.put(configuration.getName(), configuration);
        if (lifecycleState == RUNNING) {
            componentContexts.put(configuration.getName(), configuration.createInstanceContext());
        }
    }

    public InstanceContext getContext(String ctxName) {
        checkInit();
        return componentContexts.get(ctxName);
    }

    public InstanceContext getContextByKey(String ctxName, Object key) {
        checkInit();
        return componentContexts.get(ctxName);
    }

    public void removeContext(String ctxName) {
        checkInit();
        Object component = componentContexts.remove(ctxName);
        if (component != null) {
            destroyableContexts.remove(component);
        }
    }

    public void removeContextByKey(String ctxName, Object key) {
        checkInit();
        removeContext(ctxName);
    }

    public void onInstanceCreate(Context context) {
        checkInit();
        if (context instanceof SimpleComponentContext) {
            SimpleComponentContext serviceContext = (SimpleComponentContext) context;
            // Queue the context to have its implementation instance released if destroyable
            if (serviceContext.isDestroyable()) {
                destroyableContexts.add(serviceContext);
            }
        }
    }

    /**
     * Returns an array of {@link SimpleComponentContext}s representing components that need to be notified of scope shutdown.
     */
    protected InstanceContext[] getShutdownContexts(Object key) {
        if (destroyableContexts != null) {
            // create 0-length array since Queue.size() has O(n) traversal
            return (InstanceContext[]) destroyableContexts.toArray(new InstanceContext[0]);
        } else {
            return null;
        }
    }

    // ----------------------------------
    // Private methods
    // ----------------------------------

    private synchronized void initComponentContexts() throws CoreRuntimeException {
        if (componentContexts == null) {
            componentContexts = new ConcurrentHashMap();
            destroyableContexts = new ConcurrentLinkedQueue();
            for (RuntimeConfiguration<InstanceContext> config : runtimeConfigurations.values()) {
                InstanceContext context = config.createInstanceContext();
                context.addContextListener(this);
                context.start();
                componentContexts.put(context.getName(), context);
            }
            // Initialize eager contexts. Note this cannot be done when we initially create each context since a component may
            // contain a forward reference to a component which has not been instantiated
            for (InstanceContext context : componentContexts.values()) {
                if (context instanceof SimpleComponentContext) {
                    SimpleComponentContext simpleCtx = (SimpleComponentContext) context;
                    if (simpleCtx.isEagerInit()) {
                        // perform silent creation and manual shutdown registration
                        simpleCtx.getInstance(null, false);
                        if (simpleCtx.isDestroyable()) {
                            destroyableContexts.add(simpleCtx);
                        }
                    }
                }
            }
        }
    }
}