Apache Tuscany SCA Kernel Sub-Project

org.apache.tuscany.spi.component
Interface SCAObject

All Superinterfaces:
EventPublisher, Lifecycle
All Known Subinterfaces:
AtomicComponent, Component, CompositeComponent, Reference, RuntimeComponent, Service, SystemAtomicComponent
All Known Implementing Classes:
AbstractSCAObject, AtomicComponentExtension, CompositeComponentExtension, ReferenceExtension, ServiceExtension, SystemAtomicComponentExtension

public interface SCAObject
extends EventPublisher, Lifecycle

Represents the base SCA artifact type in an assembly

Version:
$Rev: 451895 $ $Date: 2006-10-01 23:58:18 -0700 (Sun, 01 Oct 2006) $

Field Summary
 
Fields inherited from interface org.apache.tuscany.spi.Lifecycle
CONFIG_ERROR, ERROR, INITIALIZED, INITIALIZING, RUNNING, STOPPED, STOPPING, UNINITIALIZED
 
Method Summary
 Map<Object,Object> getExtensions()
          The extensions map contains other runtime context such as type systems for various databindings
 String getName()
          Returns the artifact name
 CompositeComponent getParent()
          Returns the parent composite, or null if the artifact does not have one
 Scope getScope()
          Returns the artifact scope
 Object getServiceInstance()
          Returns an instance associated with the default service
 boolean isSystem()
          Returns true if the artifact is a system artifact
 void prepare()
          Called to signal that the composite should perform and required steps prior to registration with its parent such as wiring of its children
 
Methods inherited from interface org.apache.tuscany.spi.event.EventPublisher
addListener, addListener, publish, removeListener
 
Methods inherited from interface org.apache.tuscany.spi.Lifecycle
getLifecycleState, start, stop
 

Method Detail

getName

String getName()
Returns the artifact name


getParent

CompositeComponent getParent()
Returns the parent composite, or null if the artifact does not have one


getScope

Scope getScope()
Returns the artifact scope


getServiceInstance

Object getServiceInstance()
                          throws TargetException
Returns an instance associated with the default service

Throws:
TargetException - if an error occurs retrieving the instance

prepare

void prepare()
Called to signal that the composite should perform and required steps prior to registration with its parent such as wiring of its children


getExtensions

Map<Object,Object> getExtensions()
The extensions map contains other runtime context such as type systems for various databindings

Returns:
A live map of extended context

isSystem

boolean isSystem()
Returns true if the artifact is a system artifact

Returns:
true if the artifact is a system artifact

Apache Tuscany SCA Kernel Sub-Project

-