summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/ConfigurationContext.java
blob: a57ed03ffd30fb4dac2fe2fa8e0569a5b59e4683 (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
/**
 * 
 * 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;

import org.apache.tuscany.core.builder.BuilderConfigException;
import org.apache.tuscany.core.config.ConfigurationException;
import org.apache.tuscany.core.invocation.spi.ProxyFactory;
import org.apache.tuscany.model.assembly.Extensible;

/**
 * Offers configuration services in the runtime. A ConfigurationContext is able to configure a model and then build the
 * runtime representation corresponding to that model in the live system. <p/> Configuration contexts will typically be
 * hierarchical, delegating to their parent <b>after</b> performing an operation. The parent ConfigurationContext will
 * typically be injected into an implementation of this interface during registration.
 * 
 * @version $Rev$ $Date$
 */
public interface ConfigurationContext {

    /**
     * Adds additional configuration information to a model object.
     * 
     * @param model the model object to be configured
     * @throws ConfigurationException
     */
    public void configure(Extensible model) throws ConfigurationException;

    /**
     * Decorates the supplied model object with a {@link org.apache.tuscany.core.builder.RuntimeConfiguration} that can
     * be used to create the runtime context corresponding to the model.
     * 
     * @param parent an AggregrateContext that will ultimately become the parent of the runtime context
     * @param model the model object that defines the configuration to be built
     * @throws BuilderConfigException
     * @see org.apache.tuscany.core.builder.RuntimeConfiguration
     */
    public void build(AggregateContext parent, Extensible model) throws BuilderConfigException;

    /**
     * Constructs a wire from a source proxy factory to a corresponding target, potentially performing optimizations
     * 
     * @param sourceFactory the proxy factory that will be used to create the injected proxy for a reference
     * @param targetFactory the proxy factory that contains the invocation chains for the target side of the wire
     * @param targetType the {@link org.apache.tuscany.core.builder.RuntimeConfiguration} implementation type for the
     *        wire target
     * @param downScope whether the source is a shorter lived scope than the target. Used in optimization.
     * @param targetScopeContext the scope context of the target service
     * @throws BuilderConfigException
     */
    public void wire(ProxyFactory sourceFactory, ProxyFactory targetFactory, Class targetType, boolean downScope,
            ScopeContext targetScopeContext) throws BuilderConfigException;

    public void wire(ProxyFactory targetFactory, Class targetType, ScopeContext targetScopeContext) throws BuilderConfigException;

}