Skip navigation links

oracle.soa.management.facade
Interface Component

public interface Component

SCA component facade

Method Summary

void	attachProperty(Property property) Attaches the specified property to the component
CompositeDN	getCompositeDN()
java.lang.String	getDefinition()
java.util.Date	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)
java.util.List<Fault>	getFaults(FaultFilter filter)
java.lang.String	getImplementationType()
java.util.List<ComponentInstance>	getInstances(ComponentInstanceFilter filter)
java.lang.String	getName()
int	getNumberOfActiveInstances()
int	getNumberOfFaultedInstances()
int	getNumberOfInstances()
int	getNumberOfInstances(ComponentInstanceFilter filter)
int	getNumberOfRecoverableInstances()
java.util.Map<java.lang.String,java.lang.String>	getPolicyOverride(java.lang.String policyReferenceURI)
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.util.Map<java.lang.String,java.lang.Object>	getReferences() Gets components or external services that are referenced by this component
void	removeProperty(Property property) Removes the specified property from the component
void	setNumberOfActiveInstances(int numberOfActiveInstances) Sets the number of active/running instances of the component
void	setNumberOfFaultedInstances(int numberOfFaultedInstances) Sets the number of faulted instances of the component
void	setNumberOfInstances(int numberOfTotalInstances) Sets the total number of instances of the component
void	setNumberOfRecoverableInstances(int numberOfRecoverableInstances) Sets the number of open-faulted recoverable instances of the component
void	setPolicyOverride(java.lang.String policyReferenceURI, java.util.Map<java.lang.String,java.lang.String> overrides) Sets overrides for the specified policy attached to the component

Method Detail

getName

java.lang.String getName()

Returns:

the component name.

getImplementationType

java.lang.String getImplementationType()

Returns:

the component implementation type.

getCompositeDN

CompositeDN getCompositeDN()

Returns:

the distinguished name of the composite to which the component belongs.

getDN

java.lang.String getDN()

Returns:

the unique distinguished name for this component, in the form of partition/composite!revision/component

getDeploymentTime

java.util.Date getDeploymentTime()

Returns:

the deployment time of the component

getInstances

java.util.List<ComponentInstance> getInstances(ComponentInstanceFilter filter)
                                               throws java.lang.Exception

Parameters:

filter - The criteria to use for selecting which component instances to return

Returns:

a list of instances of this component that matches the conditions specified by the given filter

Throws:

java.lang.Exception

getNumberOfInstances

int getNumberOfInstances(ComponentInstanceFilter filter)
                         throws java.lang.Exception

Parameters:

filter - The criteria to use for selecting which component instances to count

Returns:

the number of instances of this component that matches the conditions specified by the given filter

Throws:

java.lang.Exception

getNumberOfInstances

int getNumberOfInstances()
                         throws java.lang.Exception

Returns:

the total number of instances of this component

Throws:

java.lang.Exception

setNumberOfInstances

void setNumberOfInstances(int numberOfTotalInstances)

Sets the total number of instances of the component

Parameters:

numberOfTotalInstances - The number

getNumberOfActiveInstances

int getNumberOfActiveInstances()
                               throws java.lang.Exception

Returns:

the number of active instances of the component

Throws:

java.lang.Exception

setNumberOfActiveInstances

void setNumberOfActiveInstances(int numberOfActiveInstances)

Sets the number of active/running instances of the component

Parameters:

numberOfActiveInstances - The number

getNumberOfRecoverableInstances

int getNumberOfRecoverableInstances()
                                    throws java.lang.Exception

Returns:

the number of open-faulted recoverable instances of the component

Throws:

java.lang.Exception

setNumberOfRecoverableInstances

void setNumberOfRecoverableInstances(int numberOfRecoverableInstances)

Sets the number of open-faulted recoverable instances of the component

Parameters:

numberOfRecoverableInstances - The number

getNumberOfFaultedInstances

int getNumberOfFaultedInstances()
                                throws java.lang.Exception

Returns:

the number of faulted instances of the component

Throws:

java.lang.Exception

setNumberOfFaultedInstances

void setNumberOfFaultedInstances(int numberOfFaultedInstances)

Sets the number of faulted instances of the component

Parameters:

numberOfFaultedInstances - The number

getFaults

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

Parameters:

filter - The criteria to use for selecting which component faults to return

Returns:

the list of faults that matches the conditions specified by the given filter.

Throws:

java.lang.Exception

getDefinition

java.lang.String getDefinition()
                               throws java.lang.Exception

Returns:

the source of the component; In BPEL, this will return the BPEL source

Throws:

java.lang.Exception

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns:

the properties for the component. The properties are defined in the sca composite.xml file and xyz.componentType file

getDocumentAsString

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

Parameters:

uri - The document URI

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

getReferences

java.util.Map<java.lang.String,java.lang.Object> getReferences()
                                                               throws java.lang.Exception

Gets components or external services that are referenced by this component

Returns:

A list of components and/or references to which the component refers

Throws:

java.lang.Exception

attachProperty

void attachProperty(Property property)

Attaches the specified property to the component

Parameters:

property - The property

removeProperty

void removeProperty(Property property)

Removes the specified property from the component

Parameters:

property - The property to remove

setPolicyOverride

void setPolicyOverride(java.lang.String policyReferenceURI,
                       java.util.Map<java.lang.String,java.lang.String> overrides)

Sets overrides for the specified policy attached to the component

Parameters:

policyReferenceURI - The reference URI of the policy to override

overrides - The override details

getPolicyOverride

java.util.Map<java.lang.String,java.lang.String> getPolicyOverride(java.lang.String policyReferenceURI)

Parameters:

policyReferenceURI - The reference URI of the policy whose overrides should be returned

Returns:

The overrides for the specified policy attached to the component

Skip navigation links