Package oracle.soa.management.facade

Interface Locator

public interface Locator

The Locator is the entry point for soa management APIs and maps to a SOA instance.

Method Summary

Modifier and Type	Method	Description
DirectConnection	createDirectConnection(oracle.soa.management.CompositeDN compositeDN, String serviceName)	Creates a direct binding connection to the specified composite service
List<String>	getAllCompositeDNs()
oracle.soa.management.facade.CircuitBreaker	getCircuitBreaker(String eventName, String componentName, oracle.soa.management.CompositeDN compositeDN)	Return a CircuitBreaker object for the given eventName, componentName, and compositeDN
oracle.soa.management.facade.CircuitBreaker	getCircuitBreaker(String endpointName, oracle.soa.management.CompositeDN compositeDN)	Return a CircuitBreaker object for the given endpointName, compositeDN
oracle.soa.management.facade.CircuitBreaker	getCircuitBreaker(oracle.soa.management.facade.QuiescedService qs)	Return a CircuitBreaker object for the given QuiescedService
oracle.soa.management.facade.CircuitBreakerHistory	getCircuitBreakerHistory(String partition, oracle.soa.management.facade.QuiescedServiceHistory history)	Return the CircuitBreakerHistory object related to the given QuiescedServiceHistory object
List<oracle.soa.management.facade.CircuitBreakerHistory>	getCircuitBreakerHistoryRecords(String partition, long scaEntityId, Date begin, Date end)	Return a list of CircuitBreakerHistory objects for the given scaEntityId that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
List<oracle.soa.management.facade.CircuitBreakerHistory>	getCircuitBreakerHistoryRecords(String partition, Date begin, Date end)	Return a list of CircuitBreakerHistory objects for the given partition that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
List<String>	getDefaultRevisionCompositeDNs()
String	getDocumentAsStringFromClasspath(String compositeDN, String namespace, String documentBaseURI)	Retrieve Definition of the resource having path as CLASSPATH
oracle.soa.management.facade.QuiescedService	getQuiescedService(String eventName, String componentName, oracle.soa.management.CompositeDN compositeDN)	Return a QuiescedService object that matches the eventName, componentName, compositeDN The QuiescedService will represent an EDN subscriber
oracle.soa.management.facade.QuiescedService	getQuiescedService(String endpointName, oracle.soa.management.CompositeDN compositeDN)	Return a QuescedService object that matches the endpointName and compositeDN
List<oracle.soa.management.facade.QuiescedServiceHistory>	getQuiescedServiceHistoryForInboundEndpoint(String inboundEPName, String partition, Date begin, Date end)	Return a list of QuiescedServiceHistory objects for the given partition whose name = inboundEPName that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
List<oracle.soa.management.facade.QuiescedServiceHistory>	getQuiescedServiceHistoryForOutboundEndpoint(String outboundEPName, String partition, Date begin, Date end)	Return a list of QuiescedServiceHistory objects for the given partition whose name = outboundEPName that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
List<oracle.soa.management.facade.QuiescedService>	getQuiescedServices(String partitionName)	Return a list of QuiescedService objects that represents the Adapters, EDN subscribers, WebServices that are currently quiesced.
List<oracle.soa.management.facade.QuiescedServiceHistory>	getQuiescedServicesHistory(String partition, oracle.soa.management.facade.CircuitBreakerHistory history)	Return a list of QuiesceServiceHistory objects related to the given CircuitBreakerHistory
List<oracle.soa.management.facade.QuiescedServiceHistory>	getServiceHistoryRecords(String partition, long scaEntityId, Date begin, Date end)	Return a list of QuiescedServiceHistory objects for the given scaEntityId that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
List<oracle.soa.management.facade.QuiescedServiceHistory>	getServiceHistoryRecords(String partition, Date begin, Date end)	Return a list of QuiescedServiceHistory objects for the given partition that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date
String	getWsdlForDefMsg(String compositeDN, String componentName, QName messageQName)	For given message QName, returns related WSDL document URI as a String.
String	getWsdlForSchemaElement(String compositeDN, String componentName, QName schemaElemQName)	For given schema element QName, returns related WSDL document URI as a String.
int	purgeHistoryCount(oracle.soa.management.util.PurgeHistoryDetailsFilter purgeHistoryDetailsFilterFilter)
List<oracle.soa.management.util.PurgeHistoryDetails>	purgeHistoryDetails(oracle.soa.management.util.PurgeHistoryDetailsFilter purgeHistoryDetailsFilterFilter)
void	storeCSFKey(String csfKey, String username, String password)
void	unquiesce(String eventName, String componentName, oracle.soa.management.CompositeDN compositeDN)	Unquiesce the QuiescedService that matches the given parameters, if the service is not found or not quiesced nothing will be done
void	unquiesce(String endpointName, oracle.soa.management.CompositeDN compositeDN)	Unquiesce the QuiescedService that matches the given parameters, if the service is not found or not quiesced nothing will be done
void	unquiesce(oracle.soa.management.facade.QuiescedService qs)	Unquiesce the given QuiescedService, if the service is not quiesced nothing will be done

Method Details

storeCSFKey

void storeCSFKey(String csfKey,
 String username,
 String password)
          throws Exception

Parameters:

csfKey - The csf-key for these credentials

username - The username part of credentials

password - The password part of credentials

Throws:

Exception

createDirectConnection

DirectConnection createDirectConnection(oracle.soa.management.CompositeDN compositeDN,
 String serviceName)
                                 throws 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:

Exception

getQuiescedServices

List<oracle.soa.management.facade.QuiescedService> getQuiescedServices(String partitionName)
                                                                throws Exception

Return a list of QuiescedService objects that represents the Adapters, EDN subscribers, WebServices that are currently quiesced.

Parameters:

partitionName - partition to return quiesced services for

Returns:

List of QuiescedServices

Throws:

Exception

See Also:

• QuiescedService

getQuiescedService

oracle.soa.management.facade.QuiescedService getQuiescedService(String eventName,
 String componentName,
 oracle.soa.management.CompositeDN compositeDN)
                                                         throws Exception

Return a QuiescedService object that matches the eventName, componentName, compositeDN The QuiescedService will represent an EDN subscriber

Parameters:

eventName -

componentName -

compositeDN -

Returns:

QuiesceService if found else null

Throws:

Exception

getQuiescedService

oracle.soa.management.facade.QuiescedService getQuiescedService(String endpointName,
 oracle.soa.management.CompositeDN compositeDN)
                                                         throws Exception

Return a QuescedService object that matches the endpointName and compositeDN

Parameters:

endpointName -

compositeDN -

Returns:

QuiescedService if found else null

Throws:

Exception

getCircuitBreaker

oracle.soa.management.facade.CircuitBreaker getCircuitBreaker(oracle.soa.management.facade.QuiescedService qs)
                                                       throws Exception

Return a CircuitBreaker object for the given QuiescedService

Parameters:

qs - QuiescedService

Returns:

CircuitBreaker if exists, else null

Throws:

Exception

getCircuitBreaker

oracle.soa.management.facade.CircuitBreaker getCircuitBreaker(String eventName,
 String componentName,
 oracle.soa.management.CompositeDN compositeDN)
                                                       throws Exception

Return a CircuitBreaker object for the given eventName, componentName, and compositeDN

Parameters:

eventName -

componentName -

compositeDN -

Returns:

CircuitBreaker if exists, else null

Throws:

Exception

getCircuitBreaker

oracle.soa.management.facade.CircuitBreaker getCircuitBreaker(String endpointName,
 oracle.soa.management.CompositeDN compositeDN)
                                                       throws Exception

Return a CircuitBreaker object for the given endpointName, compositeDN

Parameters:

endpointName -

compositeDN -

Returns:

CircuiteBreak if exists, else null

Throws:

Exception

unquiesce

void unquiesce(oracle.soa.management.facade.QuiescedService qs)
        throws Exception

Unquiesce the given QuiescedService, if the service is not quiesced nothing will be done

Parameters:

qs - the QuiescedService to unquiesce

Throws:

Exception

unquiesce

void unquiesce(String eventName,
 String componentName,
 oracle.soa.management.CompositeDN compositeDN)
        throws Exception

Unquiesce the QuiescedService that matches the given parameters, if the service is not found or not quiesced nothing will be done

Parameters:

eventName -

componentName -

compositeDN -

Throws:

Exception

unquiesce

void unquiesce(String endpointName,
 oracle.soa.management.CompositeDN compositeDN)
        throws Exception

Unquiesce the QuiescedService that matches the given parameters, if the service is not found or not quiesced nothing will be done

Parameters:

endpointName -

compositeDN -

Throws:

Exception

getDocumentAsStringFromClasspath

String getDocumentAsStringFromClasspath(String compositeDN,
 String namespace,
 String documentBaseURI)
                                 throws RemoteException,
Exception

Retrieve Definition of the resource having path as CLASSPATH

Parameters:

compositeDN -

namespace -

documentBaseURI -

Returns:

Throws:

RemoteException

Exception

getServiceHistoryRecords

List<oracle.soa.management.facade.QuiescedServiceHistory> getServiceHistoryRecords(String partition,
 Date begin,
 Date end)
                                                                            throws Exception

Return a list of QuiescedServiceHistory objects for the given partition that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

partition -

begin -

end -

Returns:

List of QuiescedServiceHistory records

Throws:

Exception

getServiceHistoryRecords

List<oracle.soa.management.facade.QuiescedServiceHistory> getServiceHistoryRecords(String partition,
 long scaEntityId,
 Date begin,
 Date end)
                                                                            throws Exception

Return a list of QuiescedServiceHistory objects for the given scaEntityId that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

partition -

scaEntityId - id of suspended service

begin -

end -

Returns:

List of QuiescedServiceHistory records

Throws:

Exception

getCircuitBreakerHistoryRecords

List<oracle.soa.management.facade.CircuitBreakerHistory> getCircuitBreakerHistoryRecords(String partition,
 long scaEntityId,
 Date begin,
 Date end)
                                                                                  throws Exception

Return a list of CircuitBreakerHistory objects for the given scaEntityId that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

partition -

scaEntityId - id of downstream endpoint

begin -

end -

Returns:

List of CircuitBreakerHistory records

Throws:

Exception

getCircuitBreakerHistoryRecords

List<oracle.soa.management.facade.CircuitBreakerHistory> getCircuitBreakerHistoryRecords(String partition,
 Date begin,
 Date end)
                                                                                  throws Exception

Return a list of CircuitBreakerHistory objects for the given partition that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

partition -

begin -

end -

Returns:

List of CircuitBreakerHistory records

Throws:

Exception

getQuiescedServiceHistoryForInboundEndpoint

List<oracle.soa.management.facade.QuiescedServiceHistory> getQuiescedServiceHistoryForInboundEndpoint(String inboundEPName,
 String partition,
 Date begin,
 Date end)
                                                                                               throws Exception

Return a list of QuiescedServiceHistory objects for the given partition whose name = inboundEPName that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

inboundEPName -

partition -

begin -

end -

Returns:

List of QuiescedServiceHistory records

Throws:

Exception

getQuiescedServiceHistoryForOutboundEndpoint

List<oracle.soa.management.facade.QuiescedServiceHistory> getQuiescedServiceHistoryForOutboundEndpoint(String outboundEPName,
 String partition,
 Date begin,
 Date end)
                                                                                                throws Exception

Return a list of QuiescedServiceHistory objects for the given partition whose name = outboundEPName that falls between the begin and end date If begin and end date are null then return all history objects If begin is null then return all records up to the end date If end date is null then return all records after begin date

Parameters:

outboundEPName -

partition -

begin -

end -

Returns:

List of QuiescedServiceHistory records

Throws:

Exception

getQuiescedServicesHistory

List<oracle.soa.management.facade.QuiescedServiceHistory> getQuiescedServicesHistory(String partition,
 oracle.soa.management.facade.CircuitBreakerHistory history)
                                                                              throws Exception

Return a list of QuiesceServiceHistory objects related to the given CircuitBreakerHistory

Parameters:

partition -

history - CircuitBreakerHistory related to the returned QuiescedServiceHistory objects

Returns:

list of QuiescedServiceHistory objects related to passed in CircuitBreakerHistory

Throws:

Exception

getCircuitBreakerHistory

oracle.soa.management.facade.CircuitBreakerHistory getCircuitBreakerHistory(String partition,
 oracle.soa.management.facade.QuiescedServiceHistory history)
                                                                     throws Exception

Return the CircuitBreakerHistory object related to the given QuiescedServiceHistory object

Parameters:

partition -

history - QuiesceServiceHistory

Returns:

CircuitBreakerHistory related to QuiescedServiceHistory

Throws:

Exception

getWsdlForSchemaElement

String getWsdlForSchemaElement(String compositeDN,
 String componentName,
 QName schemaElemQName)
                        throws RemoteException,
Exception

For given schema element QName, returns related WSDL document URI as a String.

Parameters:

compositeDN -

componentName -

schemaElemQName -

Returns:

WSDL document URI as a String

Throws:

RemoteException

Exception

getWsdlForDefMsg

String getWsdlForDefMsg(String compositeDN,
 String componentName,
 QName messageQName)
                 throws RemoteException,
Exception

For given message QName, returns related WSDL document URI as a String.

Parameters:

compositeDN -

componentName -

messageQName -

Returns:

WSDL document URI as a String

Throws:

RemoteException

Exception

getDefaultRevisionCompositeDNs

List<String> getDefaultRevisionCompositeDNs()
                                     throws RemoteException,
Exception

Throws:

RemoteException

Exception

getAllCompositeDNs

List<String> getAllCompositeDNs()
                         throws RemoteException,
Exception

Throws:

RemoteException

Exception

purgeHistoryDetails

List<oracle.soa.management.util.PurgeHistoryDetails> purgeHistoryDetails(oracle.soa.management.util.PurgeHistoryDetailsFilter purgeHistoryDetailsFilterFilter)
                                                                  throws RemoteException,
Exception

Throws:

RemoteException

Exception

purgeHistoryCount

int purgeHistoryCount(oracle.soa.management.util.PurgeHistoryDetailsFilter purgeHistoryDetailsFilterFilter)
               throws RemoteException,
Exception

Throws:

RemoteException

Exception