com.sap.conn.jco
Class JCoDestinationManager

java.lang.Object
  extended by com.sap.conn.jco.JCoDestinationManager

public abstract class JCoDestinationManager
extends java.lang.Object

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

getDestinationInstance

@Deprecated
public abstract JCoDestination getDestinationInstance(java.lang.String destinationName,
                                                                 java.lang.String scopeType)
                                               throws JCoException
Deprecated. Reserved for internal use - visibility might be reduced in future versions without further notice. Use getDestination(String) or getDestination(String, String) instead.

Do not use this method.

Parameters:
destinationName - the name of the destination for which a JCoDestination instance shall be returned
scopeType - the name of the scope to which the destination shall belong to
Returns:
a JCoDestination instance that matches the destination name
Throws:
JCoException - if the specified destination does not exist or could not be created

getDestinationIDs

@Deprecated
public abstract java.util.List<java.lang.String> getDestinationIDs()
Deprecated. Might be removed in future versions without further notice. Use JCo.getDestinationIDs() instead.

Do not use this method.

Returns:
a new list containing IDs for all (used) destinations

getCustomDestinationIDs

@Deprecated
public 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.

Do not use this method.

Parameters:
destinationID - ID of the destination used for the creation of the custom destinations
Returns:
a new list containing the IDs of existing custom destinations

getDestinationMonitor

@Deprecated
public abstract JCoDestinationMonitor getDestinationMonitor(java.lang.String destinationID)
                                                     throws JCoRuntimeException
Deprecated. Might be removed in future versions without further notice. Use JCo.getDestinationMonitor(String) instead.

Do not use this method.

Parameters:
destinationID - the unique destination ID, for which the monitor should be returned
Returns:
the destination monitor instance for the destination
Throws:
JCoRuntimeException - in case of issues while getting and creating the destination monitor

getRepositoryDestinationMonitor

@Deprecated
public abstract JCoDestinationMonitor getRepositoryDestinationMonitor(java.lang.String destinationID)
                                                               throws JCoRuntimeException
Deprecated. Might be removed in future versions without further notice. Use JCo.getRepositoryDestinationMonitor(String) instead.

Do not use this method.

Parameters:
destinationID - the unique destination ID for which the monitor for the repository destination should be returned
Returns:
the destination monitor instance for the repository destination
Throws:
JCoRuntimeException - in case of issues while getting and creating the destination monitor

getDestination

public static JCoDestination getDestination(java.lang.String destinationName)
                                     throws JCoException
Call this method to get an instance of a destination, on which you would like to execute a function module.

Parameters:
destinationName - the name of the destination, for which a JCoDestination instance shall be returned
Returns:
a JCoDestination that matches the destination name.
Throws:
JCoException - if the specified destination does not exist or could not be created

getDestination

public static JCoDestination getDestination(java.lang.String destinationName,
                                            java.lang.String scopeType)
                                     throws JCoException
Call this method to get an instance of a destination, on which you need to execute a function module. The scopeType parameter allows to assign all stateful operations done on this destination to a certain scope in runtime environments that differentiate between several scopes within a session. Whether the runtime environment really supports scopeTypes, depends on the session and/or scope management. Actually, it defines whether scopeTypes are actually needed, and will reflect that in the implementation of the SessionReferenceProvider. If scopeTypes are not supported the parameter scopeType will be ignored and you could always use the method getDestination(String destinationName). If scopeTypes are supported, the valid scopeTypes are defined by the session management of the runtime environment.

Parameters:
destinationName - the name of the destination for which a JCoDestination instance shall be returned
scopeType - the name of the scope to which the destination shall belong to
Returns:
a JCoDestination instance that matches the destination name
Throws:
JCoException - if the specified destination does not exist or could not be created
See Also:
SessionReferenceProvider


Copyright © 2008-2016 SAP SE. All Rights Reserved.