|
Oracle Fusion Middleware Infrastructure Management Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.6.3) E10659-09 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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. |
java.util.List<Composite> |
lookupComposites(java.util.List<CompositeDN> compositeDNs, boolean populateCount, java.util.Date minCreationTime) 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) Purge instance based on criteria specified in the filter. |
void |
purgeInstance(java.lang.String compositeDN) Purge composite instances associated with the specified composite DN. |
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 |
---|
static final java.lang.String SE_BPEL
static final java.lang.String SE_BPMN
static final java.lang.String SE_HUMAN_WORKFLOW
static final java.lang.String SE_OEP
static final java.lang.String SE_MEDIATOR
static final java.lang.String SE_DECISION
static final java.lang.String SE_SPRING
static final java.lang.String SE_EVENT_AGENT
static final java.lang.String SE_INVALID
static final java.lang.String BC_JCA_SERVICE
static final java.lang.String BC_JCA_REFERENCE
static final java.lang.String BC_SOAP_SERVICE
static final java.lang.String BC_SOAP_REFERENCE
static final java.lang.String BC_SDO_SERVICE
static final java.lang.String BC_SDO_REFERENCE
static final java.lang.String BC_B2B_SERVICE
static final java.lang.String BC_B2B_REFERENCE
static final java.lang.String BC_DIRECT_SERVICE
static final java.lang.String BC_DIRECT_REFERENCE
static final java.lang.String SERVICE
static final java.lang.String REFERENCE
static final java.lang.String COMPOSITE
static final java.lang.String COMPONENT
static final java.lang.String INVALID_COMPONENT
static final java.lang.String OPERATION
static final java.lang.String EVENT
Method Detail |
---|
java.util.List<CompositeDN> listComposites() throws java.lang.Exception
java.lang.Exception
Composite lookupComposite(java.lang.String compositeDN) throws java.lang.Exception
compositeDN
- the string-format composite DNjava.lang.Exception
Composite
java.util.List<Composite> lookupComposites(java.util.List<CompositeDN> compositeDNs, boolean populateCount) throws java.lang.Exception
compositeDNs
- the composites to lookuppopulatecount
- Whether to populate the instance count and fault for each returned Composite instance.java.lang.Exception
java.util.List<Composite> lookupComposites(java.util.List<CompositeDN> compositeDNs, boolean populateCount, java.util.Date minCreationTime) throws java.lang.Exception
compositeDNs
- The composites to lookuppopulatecount
- Whether to populate the instance count and fault for each returned Composite instance.minCreationTime
- The starting time to record instance count and faultsjava.lang.Exception
Composite lookupComposite(CompositeDN compositeDN) throws java.lang.Exception
compositeDN
- the DN of a compositejava.lang.Exception
Component lookupComponent(java.lang.String componentDN) throws java.lang.Exception
componentDN
- the string-format component DNjava.lang.Exception
Component
Component lookupComponent(CompositeDN compositeDN, java.lang.String componentName) throws java.lang.Exception
compositeDN
- the DN of the composite to which the component belongscomponentName
- the name of the componentjava.lang.Exception
Component
Service lookupService(java.lang.String serviceDN) throws java.lang.Exception
serviceDN
- the string-format DN of the servicejava.lang.Exception
Service
Reference lookupReference(java.lang.String referenceDN) throws java.lang.Exception
referenceDN
- the string-format DN of the referencejava.lang.Exception
Reference
java.util.List<Composite> getComposites(CompositeFilter filter) throws java.lang.Exception
filter
- the filter used to screen out unqualified compositesjava.lang.Exception
Composite, CompositeFilter
java.util.List<CompositeInstance> getCompositeInstances(CompositeInstanceFilter filter) throws java.lang.Exception
filter
- the filter used to screen composite instancesjava.lang.Exception
CompositeInstance, CompositeInstanceFilter
int getNumberOfCompositeInstances(CompositeInstanceFilter filter) throws java.lang.Exception
filter
- the filter used to screen composite instancesjava.lang.Exception
CompositeInstanceFilter
java.util.Map<java.lang.String,java.lang.Integer> getNumberOfCompositeInstancesByPartitions(java.lang.String[] partitions) throws java.lang.Exception
java.lang.Exception
java.util.Map<java.lang.String,java.lang.Integer> getNumberOfFaultedCompositeInstancesByPartitions(java.lang.String[] partitions) throws java.lang.Exception
java.lang.Exception
java.util.List<ComponentInstance> getComponentInstances(ComponentInstanceFilter filter) throws java.lang.Exception
filter
- the filter used to screen component instancesjava.lang.Exception
ComponentInstanceFilter
int getNumberOfComponentInstances(ComponentInstanceFilter filter) throws java.lang.Exception
filter
- the filter used to screen component instancesjava.lang.Exception
ComponentInstanceFilter
java.lang.Object getAuditTrail(java.lang.String ecid) throws java.lang.Exception
ecid
- the execution context IDjava.lang.Exception
java.util.List<oracle.soa.management.facade.xref.XRefMgmtEntity> getXRefTables() throws java.lang.Exception
java.lang.Exception
XRefMgmtEntity
boolean purgeXRefData(XRefPurgeFilter purgeFilter) throws java.lang.Exception
purgeFilter
- Holds the purge filtering criteriajava.lang.Exception
XRefPurgeFilter
java.util.List<Fault> getFaults(FaultFilter filter) throws java.lang.Exception
filter
- the filter to screen out unqualified faultsjava.lang.Exception
Fault
int getNumberOfFaults(FaultFilter filter) throws java.lang.Exception
filter
- the filter to screen out unqualified faultsjava.lang.Exception
ServiceEngine getServiceEngine(java.lang.String engineType) throws java.lang.Exception
engineType
- the service engine typejava.lang.Exception
ServiceEngine
java.util.Collection<ServiceEngine> getServiceEngines() throws java.lang.Exception
java.lang.Exception
ServiceEngine
BindingComponent getBindingComponent(java.lang.String bcType) throws java.lang.Exception
bcType
- the binding component typejava.lang.Exception
ServiceEngine
java.util.Collection<BindingComponent> getBindingComponents() throws java.lang.Exception
java.lang.Exception
BindingComponent
java.util.List<Composite> getComposites(CompositeFilter filter, boolean populateCounts) throws java.lang.Exception
filter
- the composite filter criteriapopulateCounts
- 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.java.lang.Exception
java.util.List<Component> getComponents(ComponentFilter filter) throws java.lang.Exception
filter
- the component filter criteriajava.lang.Exception
java.util.List<Component> getComponentSnapShot(ComponentFilter filter) throws java.lang.Exception
filter
- the component filter criteriajava.lang.Exception
java.util.List<Reference> getReferences(ReferenceFilter filter) throws java.lang.Exception
filter
- the reference fiter criteriajava.lang.Exception
java.util.List<Service> getServices(ServiceFilter filter) throws java.lang.Exception
filter
- the service filter criteriajava.lang.Exception
int getNumberOfFaultedCompositeInstances(java.lang.String compositeDN) throws java.lang.Exception
compositeDN
- the string-format composite DNjava.lang.Exception
java.util.List<oracle.soa.management.facade.tst.TestSuite> getTestSuites(java.lang.String compositeDN, TestSuiteFilter filter) throws java.lang.Exception
compositeDN
- the string-format composite DNfilter
- the filter used to screen out unqualified test suitesjava.lang.Exception
TestSuiteFilter
java.lang.String getTestDocumentAsString(oracle.soa.management.facade.tst.TestDocument document) throws java.lang.Exception
document
- The TestDocument object.java.lang.Exception
TestDocument
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
compositeDN
- the string-format composite DN in which the test cases to be runoptions
- options to use when running the test casestestcases
- 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.java.lang.Exception
TestRunOptions TestRunResults
java.util.List<oracle.soa.management.facade.tst.TestRunResults> getTestRuns(TestRunFilter filter, TestRunOptions options) throws java.lang.Exception
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 runsjava.lang.Exception
TestRunOptions
oracle.soa.management.facade.edn.IEDN getEDN() throws java.lang.Exception
java.lang.Exception
IEDN
void setLocale(java.util.Locale locale)
locale
- the client side localeLocale
java.util.Locale getLocale()
void setDateFormat(java.text.DateFormat dateFormat)
dateFormat
- DateFormatDateFormat
java.text.DateFormat getDateFormat()
void purgeInstance(CompositeInstanceFilter filter) throws java.lang.Exception
filter
- holds the purge filter criteriajava.lang.Exception
CompositeInstanceFilter
void purgeInstance(java.lang.String compositeDN) throws java.lang.Exception
purgeInstance(CompositeInstanceFilter filter)
which loads and delete instances one by one, this function deletes instances from database directly.compositeDN
- the string-format composite DNjava.lang.Exception
void recoverFaults(FaultFilter filter, int action) throws java.lang.Exception
filter
- the fault filter criteriaaction
- the recovery action typejava.lang.Exception
FaultRecoveryActionTypeConstants
java.lang.String submitFaultRecovery(FaultFilter filter, int action)
filter
- the fault filter criteriaaction
- the recovery action typeFaultRecoveryActionTypeConstants
FaultRecoveryResult getFaultRecoveryResult(java.lang.String key)
key
- the unique identifier of the fault recovery attempt for which the results are desiredvoid close()
DirectConnection createDirectConnection(CompositeDN compositeDN, java.lang.String serviceName) throws java.lang.Exception
compositeDN
- the composite distinguished nameserviceName
- the name of the service exposing a direct bindingjava.lang.Exception
java.lang.Object executeServiceEngineMethod(java.lang.String engineType, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
engineType
- specify which service engine this method should be execute withmethodName
- the name of the method to be executedparams
- the parameters for the method to be executedjava.lang.Exception
java.lang.Object executeBindingComponentMethod(java.lang.String bindingComponentType, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
bindingComponentType
- the type of the binding component in which this method will be executed.methodName
- the name of the method to be executedparams
- the parameters for the method to be executedjava.lang.Exception
java.lang.Object executeCompositeMethod(CompositeDN compositeDN, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
compositeDN
- the DN of a compositemethodName
- the name of the method to be executedparams
- the parameters for the method to be executedjava.lang.Exception
java.lang.Object executeComponentMethod(CompositeDN compositeDN, java.lang.String componentName, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
compositeDN
- the DN of a compositemethodName
- the name of the method to be executed.params
- the parameters for the method to be executedjava.lang.Exception
java.lang.Object executeComponentInstanceMethod(java.lang.String instanceId, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
instanceId
- the component instance idmethodName
- the name of the method to be executedparams
- the parameters for the method to be executedjava.lang.Exception
java.lang.Object executeServiceMethod(CompositeDN compositeDN, java.lang.String serviceName, java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
compositeDN
- the distinguished name of the compositeserviceName
- the name of the service methodmethodName
- the name of the method to invokeparams
- the method argumentsjava.lang.Exception
java.lang.Object executeEDNMethod(java.lang.String methodName, java.lang.Object[] params) throws java.lang.Exception
methodName
- the name of the method to invokeparams
- the method argumentsjava.lang.Exception
void logServerMessage(java.lang.String message)
message
- The message to log
|
Oracle Fusion Middleware Infrastructure Management Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.6.3) E10659-09 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |