blob: 30482fae9048deaccb4376f96447fa174a388ada (
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
|
/*
* 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.scope;
import org.apache.tuscany.sca.event.RuntimeEventListener;
import org.apache.tuscany.sca.runtime.RuntimeComponent;
/**
* Manages the lifecycle and visibility of instances associated with a an {@link RuntimeComponent}.
*
* @version $Rev$ $Date$
* @param <KEY> the type of IDs that this container uses to identify its contexts.
* For example, for COMPOSITE scope this could be the URI of the composite component,
* or for HTTP Session scope it might be the HTTP session ID.
*/
public interface ScopeContainer<KEY> extends Lifecycle, RuntimeEventListener {
/**
* Returns the Scope that this container supports.
*
* @return the Scope that this container supports
*/
Scope getScope();
/**
* Start a new context with the supplied ID.
*
* @param contextId an ID that uniquely identifies the context.
*/
void startContext(KEY contextId);
/**
* Stop the context with the supplied ID.
*
* @param contextId an ID that uniquely identifies the context.
*/
void stopContext(KEY contextId);
/**
* Returns an instance wrapper associated with the current scope context, creating one if necessary
* @param contextId the id for the scope context
*
* @return the wrapper for the target instance
* @throws TargetResolutionException if there was a problem instantiating the target instance
*/
InstanceWrapper getWrapper(KEY contextId) throws TargetResolutionException;
/**
* Returns an implementation instance associated with the current scope context.
* If no instance is found, a {@link TargetNotFoundException} is thrown.
* @param contextId the id for the scope context
*
* @return the wrapper for the target instance
* @throws TargetResolutionException if there was a problem instantiating the target instance
*/
InstanceWrapper getAssociatedWrapper(KEY contextId)
throws TargetResolutionException;
/**
* Return a wrapper after use (for example, after invoking the instance).
* @param wrapper the wrapper for the target instance being returned
* @param contextId the id for the scope context
*
* @throws TargetDestructionException if there was a problem returning the target instance
*/
void returnWrapper(InstanceWrapper wrapper, KEY contextId)
throws TargetDestructionException;
/**
* Removes a component implementation instance associated with the current context from persistent storage
*
* @param component the owning component
* @throws PersistenceException if there was a problem removing the instance
*/
void remove() throws PersistenceException;
}
|
