diff options
Diffstat (limited to 'sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java')
-rw-r--r-- | sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java b/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java new file mode 100644 index 0000000000..473762b6b0 --- /dev/null +++ b/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java @@ -0,0 +1,75 @@ +/** + * + * 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; + +/** + * Manages instances of a runtime artifact. An <code>InstanceContext</code> may contain child contexts which + * themselves manage implementation instances or it may be a leaf context. + * + * @see org.apache.tuscany.core.context.SimpleComponentContext + * @see org.apache.tuscany.core.context.AggregateContext + * @see org.apache.tuscany.core.context.EntryPointContext + * @see org.apache.tuscany.core.context.ExternalServiceContext + * + * @version $Rev$ $Date$ + */ +public interface InstanceContext extends Context { + + /** + * Returns the instance associated with the requested name, which may be in a simple or compound form. Simple (i.e. + * leaf) contexts will return an instance associated with the service name part of the compound name, which may be + * null. + * <p> + * Aggregate contexts will return an instance (likely a proxy) of a contained entry point context. In this case, the + * port name on the qualified name will correspond to the aggregate context name and the part name will be used to + * retrieve the contained entry point context. The latter may be null. If the contained context is not an entry + * point context, an exception will be thrown. + * + * @param qName a qualified name of the requested instance + * @return the implementation instance or a proxy to it + * @throws TargetException if an error occurs retrieving the instance or the requested component is not an entry + * point. + * + * @see AggregateContext + * @see org.apache.tuscany.model.assembly.EntryPoint + */ + public Object getInstance(QualifiedName qName) throws TargetException; + + /** + * Returns an instance associated with the requested name without notifying <code>ContextEventListener</code>s + * that may be registered with this context on instance creation. Note that {@link #getInstance(QualifiedName)} + * should generally be called and this method is only provided as an optimization for particular circumstances. + * + * @param qName a qualified name of the requested instance + * @param notify whether to notify <code>ContextEventListener</code>s + * @return the instance or a proxy to it + * @throws TargetException if an error occurs retrieving the instance or proxy + * @see LifecycleEventListener + */ + public Object getInstance(QualifiedName qName, boolean notify) throws TargetException; + + /** + * Returns the implementation instance associated witht he component. An implementation instance does not + * have a proxy invocation chainXXX + * @return + * @throws TargetException + */ + public Object getImplementationInstance() throws TargetException; + + public Object getImplementationInstance(boolean notify) throws TargetException; + +} |