|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sap.conn.jco.JCoDestinationManager
public abstract class JCoDestinationManager
The JCoDestinationManager creates and manages the destinations used by JCo applications. The APIs are static and can be invoked directly.
The destination manager uses the instance of DestinationDataProvider
registered at the environment to get the destination configuration properties. In each environment a suitable
implementation of the DestinationDataProvider has to be registered to ensure an appropriate management
of destination properties. The registration is performed with
com.sap.conn.jco.ext.Environment.registerDestinationDataProvider(DestinationDataProvider)
.
Note: A destination instance may become invalid if the destination configuration
is changed or removed. In such cases the running operation will be finished, but the further usage
of the invalidated destination will be blocked by throwing a JCoException with the key
JCO_ERROR_DESTINATION_DATA_INVALID.
The application may fetch an updated destination instance from JCoDestinationManager, if it is suitable for
the application scenario.
Method Summary | |
---|---|
abstract java.util.List<java.lang.String> |
getCustomDestinationIDs(java.lang.String destinationID)
Deprecated. Might be removed in future versions without further notice. Use JCo.getCustomDestinationIDs(String) instead. |
static JCoDestination |
getDestination(java.lang.String destinationName)
Call this method to get an instance of a destination, on which you would like to execute a function module. |
static JCoDestination |
getDestination(java.lang.String destinationName,
java.lang.String scopeType)
Call this method to get an instance of a destination, on which you need to execute a function module. |
abstract java.util.List<java.lang.String> |
getDestinationIDs()
Deprecated. Might be removed in future versions without further notice. Use JCo.getDestinationIDs() instead. |
abstract JCoDestination |
getDestinationInstance(java.lang.String destinationName,
java.lang.String scopeType)
Deprecated. Reserved for internal use - visibility might be reduced in future versions without further notice. Use getDestination(String) or getDestination(String, String) instead. |
abstract JCoDestinationMonitor |
getDestinationMonitor(java.lang.String destinationID)
Deprecated. Might be removed in future versions without further notice. Use JCo.getDestinationMonitor(String) instead. |
abstract JCoDestinationMonitor |
getRepositoryDestinationMonitor(java.lang.String destinationID)
Deprecated. Might be removed in future versions without further notice. Use JCo.getRepositoryDestinationMonitor(String) instead. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
@Deprecated public abstract JCoDestination getDestinationInstance(java.lang.String destinationName, java.lang.String scopeType) throws JCoException
getDestination(String)
or getDestination(String, String)
instead.
destinationName
- the name of the destination for which a JCoDestination instance shall be returnedscopeType
- the name of the scope to which the destination shall belong to
JCoException
- if the specified destination does not exist or could not be created@Deprecated public abstract java.util.List<java.lang.String> getDestinationIDs()
JCo.getDestinationIDs()
instead.
@Deprecated public abstract java.util.List<java.lang.String> getCustomDestinationIDs(java.lang.String destinationID)
JCo.getCustomDestinationIDs(String)
instead.
destinationID
- ID of the destination used for the creation of the custom destinations
@Deprecated public abstract JCoDestinationMonitor getDestinationMonitor(java.lang.String destinationID) throws JCoRuntimeException
JCo.getDestinationMonitor(String)
instead.
destinationID
- the unique destination ID, for which the monitor should be returned
JCoRuntimeException
- in case of issues while getting and creating the destination monitor@Deprecated public abstract JCoDestinationMonitor getRepositoryDestinationMonitor(java.lang.String destinationID) throws JCoRuntimeException
JCo.getRepositoryDestinationMonitor(String)
instead.
destinationID
- the unique destination ID for which the monitor for the repository destination
should be returned
JCoRuntimeException
- in case of issues while getting and creating the destination monitorpublic static JCoDestination getDestination(java.lang.String destinationName) throws JCoException
destinationName
- the name of the destination, for which a JCoDestination instance shall be returned
JCoException
- if the specified destination does not exist or could not be createdpublic static JCoDestination getDestination(java.lang.String destinationName, java.lang.String scopeType) throws JCoException
getDestination(String destinationName)
. If scopeTypes are supported, the valid scopeTypes
are defined by the session management of the runtime environment.
destinationName
- the name of the destination for which a JCoDestination instance shall be returnedscopeType
- the name of the scope to which the destination shall belong to
JCoException
- if the specified destination does not exist or could not be createdSessionReferenceProvider
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |