summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/scope/AbstractScopeContext.java
blob: 449af4bdf86e5ace63b59a3ace98b77d6c6238f2 (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
/**
 *
 *  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.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import org.apache.tuscany.core.builder.RuntimeConfiguration;
import org.apache.tuscany.core.context.AbstractContext;
import org.apache.tuscany.core.context.InstanceContext;
import org.apache.tuscany.core.context.QualifiedName;
import org.apache.tuscany.core.context.EventContext;
import org.apache.tuscany.core.context.Context;
import org.apache.tuscany.core.context.ScopeContext;
import org.apache.tuscany.core.context.TargetException;

/**
 * Implements functionality common to scope contexts.
 * <p>
 * <b>NB: </b>Minimal synchronization is performed, particularly for initializing and destroying scopes, and it is
 * assumed the scope container will block requests until these operations have completed.
 * 
 * @version $Rev$ $Date$
 */
public abstract class AbstractScopeContext  extends AbstractContext implements ScopeContext{
    // ----------------------------------
    // Fields
    // ----------------------------------

    // The collection of runtime configurations for the scope
    protected Map<String, RuntimeConfiguration<InstanceContext>> runtimeConfigurations = new ConcurrentHashMap();

    // The event context the scope container is associated with
    protected EventContext eventContext;

    // ----------------------------------
    // Constructors
    // ----------------------------------

    public AbstractScopeContext(EventContext eventContext) {
        assert (eventContext != null) : "Event context was null";
        this.eventContext = eventContext;
    }

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

    public synchronized void start() {
    }

    public synchronized void stop() {
    }


    // ----------------------------------
    // Scope methods
    // ----------------------------------

    public void registerConfigurations(List<RuntimeConfiguration<InstanceContext>> configurations) {
        for (RuntimeConfiguration<InstanceContext> configuration : configurations) {
            runtimeConfigurations.put(configuration.getName(), configuration);
        }
    }

    public Object getInstance(QualifiedName qName) throws TargetException {
        Object instance = null;
        InstanceContext context = getContext(qName.getPartName());
        if (context == null) {
            TargetException e = new TargetException("Target not found");
            e.setIdentifier(qName.getQualifiedName());
            throw e;
        }
        return context.getInstance(qName);
    }

    public Object getInstance(QualifiedName qName, boolean notify) throws TargetException {
        return getInstance(qName);
    }
    
    //----------------------------------
    // InstanceContext methods
    //----------------------------------

    public Object getImplementationInstance() throws TargetException{
        return this;
    }

    public Object getImplementationInstance(boolean notify) throws TargetException{
        return this;
    }
    
    // ----------------------------------
    // Protected methods
    // ----------------------------------

    protected EventContext getEventContext() {
        return eventContext;
    }

    /**
     * Notfies instances that are associated with a context and configured to receive callbacks that the context is
     * being destroyed in reverse order
     * 
     * @param key the context key
     */
    protected void notifyInstanceShutdown(Object key) {
        InstanceContext[] contexts = getShutdownContexts(key);
        if ((contexts == null) || (contexts.length < 1)) {
            return;
        }
        // shutdown destroyable instances in reverse instantiation order
        for (int i = contexts.length - 1; i >= 0; i--) {
            InstanceContext context = contexts[i];

            if (context.getLifecycleState() == Context.RUNNING) {
                synchronized (context) {
                    context.setLifecycleState(Context.STOPPING);
                    removeContextByKey(context.getName(), key);
                    try {
                        context.stop();
                    } catch (TargetException e) {
                        // TODO send a monitoring event
                        // log.error("Error releasing instance [" + context.getName() + "]",e);
                    }
                }
            }
        }
    }

    protected void checkInit() {
        if (lifecycleState != RUNNING) {
            throw new IllegalStateException("Scope not running [" + lifecycleState + "]");
        }
    }

    /**
     * Returns an array of contexts that need to be notified of scope shutdown. The array must be in the order in which
     * component contexts were created
     */
    protected abstract InstanceContext[] getShutdownContexts(Object key);

}