Skip navigation links

oracle.soa.management.facade
Interface Composite

public interface Composite

SCA composite facade, useful to find services, the state/mode and other information

  Composite composite = locator.lookupComposite(compositeDN);
  System.out.println("Composite = " + composite);
  System.out.println("Mode: " + composite.getMode() + " state: " + composite.getState()); 
 

See Also:

Locator

Method Summary

void	activate() Activates the composite
void	attachProperty(Property property) Attach the specified property to the composite.
java.util.List<Component>	getComponents()
CompositeDN	getCompositeDN()
java.lang.String	getDeploymentErrorDetail()
java.lang.String	getDeploymentErrorMessage() Returns the error message if the composite failed to be loaded
java.lang.String	getDeploymentTime()
java.lang.String	getDN()
java.lang.String	getDocumentAsString(java.lang.String uri)
java.lang.String	getDocumentAsString(java.lang.String sourceDocURI, java.lang.String relativeURI)
int	getFaultCount()
java.util.List<Fault>	getFaults(FaultFilter filter)
java.util.List<ImportInfo>	getImports()
int	getInstanceCount()
java.util.List<CompositeInstance>	getInstances(CompositeInstanceFilter filter)
java.lang.String	getLocation()
java.lang.String	getMode()
java.lang.String	getPartition()
java.util.List<Property>	getProperties()
Reference	getReference(java.lang.String referenceName)
java.util.List<Reference>	getReferences()
java.util.List<Sensor>	getSensors()
Service	getService(java.lang.String serviceName)
java.util.List<Service>	getServices()
java.lang.String	getState()
java.util.List<WireInfo>	getWires()
boolean	isDefaultRevision() Determine whether the composite revision is the default revision
boolean	isShutdown() Determines whether the composite is shutdown
void	purgeInstances() Deletes the instances of the composite in the database All the child component/reference/service instances will be deleted too.
void	purgeInstances(CompositeInstanceFilter fitler) Deletes the instances of the composite in the database based on the specified filter criteria All the child component/reference/service instances will be deleted too.
void	removeProperty(Property property) Remove the specified property from the composite.
void	retire() Retires the composite
void	setAsDefaultRevision() Mark the composite as the default revision
void	start() Starts the composite
void	stop() Stops the composite

Method Detail

getPartition

java.lang.String getPartition()

Returns:

the name of the partition to which the composite belongs

getState

java.lang.String getState()

Returns:

the state of the composite

See Also:

State}

getWires

java.util.List<WireInfo> getWires()

Returns:

a list of descriptions of the wires defined for the composite

getImports

java.util.List<ImportInfo> getImports()

Returns:

a list of descriptions of the composite's imports

getDN

java.lang.String getDN()

Returns:

the distinguished name of the composite

getCompositeDN

CompositeDN getCompositeDN()

Returns:

the distinguished name of the composite

getServices

java.util.List<Service> getServices()
                                    throws java.lang.Exception

Returns:

the list of SCA services exposed by the composite

Throws:

java.lang.Exception

getReferences

java.util.List<Reference> getReferences()
                                        throws java.lang.Exception

Returns:

the list of SCA references accessed by the composite

Throws:

java.lang.Exception

getComponents

java.util.List<Component> getComponents()
                                        throws java.lang.Exception

Returns:

the list child components belonging to the composite

Throws:

java.lang.Exception

getInstances

java.util.List<CompositeInstance> getInstances(CompositeInstanceFilter filter)
                                               throws java.lang.Exception

Parameters:

filter - The criteria used to determine which composite instances to return

Returns:

the list of instances of the composite, which match the criteria specified by the filter

Throws:

java.lang.Exception

getFaults

java.util.List<Fault> getFaults(FaultFilter filter)
                                throws java.lang.Exception

Parameters:

filter - The criteria used to determine which faults to return

Returns:

a list of faults that have occurred for all the instances of the composite, filtered by the specified criteria

Throws:

java.lang.Exception

getInstanceCount

int getInstanceCount()

Returns:

the number of instances of the composite

getFaultCount

int getFaultCount()

Returns:

the number of faults that have occurred for all the instances of the composite

activate

void activate()

Activates the composite

retire

void retire()

Retires the composite

start

void start()

Starts the composite

stop

void stop()

Stops the composite

getDocumentAsString

java.lang.String getDocumentAsString(java.lang.String uri)
                                     throws java.lang.Exception

Parameters:

uri - The URI of the desired document

Returns:

the serialized content of the document

Throws:

java.lang.Exception

getDocumentAsString

java.lang.String getDocumentAsString(java.lang.String sourceDocURI,
                                     java.lang.String relativeURI)
                                     throws java.lang.Exception

Parameters:

sourceDocURI -

relativeURI -

Returns:

the serialized content of the document

Throws:

java.lang.Exception

purgeInstances

void purgeInstances()
                    throws java.lang.Exception

Deletes the instances of the composite in the database All the child component/reference/service instances will be deleted too.

Throws:

java.lang.Exception

purgeInstances

void purgeInstances(CompositeInstanceFilter fitler)
                    throws java.lang.Exception

Deletes the instances of the composite in the database based on the specified filter criteria All the child component/reference/service instances will be deleted too.

Throws:

java.lang.Exception

getService

Service getService(java.lang.String serviceName)

Parameters:

serviceName - The name of a SCA service

Returns:

the SCA service facade

getReference

Reference getReference(java.lang.String referenceName)

Parameters:

referenceName - The name of a SCA reference

Returns:

the SCA reference facade

getDeploymentErrorMessage

java.lang.String getDeploymentErrorMessage()

Returns the error message if the composite failed to be loaded

Returns:

the error message, or null if no error occurred

getDeploymentErrorDetail

java.lang.String getDeploymentErrorDetail()

Returns:

error details (for example the exception stack trace) of the deployment failure, if one occurred

getSensors

java.util.List<Sensor> getSensors()
                                  throws java.lang.Exception

Returns:

the sensors defined for the composite

Throws:

java.lang.Exception

getMode

java.lang.String getMode()

Returns:

the composite mode

See Also:

Mode}

isShutdown

boolean isShutdown()

Determines whether the composite is shutdown

Returns:

true, if the composite is shutdown; Otherwise, false

getProperties

java.util.List<Property> getProperties()

attachProperty

void attachProperty(Property property)

Attach the specified property to the composite.

Parameters:

property - The property

removeProperty

void removeProperty(Property property)

Remove the specified property from the composite.

Parameters:

property - The property to remove

getLocation

java.lang.String getLocation()

Returns:

the composite deployment location

isDefaultRevision

boolean isDefaultRevision()

Determine whether the composite revision is the default revision

Returns:

true if the composite represents the default revision; Otherwise, false

setAsDefaultRevision

void setAsDefaultRevision()

Mark the composite as the default revision

getDeploymentTime

java.lang.String getDeploymentTime()

Returns:

the most-recent deployment time of the composite

Skip navigation links