Skip navigation links

Oracle Fusion Middleware Infrastructure Management Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1.5.0)
E10659-04


oracle.soa.management.facade
Interface Locator


public interface Locator

Field Summary
static java.lang.String BC_B2B_REFERENCE
          The type that identifies the B2B reference binding component.
static java.lang.String BC_B2B_SERVICE
          The type that identifies the B2B service binding component.
static java.lang.String BC_DIRECT_REFERENCE
          The type that identifies the SDO reference binding component.
static java.lang.String BC_DIRECT_SERVICE
          The type that identifies the SDO service binding component.
static java.lang.String BC_JCA_REFERENCE
          The type that identifies the JCA reference binding component.
static java.lang.String BC_JCA_SERVICE
          The type that identifies the JCA service binding component.
static java.lang.String BC_SDO_REFERENCE
          The type that identifies the SDO reference binding component.
static java.lang.String BC_SDO_SERVICE
          The type that identifies the SDO service binding component.
static java.lang.String BC_SOAP_REFERENCE
          The type that identifies the SOAP reference binding component.
static java.lang.String BC_SOAP_SERVICE
          The type that identifies the SOAP service binding component.
static java.lang.String COMPONENT
          The type that identifies the component.
static java.lang.String COMPOSITE
          The type that identifies the composite.
static java.lang.String EVENT
          The type that identifies the business event.
static java.lang.String INVALID_COMPONENT
          The type that identifies an invalid component
static java.lang.String OPERATION
          The type that identifies the service operation.
static java.lang.String REFERENCE
          The type that identifies the outbound binding component.
static java.lang.String SE_BPEL
          The type that identifies the BPEL service engine.
static java.lang.String SE_BPMN
          The type that identifies the BPMN service engine.
static java.lang.String SE_DECISION
          The type that identifies the business rules service engine.
static java.lang.String SE_EVENT_AGENT
          The type that identifies the event agent service engine
static java.lang.String SE_HUMAN_WORKFLOW
          The type that identifies the human workflow service engine.
static java.lang.String SE_INVALID
          The type that identifies invalid service engine
static java.lang.String SE_MEDIATOR
          The type that identifies the mediator service engine.
static java.lang.String SE_OEP
          The type that identifies the Oracle event processing service engine.
static java.lang.String SE_SPRING
          The type that identifies the spring service engine.
static java.lang.String SERVICE
          The type that identifies the inbound binding component.

 

Method Summary
 void close()
          Clean up resources used by the locator.
 DirectConnection createDirectConnection(CompositeDN compositeDN, java.lang.String serviceName)
          Creates a direct binding connection to the specified composite service
 java.lang.Object executeBindingComponentMethod(java.lang.String bindingComponentType, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeComponentInstanceMethod(java.lang.String instanceId, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeComponentMethod(CompositeDN compositeDN, java.lang.String componentName, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeCompositeMethod(CompositeDN compositeDN, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeEDNMethod(java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeServiceEngineMethod(java.lang.String engineType, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 java.lang.Object executeServiceMethod(CompositeDN compositeDN, java.lang.String serviceName, java.lang.String methodName, java.lang.Object[] params)
          Deprecated. This methods will no longer be supported
 oracle.soa.management.facade.tst.TestRunResults executeTestCases(java.lang.String compositeDN, TestRunOptions options, java.util.List<oracle.soa.management.facade.tst.TestCase> testcases)
          Instruct the back-end to execute the test cases with the specified running options
 java.lang.Object getAuditTrail(java.lang.String ecid)
          Returns the audit trail of a set of component/composite instances who shared the same ECID.
 BindingComponent getBindingComponent(java.lang.String bcType)
          Returns the binding component facade of the given type.
 java.util.Collection<BindingComponent> getBindingComponents()
          Returns a collection of binding components currently supported by the SCA infrastructure.
 java.util.List<ComponentInstance> getComponentInstances(ComponentInstanceFilter filter)
          Returns a list of component instance facades that match the conditions specified by the given filter.
 java.util.List<Component> getComponents(ComponentFilter filter)
          Returns a list of components that match the conditions specified by the filter.
 java.util.List<Component> getComponentSnapShot(ComponentFilter filter)
          Returns a snapshot of the following data of this component 1.
 java.util.List<CompositeInstance> getCompositeInstances(CompositeInstanceFilter filter)
          Returns a list of composite instance facades that match the conditions specified by the given filter.
 java.util.List<Composite> getComposites(CompositeFilter filter)
          Returns a list of composite facades that match the conditions specified by the filter.
 java.util.List<Composite> getComposites(CompositeFilter filter, boolean populateCounts)
          Returns a list of composites that match the conditions specified by the filter.
 java.text.DateFormat getDateFormat()
          Returns the current date format associated with the back-end server
 oracle.soa.management.facade.edn.IEDN getEDN()
          Get a reference to the EDN console back-end implementation.
 FaultRecoveryResult getFaultRecoveryResult(java.lang.String key)
          Gets the results for the fault recovery attempt identified by the specified key.
 java.util.List<Fault> getFaults(FaultFilter filter)
          Returns a list of faults that match the conditions specified by the filter.
 java.util.Locale getLocale()
          Returns the current locale associated with the back-end server
 int getNumberOfComponentInstances(ComponentInstanceFilter filter)
          Returns the number of component instances that match the conditions specified by the given filter.
 int getNumberOfCompositeInstances(CompositeInstanceFilter filter)
          Returns the number of composite instances that match the conditions specified by the given filter.
 java.util.Map<java.lang.String,java.lang.Integer> getNumberOfCompositeInstancesByPartitions(java.lang.String[] partitions)
           
 int getNumberOfFaultedCompositeInstances(java.lang.String compositeDN)
          Returns the count of faulted composites instances
 java.util.Map<java.lang.String,java.lang.Integer> getNumberOfFaultedCompositeInstancesByPartitions(java.lang.String[] partitions)
           
 int getNumberOfFaults(FaultFilter filter)
          Return the number of faults that match the conditions specified by the filter.
 java.util.List<Reference> getReferences(ReferenceFilter filter)
          Returns a list of references that match the conditions specified by the filter.
 ServiceEngine getServiceEngine(java.lang.String engineType)
          Returns a service engine of the given type.
 java.util.Collection<ServiceEngine> getServiceEngines()
          Returns a collection of service engines currently supported by the SCA infrastructure.
 java.util.List<Service> getServices(ServiceFilter filter)
          Returns a list of services that match the conditions specified by the filter.
 java.lang.String getTestDocumentAsString(oracle.soa.management.facade.tst.TestDocument document)
          Get the XML definition of a test document.
 java.util.List<oracle.soa.management.facade.tst.TestRunResults> getTestRuns(TestRunFilter filter, TestRunOptions options)
          Gets the results of test runs that have already completed or are still in progress.
 java.util.List<oracle.soa.management.facade.tst.TestSuite> getTestSuites(java.lang.String compositeDN, TestSuiteFilter filter)
          Get a list of test suite definitions for a particular composite.
 java.util.List<oracle.soa.management.facade.xref.XRefMgmtEntity> getXRefTables()
          Returns a list of cross reference entities available in the XREF database table
 java.util.List<CompositeDN> listComposites()
           
 void logServerMessage(java.lang.String message)
          Deprecated. This methods will no longer be supported
 Component lookupComponent(CompositeDN compositeDN, java.lang.String componentName)
          Returns the component facade with the given composite DN and the component name.
 Component lookupComponent(java.lang.String componentDN)
          Returns the component facade with the given string-format component DN.
 Composite lookupComposite(CompositeDN compositeDN)
          Returns the SCA composite facade with the given composite DN.
 Composite lookupComposite(java.lang.String compositeDN)
          Returns the SCA composite facade with the given string-format composite DN.
 java.util.List<Composite> lookupComposites(java.util.List<CompositeDN> compositeDNs, boolean populateCount)
          Returns the sca composite facades with the given compositeDNs.
 Reference lookupReference(java.lang.String referenceDN)
          Returns the SCA reference facade with the given string-format reference DN.
 Service lookupService(java.lang.String serviceDN)
          Returns the SCA service facade with the given string-format service DN.
 void purgeInstance(CompositeInstanceFilter filter)
          Deprecated. Please use submitPurgeInstances() method which returns a job id to track the purge instance job
 void purgeInstance(java.lang.String compositeDN)
          Deprecated. Please use submitPurgeInstances() method which returns a job id to track the purge instance job
 boolean purgeXRefData(XRefPurgeFilter purgeFilter)
          Purge data in cross reference table based on criteria set in the filter
 void recoverFaults(FaultFilter filter, int action)
          Attempts to recover the faults matching the specified filter by applying the specified recovery action type.
 void setDateFormat(java.text.DateFormat dateFormat)
          Set the date format preferred by the client.
 void setLocale(java.util.Locale locale)
          Set the locale that the client prefers.
 java.lang.String submitFaultRecovery(FaultFilter filter, int action)
          Submits a request to attempt the recovery of the faults matching the specified filter criteria by applying the specified recovery action type.

 

Field Detail

SE_BPEL

static final java.lang.String SE_BPEL
The type that identifies the BPEL service engine.
See Also:
Constant Field Values

SE_BPMN

static final java.lang.String SE_BPMN
The type that identifies the BPMN service engine.
See Also:
Constant Field Values

SE_HUMAN_WORKFLOW

static final java.lang.String SE_HUMAN_WORKFLOW
The type that identifies the human workflow service engine.
See Also:
Constant Field Values

SE_OEP

static final java.lang.String SE_OEP
The type that identifies the Oracle event processing service engine.
See Also:
Constant Field Values

SE_MEDIATOR

static final java.lang.String SE_MEDIATOR
The type that identifies the mediator service engine.
See Also:
Constant Field Values

SE_DECISION

static final java.lang.String SE_DECISION
The type that identifies the business rules service engine.
See Also:
Constant Field Values

SE_SPRING

static final java.lang.String SE_SPRING
The type that identifies the spring service engine.
See Also:
Constant Field Values

SE_EVENT_AGENT

static final java.lang.String SE_EVENT_AGENT
The type that identifies the event agent service engine
See Also:
Constant Field Values

SE_INVALID

static final java.lang.String SE_INVALID
The type that identifies invalid service engine
See Also:
Constant Field Values

BC_JCA_SERVICE

static final java.lang.String BC_JCA_SERVICE
The type that identifies the JCA service binding component.
See Also:
Constant Field Values

BC_JCA_REFERENCE

static final java.lang.String BC_JCA_REFERENCE
The type that identifies the JCA reference binding component.
See Also:
Constant Field Values

BC_SOAP_SERVICE

static final java.lang.String BC_SOAP_SERVICE
The type that identifies the SOAP service binding component.
See Also:
Constant Field Values

BC_SOAP_REFERENCE

static final java.lang.String BC_SOAP_REFERENCE
The type that identifies the SOAP reference binding component.
See Also:
Constant Field Values

BC_SDO_SERVICE

static final java.lang.String BC_SDO_SERVICE
The type that identifies the SDO service binding component.
See Also:
Constant Field Values

BC_SDO_REFERENCE

static final java.lang.String BC_SDO_REFERENCE
The type that identifies the SDO reference binding component.
See Also:
Constant Field Values

BC_B2B_SERVICE

static final java.lang.String BC_B2B_SERVICE
The type that identifies the B2B service binding component.
See Also:
Constant Field Values

BC_B2B_REFERENCE

static final java.lang.String BC_B2B_REFERENCE
The type that identifies the B2B reference binding component.
See Also:
Constant Field Values

BC_DIRECT_SERVICE

static final java.lang.String BC_DIRECT_SERVICE
The type that identifies the SDO service binding component.
See Also:
Constant Field Values

BC_DIRECT_REFERENCE

static final java.lang.String BC_DIRECT_REFERENCE
The type that identifies the SDO reference binding component.
See Also:
Constant Field Values

SERVICE

static final java.lang.String SERVICE
The type that identifies the inbound binding component.
See Also:
Constant Field Values

REFERENCE

static final java.lang.String REFERENCE
The type that identifies the outbound binding component.
See Also:
Constant Field Values

COMPOSITE

static final java.lang.String COMPOSITE
The type that identifies the composite.
See Also:
Constant Field Values

COMPONENT

static final java.lang.String COMPONENT
The type that identifies the component.
See Also:
Constant Field Values

INVALID_COMPONENT

static final java.lang.String INVALID_COMPONENT
The type that identifies an invalid component
See Also:
Constant Field Values

OPERATION

static final java.lang.String OPERATION
The type that identifies the service operation.
See Also:
Constant Field Values

EVENT

static final java.lang.String EVENT
The type that identifies the business event.
See Also:
Constant Field Values

Method Detail

listComposites

java.util.List<CompositeDN> listComposites()
                                           throws java.lang.Exception
Returns:
A list of all the deployed composite names
Throws:
java.lang.Exception

lookupComposite

Composite lookupComposite(java.lang.String compositeDN)
                          throws java.lang.Exception
Returns the SCA composite facade with the given string-format composite DN.
Parameters:
compositeDN - the string-format composite DN
Returns:
The facade object of the specified composite
Throws:
java.lang.Exception
See Also:
Composite

lookupComposites

java.util.List<Composite> lookupComposites(java.util.List<CompositeDN> compositeDNs,
                                           boolean populateCount)
                                           throws java.lang.Exception
Returns the sca composite facades with the given compositeDNs.
Parameters:
compositeDNs - the composites to lookup
Throws:
java.lang.Exception

lookupComposite

Composite lookupComposite(CompositeDN compositeDN)
                          throws java.lang.Exception
Returns the SCA composite facade with the given composite DN.
Parameters:
compositeDN - the DN of a composite
Returns:
the facade object of the specified composite
Throws:
java.lang.Exception

lookupComponent

Component lookupComponent(java.lang.String componentDN)
                          throws java.lang.Exception
Returns the component facade with the given string-format component DN.
Parameters:
componentDN - the string-format component DN
Returns:
the facade object of the specified component
Throws:
java.lang.Exception
See Also:
Component

lookupComponent

Component lookupComponent(CompositeDN compositeDN,
                          java.lang.String componentName)
                          throws java.lang.Exception
Returns the component facade with the given composite DN and the component name.
Parameters:
compositeDN - the DN of the composite to which the component belongs
componentName - the name of the component
Returns:
the facade object of the specified component
Throws:
java.lang.Exception
See Also:
Component

lookupService

Service lookupService(java.lang.String serviceDN)
                      throws java.lang.Exception
Returns the SCA service facade with the given string-format service DN.
Parameters:
serviceDN - the string-format DN of the service
Returns:
the service facade object of the specified service
Throws:
java.lang.Exception
See Also:
Service

lookupReference

Reference lookupReference(java.lang.String referenceDN)
                          throws java.lang.Exception
Returns the SCA reference facade with the given string-format reference DN.
Parameters:
referenceDN - the string-format DN of the reference
Returns:
the reference facade object of the specified refrence
Throws:
java.lang.Exception
See Also:
Reference

getComposites

java.util.List<Composite> getComposites(CompositeFilter filter)
                                        throws java.lang.Exception
Returns a list of composite facades that match the conditions specified by the filter.
Parameters:
filter - the filter used to screen out unqualified composites
Returns:
a list of the composite facade objects that match the specified filter
Throws:
java.lang.Exception
See Also:
Composite, CompositeFilter

getCompositeInstances

java.util.List<CompositeInstance> getCompositeInstances(CompositeInstanceFilter filter)
                                                        throws java.lang.Exception
Returns a list of composite instance facades that match the conditions specified by the given filter.
Parameters:
filter - the filter used to screen composite instances
Returns:
a list of the composite instance facade objects that match the specified filter
Throws:
java.lang.Exception
See Also:
CompositeInstance, CompositeInstanceFilter

getNumberOfCompositeInstances

int getNumberOfCompositeInstances(CompositeInstanceFilter filter)
                                  throws java.lang.Exception
Returns the number of composite instances that match the conditions specified by the given filter.
Parameters:
filter - the filter used to screen composite instances
Returns:
the number of the composite instances that match the specified filter
Throws:
java.lang.Exception
See Also:
CompositeInstanceFilter

getNumberOfCompositeInstancesByPartitions

java.util.Map<java.lang.String,java.lang.Integer> getNumberOfCompositeInstancesByPartitions(java.lang.String[] partitions)
                                                                                            throws java.lang.Exception
Throws:
java.lang.Exception

getNumberOfFaultedCompositeInstancesByPartitions

java.util.Map<java.lang.String,java.lang.Integer> getNumberOfFaultedCompositeInstancesByPartitions(java.lang.String[] partitions)
                                                                                                   throws java.lang.Exception
Throws:
java.lang.Exception

getComponentInstances

java.util.List<ComponentInstance> getComponentInstances(ComponentInstanceFilter filter)
                                                        throws java.lang.Exception
Returns a list of component instance facades that match the conditions specified by the given filter.
Parameters:
filter - the filter used to screen component instances
Returns:
a list of the component instance facade objects that match the specified filter
Throws:
java.lang.Exception
See Also:
ComponentInstanceFilter

getNumberOfComponentInstances

int getNumberOfComponentInstances(ComponentInstanceFilter filter)
                                  throws java.lang.Exception
Returns the number of component instances that match the conditions specified by the given filter.
Parameters:
filter - the filter used to screen component instances
Returns:
the number of component instances that match the specified filter
Throws:
java.lang.Exception
See Also:
ComponentInstanceFilter

getAuditTrail

java.lang.Object getAuditTrail(java.lang.String ecid)
                               throws java.lang.Exception
Returns the audit trail of a set of component/composite instances who shared the same ECID.
Parameters:
ecid - the execution context ID
Returns:
the object which contains the audit trail for the specified ECID
Throws:
java.lang.Exception

getXRefTables

java.util.List<oracle.soa.management.facade.xref.XRefMgmtEntity> getXRefTables()
                                                                               throws java.lang.Exception
Returns a list of cross reference entities available in the XREF database table
Returns:
A list of XREF objects representing the cross reference tables
Throws:
java.lang.Exception
See Also:
XRefMgmtEntity

purgeXRefData

boolean purgeXRefData(XRefPurgeFilter purgeFilter)
                      throws java.lang.Exception
Purge data in cross reference table based on criteria set in the filter
Parameters:
purgeFilter - Holds the purge filtering criteria
Returns:
true if successfully purged else false
Throws:
java.lang.Exception
See Also:
XRefPurgeFilter

getFaults

java.util.List<Fault> getFaults(FaultFilter filter)
                                throws java.lang.Exception
Returns a list of faults that match the conditions specified by the filter.
Parameters:
filter - the filter to screen out unqualified faults
Returns:
a list of faults that match the conditions specified by the filter
Throws:
java.lang.Exception
See Also:
Fault

getNumberOfFaults

int getNumberOfFaults(FaultFilter filter)
                      throws java.lang.Exception
Return the number of faults that match the conditions specified by the filter.
Parameters:
filter - the filter to screen out unqualified faults
Returns:
the number of faults that match the conditions specified by the filter
Throws:
java.lang.Exception

getServiceEngine

ServiceEngine getServiceEngine(java.lang.String engineType)
                               throws java.lang.Exception
Returns a service engine of the given type.
Parameters:
engineType - the service engine type
Returns:
the service engine facade of the given type
Throws:
java.lang.Exception
See Also:
ServiceEngine

getServiceEngines

java.util.Collection<ServiceEngine> getServiceEngines()
                                                      throws java.lang.Exception
Returns a collection of service engines currently supported by the SCA infrastructure.
Returns:
a collection of service engines
Throws:
java.lang.Exception
See Also:
ServiceEngine

getBindingComponent

BindingComponent getBindingComponent(java.lang.String bcType)
                                     throws java.lang.Exception
Returns the binding component facade of the given type.
Parameters:
bcType - the binding component type
Returns:
the binding component facade of the given type
Throws:
java.lang.Exception
See Also:
ServiceEngine

getBindingComponents

java.util.Collection<BindingComponent> getBindingComponents()
                                                            throws java.lang.Exception
Returns a collection of binding components currently supported by the SCA infrastructure.
Returns:
a collection of binding components
Throws:
java.lang.Exception
See Also:
BindingComponent

getComposites

java.util.List<Composite> getComposites(CompositeFilter filter,
                                        boolean populateCounts)
                                        throws java.lang.Exception
Returns a list of composites that match the conditions specified by the filter.
Parameters:
filter - the composite filter criteria
populateCounts - if true, Composite.getInstanceCount() would return the actual number of composite instances created for this composite and Composite.getFaultCount would return the actual number of faults occurred in the composite. if false, both the count methods would return zero.
Throws:
java.lang.Exception

getComponents

java.util.List<Component> getComponents(ComponentFilter filter)
                                        throws java.lang.Exception
Returns a list of components that match the conditions specified by the filter.
Parameters:
filter - the component filter criteria
Throws:
java.lang.Exception

getComponentSnapShot

java.util.List<Component> getComponentSnapShot(ComponentFilter filter)
                                               throws java.lang.Exception
Returns a snapshot of the following data of this component 1. Running Instance Count. 2. Faulted Instance Count. 3. Total Instance Count.
Parameters:
filter - the component filter criteria
Throws:
java.lang.Exception

getReferences

java.util.List<Reference> getReferences(ReferenceFilter filter)
                                        throws java.lang.Exception
Returns a list of references that match the conditions specified by the filter.
Parameters:
filter - the reference fiter criteria
Throws:
java.lang.Exception

getServices

java.util.List<Service> getServices(ServiceFilter filter)
                                    throws java.lang.Exception
Returns a list of services that match the conditions specified by the filter.
Parameters:
filter - the service filter criteria
Throws:
java.lang.Exception

getNumberOfFaultedCompositeInstances

int getNumberOfFaultedCompositeInstances(java.lang.String compositeDN)
                                         throws java.lang.Exception
Returns the count of faulted composites instances
Parameters:
compositeDN - the string-format composite DN
Throws:
java.lang.Exception

getTestSuites

java.util.List<oracle.soa.management.facade.tst.TestSuite> getTestSuites(java.lang.String compositeDN,
                                                                         TestSuiteFilter filter)
                                                                         throws java.lang.Exception
Get a list of test suite definitions for a particular composite. This method will return all the test cases deployed for a particular composite.
Parameters:
compositeDN - the string-format composite DN
filter - the filter used to screen out unqualified test suites
Returns:
a list of the deployed test suites
Throws:
java.lang.Exception
See Also:
TestSuiteFilter

getTestDocumentAsString

java.lang.String getTestDocumentAsString(oracle.soa.management.facade.tst.TestDocument document)
                                         throws java.lang.Exception
Get the XML definition of a test document. Usually this method is only used internally.
Parameters:
document - The TestDocument object.
Returns:
the XML document in its string representation
Throws:
java.lang.Exception
See Also:
TestDocument

executeTestCases

oracle.soa.management.facade.tst.TestRunResults executeTestCases(java.lang.String compositeDN,
                                                                 TestRunOptions options,
                                                                 java.util.List<oracle.soa.management.facade.tst.TestCase> testcases)
                                                                 throws java.lang.Exception
Instruct the back-end to execute the test cases with the specified running options
Parameters:
compositeDN - the string-format composite DN in which the test cases to be run
options - options to use when running the test cases
testcases - the test cases to be run. These test cases can be obtained by calling getTestSuites(String, TestSuiteFilter) and then traversing the TestSuite objects. Note that all the test cases must originate from the same composite, namely the one mentioned in the compositeDN argument.
Returns:
the results of the executed test cases.
Throws:
java.lang.Exception
See Also:
TestRunOptions TestRunResults

getTestRuns

java.util.List<oracle.soa.management.facade.tst.TestRunResults> getTestRuns(TestRunFilter filter,
                                                                            TestRunOptions options)
                                                                            throws java.lang.Exception
Gets the results of test runs that have already completed or are still in progress.
Parameters:
filter - the filter used to screen out unqualified test runs. For performance reasons, it is best to use as many filter criteria as possible.
options - options to use when getting the test runs
Returns:
a list of test runs that match the filter criteria
Throws:
java.lang.Exception
See Also:
TestRunOptions

getEDN

oracle.soa.management.facade.edn.IEDN getEDN()
                                             throws java.lang.Exception
Get a reference to the EDN console back-end implementation.
Returns:
a reference to EDN console back-end implementation which can be used for EDN runtime data retrieval or event injection.
Throws:
java.lang.Exception
See Also:
IEDN

setLocale

void setLocale(java.util.Locale locale)
Set the locale that the client prefers. The locale-sensitive content will be formatted using the provided locale before it's returned from the server.
Parameters:
locale - the client side locale
See Also:
Locale

getLocale

java.util.Locale getLocale()
Returns the current locale associated with the back-end server
Returns:
the server-side locale

setDateFormat

void setDateFormat(java.text.DateFormat dateFormat)
Set the date format preferred by the client.
Parameters:
dateFormat - DateFormat
See Also:
DateFormat

getDateFormat

java.text.DateFormat getDateFormat()
Returns the current date format associated with the back-end server
Returns:
the server-side date format

purgeInstance

void purgeInstance(CompositeInstanceFilter filter)
                   throws java.lang.Exception
Deprecated. Please use submitPurgeInstances() method which returns a job id to track the purge instance job
Purge instance based on criteria specified in the filter.
Parameters:
filter - holds the purge filter criteria
Throws:
java.lang.Exception
See Also:
CompositeInstanceFilter

purgeInstance

void purgeInstance(java.lang.String compositeDN)
                   throws java.lang.Exception
Deprecated. Please use submitPurgeInstances() method which returns a job id to track the purge instance job
Purge composite instances associated with the specified composite DN. This function provides better performance if you want to delete a large amount of instances. Unlike purgeInstance(CompositeInstanceFilter filter) which loads and delete instances one by one, this function deletes instances from database directly.
Parameters:
compositeDN - the string-format composite DN
Throws:
java.lang.Exception

recoverFaults

void recoverFaults(FaultFilter filter,
                   int action)
                   throws java.lang.Exception
Attempts to recover the faults matching the specified filter by applying the specified recovery action type.
Parameters:
filter - the fault filter criteria
action - the recovery action type
Throws:
java.lang.Exception
See Also:
FaultRecoveryActionTypeConstants

submitFaultRecovery

java.lang.String submitFaultRecovery(FaultFilter filter,
                                     int action)
Submits a request to attempt the recovery of the faults matching the specified filter criteria by applying the specified recovery action type.
Parameters:
filter - the fault filter criteria
action - the recovery action type
Returns:
A unique key, which can be used to determine the status of the processing and ultimately, the results.
See Also:
FaultRecoveryActionTypeConstants

getFaultRecoveryResult

FaultRecoveryResult getFaultRecoveryResult(java.lang.String key)
Gets the results for the fault recovery attempt identified by the specified key.
Parameters:
key - the unique identifier of the fault recovery attempt for which the results are desired
Returns:
the results

close

void close()
Clean up resources used by the locator.

createDirectConnection

DirectConnection createDirectConnection(CompositeDN compositeDN,
                                        java.lang.String serviceName)
                                        throws java.lang.Exception
Creates a direct binding connection to the specified composite service
Parameters:
compositeDN - the composite distinguished name
serviceName - the name of the service exposing a direct binding
Returns:
A direct binding connection to the specified composite service
Throws:
java.lang.Exception

executeServiceEngineMethod

java.lang.Object executeServiceEngineMethod(java.lang.String engineType,
                                            java.lang.String methodName,
                                            java.lang.Object[] params)
                                            throws java.lang.Exception
Deprecated. This methods will no longer be supported
Execute a service engine method with the specified parameters
Parameters:
engineType - specify which service engine this method should be execute with
methodName - the name of the method to be executed
params - the parameters for the method to be executed
Returns:
an object that returned from the method execution in the specified service engine
Throws:
java.lang.Exception

executeBindingComponentMethod

java.lang.Object executeBindingComponentMethod(java.lang.String bindingComponentType,
                                               java.lang.String methodName,
                                               java.lang.Object[] params)
                                               throws java.lang.Exception
Deprecated. This methods will no longer be supported
Execute the binding component method with the specified parameters
Parameters:
bindingComponentType - the type of the binding component in which this method will be executed.
methodName - the name of the method to be executed
params - the parameters for the method to be executed
Returns:
an object that returned from the method execution in the specified binding component
Throws:
java.lang.Exception

executeCompositeMethod

java.lang.Object executeCompositeMethod(CompositeDN compositeDN,
                                        java.lang.String methodName,
                                        java.lang.Object[] params)
                                        throws java.lang.Exception
Deprecated. This methods will no longer be supported
Execute a method of a composite facade. This is used to lazily load the content of a composite facade. For example, aComposite.getDocumentAsString(uri) will internally call this method, as: locator.executeCompositeMethod(getDN(), "getDocumentAsString", new Object[] {uri});
Parameters:
compositeDN - the DN of a composite
methodName - the name of the method to be executed
params - the parameters for the method to be executed
Returns:
an object that returned from the method execution in the specified composite
Throws:
java.lang.Exception

executeComponentMethod

java.lang.Object executeComponentMethod(CompositeDN compositeDN,
                                        java.lang.String componentName,
                                        java.lang.String methodName,
                                        java.lang.Object[] params)
                                        throws java.lang.Exception
Deprecated. This methods will no longer be supported
Execute a method of a component facade. This is used to lazily load the content of a component facade. For example, aBpelComponent.getSensors() will internally call this method, as: locator.executeComponentMethod(getDN(), "getSensors", null);
Parameters:
compositeDN - the DN of a composite
methodName - the name of the method to be executed.
params - the parameters for the method to be executed
Returns:
an object that returned from the method execution in the specified component
Throws:
java.lang.Exception

executeComponentInstanceMethod

java.lang.Object executeComponentInstanceMethod(java.lang.String instanceId,
                                                java.lang.String methodName,
                                                java.lang.Object[] params)
                                                throws java.lang.Exception
Deprecated. This methods will no longer be supported
Execute a method of a component instance facade of the given instanceId. This is used to lazily load the content of a component instance facade. For example, aComponentInstance.getAuditTrail() will internally call this method, as: locator.executeComponentInstanceMethod(getInstanceId(), "getAuditTrail");
Parameters:
instanceId - the component instance id
methodName - the name of the method to be executed
params - the parameters for the method to be executed
Returns:
an object that returned from the method execution in the specified component instance
Throws:
java.lang.Exception

executeServiceMethod

java.lang.Object executeServiceMethod(CompositeDN compositeDN,
                                      java.lang.String serviceName,
                                      java.lang.String methodName,
                                      java.lang.Object[] params)
                                      throws java.lang.Exception
Deprecated. This methods will no longer be supported
Parameters:
compositeDN - the distinguished name of the composite
serviceName - the name of the service method
methodName - the name of the method to invoke
params - the method arguments
Throws:
java.lang.Exception

executeEDNMethod

java.lang.Object executeEDNMethod(java.lang.String methodName,
                                  java.lang.Object[] params)
                                  throws java.lang.Exception
Deprecated. This methods will no longer be supported
Executes a method on the EDN console backend implementation
Parameters:
methodName - the name of the method to invoke
params - the method arguments
Throws:
java.lang.Exception

logServerMessage

void logServerMessage(java.lang.String message)
Deprecated. This methods will no longer be supported
Log the specified message to the server's standard output.
Parameters:
message - The message to log

Skip navigation links

Oracle Fusion Middleware Infrastructure Management Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1.5.0)
E10659-04


Copyright © 2010, Oracle and/or its affiliates. All rights reserved.