com.sap.conn.jco
Interface JCoDestination

All Known Subinterfaces:
JCoCustomDestination

public interface JCoDestination

JCoDestination identifies a physical destination of a function call. It contains all required properties in order to connect to an SAP system.
Note: A JCoDestination is only a configuration instance containing all necessary information for JCo runtime how to create a connection. It does not create or hold any connections by itself. The JCo runtime creates connections and pools them if defined by the destination configuration.


Method Summary
 void changePassword(java.lang.String oldPassword, java.lang.String newPassword)
          Allows changing the password in the backend for the user associated with the destination.
 void confirmFunctionUnit(JCoUnitIdentifier unitIdentifier)
          Confirms that a bgRFC unit has been executed successfully
 void confirmTID(java.lang.String tid)
          Confirms that a transaction (tRFC/qRFC) has been executed successfully
 JCoCustomDestination createCustomDestination()
          creates a new instance of custom destination with default values set from the current destination.
It is possible to modify the user logon data on the customizable destination
 java.lang.String createTID()
          Creates a new transaction ID that can be used for tRFC/qRFC requests
 java.lang.String getAliasUser()
          Returns the alias of the logon user as specified in the destination properties.
 java.lang.String getApplicationServerHost()
          Returns the host name of the ABAP instance as specified in the destination properties.
 JCoAttributes getAttributes()
          Returns the attributes of the destination.
 java.lang.String getClient()
          Returns SAP client as specified in the destination properties.
 java.lang.String getDestinationID()
          Returns internal id of this destination instance.
 java.lang.String getDestinationName()
          Returns name of destination.
 long getExpirationCheckPeriod()
          Returns the time in ms, after which a checker will close the expired connections.
 long getExpirationTime()
          Returns the time in ms, after which a free connection, that is hold internally for the destination, is being regarded as expired and will be closed during next run of the expiration checker.
 java.lang.String getExternalIDData()
          Returns the external identification user logon data as specified in the destination properties.
 java.lang.String getExternalIDType()
          Returns the type of the external identification user logon data as specified in the destination properties.
 JCoFunctionUnitState getFunctionUnitState(JCoUnitIdentifier unitIdentifier)
          Returns the state of the unit with the given ID.
 java.lang.String getGatewayHost()
          Returns the gateway host as specified in the destination properties.
 java.lang.String getGatewayService()
          Returns the gateway service as specified in the destination properties.
 java.lang.String getLanguage()
          Returns the logon language as specified in the destination properties.
 java.lang.String getLogonCheck()
          Returns the logon check mode as specified in the destination properties.
 java.lang.String getLogonGroup()
          Returns the logon group as specified in the destination properties.
 long getMaxGetClientTime()
          Returns the max time in ms for the allocation of a connection to a destination in case if the peak limit is already reached.
 java.lang.String getMessageServerHost()
          Returns the SAP message server as specified in the destination properties.
 java.lang.String getMessageServerService()
          Returns the SAP message server port as specified in the destination properties.
 JCoDestinationMonitor getMonitor()
          Return a monitor instance describes the client connections created by the JCo runtime for this destination instance
 int getPeakLimit()
          Returns the maximum number of connections, that can be created for the destination simultaneously.
 int getPoolCapacity()
          Returns the maximum number of idle connections, that will be kept open in a pool.
 java.util.Properties getProperties()
          Returns the complete property set describing the destination.
 java.lang.String getR3Name()
          Returns the System ID of the SAP system as specified in the destination properties.
 JCoRepository getRepository()
          Returns a repository instance that contains metadata for this destination.
 JCoDestinationMonitor getRepositoryDestinationMonitor()
          Return a monitor instance describing the client connections that have been created by the JCo runtime for the repository queries done via this destination instance.
 java.lang.String getRepositoryUser()
          Returns the user that is used for communication when executing repository queries via this destination if there is no repository destination configured.
 java.lang.String getSAPRouterString()
          Returns the SAP router string as specified in the destination properties.
 java.lang.String getSncLibrary()
          Returns the path to SNC library as specified in the destination properties.
 java.lang.String getSncMode()
          Returns the SNC mode as specified in the destination properties.
 java.lang.String getSncMyName()
          Returns the own SNC name as specified in the destination properties.
 java.lang.String getSncPartnerName()
          Returns the SNC partner as specified in the destination properties.
 java.lang.String getSncQOP()
          Returns the SNC level of security as specified in the destination properties.
 java.lang.String getSncSSO()
          Returns the SNC SSO mode as specified in the destination properties.
 java.lang.String getSystemNumber()
          Returns the SAP system number as specified in the destination properties.
 JCoThroughput getThroughput()
          Returns the throughput instance
 java.lang.String getTPHost()
          Returns the host of external server program as specified in the destination properties.
 java.lang.String getTPName()
          Returns the Program ID of external server program as specified in the destination properties.
 char getType()
          Returns the type of the destination.
Possible types are:
3 - Destination to an ABAP system with unspecified logon method A - Destination to an ABAP system with direct application server host logon B - Destination to an ABAP system with message server driven load balanced logon E - Destination to an external RFC server program R - Destination to a registered RFC server program V - Destination to a VMC in-process ABAP stack
 java.lang.String getUser()
          Returns the logon user as specified in the destination properties.
 boolean isValid()
          Returns true if the corresponding destination configuration was neither changed nor removed, false otherwise.
 void ping()
          Executes a connection test for this destination
 void removeThroughput()
          Removes the throughput instance from the destination.
 void setThroughput(JCoThroughput throughput)
          sets the throughput instance to measure the call execute to this destination.
 

Method Detail

getDestinationName

java.lang.String getDestinationName()
Returns name of destination. Destination Name is a user defined non-unique name.

Returns:
String as destination name

getDestinationID

java.lang.String getDestinationID()
Returns internal id of this destination instance.

Returns:
String as destination id

getType

char getType()
Returns the type of the destination.
Possible types are:

Returns:
char type of the destination

getApplicationServerHost

java.lang.String getApplicationServerHost()
Returns the host name of the ABAP instance as specified in the destination properties. Returns null if this property was not set.

Returns:
host name of the ABAP instance
See Also:
DestinationDataProvider.JCO_ASHOST

getSAPRouterString

java.lang.String getSAPRouterString()
Returns the SAP router string as specified in the destination properties. Returns null if this property was not set.

Returns:
SAP router string
See Also:
DestinationDataProvider.JCO_SAPROUTER

getGatewayHost

java.lang.String getGatewayHost()
Returns the gateway host as specified in the destination properties. Returns null if this property was not set.

Returns:
Gateway host
See Also:
DestinationDataProvider.JCO_GWHOST

getGatewayService

java.lang.String getGatewayService()
Returns the gateway service as specified in the destination properties. Returns null if this property was not set.

Returns:
Gateway service
See Also:
DestinationDataProvider.JCO_GWSERV

getSystemNumber

java.lang.String getSystemNumber()
Returns the SAP system number as specified in the destination properties. Returns null if this property was not set.

Returns:
SAP system number
See Also:
DestinationDataProvider.JCO_SYSNR

getLogonGroup

java.lang.String getLogonGroup()
Returns the logon group as specified in the destination properties. Returns null if this property was not set.

Returns:
logon group
See Also:
DestinationDataProvider.JCO_GROUP

getMessageServerHost

java.lang.String getMessageServerHost()
Returns the SAP message server as specified in the destination properties. Returns null if this property was not set.

Returns:
SAP message server
See Also:
DestinationDataProvider.JCO_MSHOST

getMessageServerService

java.lang.String getMessageServerService()
Returns the SAP message server port as specified in the destination properties. Returns null if this property was not set.

Returns:
SAP message server port
See Also:
DestinationDataProvider.JCO_MSSERV

getR3Name

java.lang.String getR3Name()
Returns the System ID of the SAP system as specified in the destination properties. Returns null if this property was not set.

Returns:
System ID of the SAP system
See Also:
DestinationDataProvider.JCO_R3NAME

getTPHost

java.lang.String getTPHost()
Returns the host of external server program as specified in the destination properties. Returns null if this property was not set.

Returns:
Host of external server program
See Also:
DestinationDataProvider.JCO_TPHOST

getTPName

java.lang.String getTPName()
Returns the Program ID of external server program as specified in the destination properties. Returns null if this property was not set.

Returns:
Program ID of external server program
See Also:
DestinationDataProvider.JCO_TPNAME

getSncLibrary

java.lang.String getSncLibrary()
Returns the path to SNC library as specified in the destination properties. Returns null if this property was not set.

Returns:
path to SNC library
See Also:
DestinationDataProvider.JCO_SNC_LIBRARY

getSncMode

java.lang.String getSncMode()
Returns the SNC mode as specified in the destination properties. Returns null if this property was not set.

Returns:
SNC mode
See Also:
DestinationDataProvider.JCO_SNC_MODE

getSncMyName

java.lang.String getSncMyName()
Returns the own SNC name as specified in the destination properties. Returns null if this property was not set.

Returns:
own SNC name
See Also:
DestinationDataProvider.JCO_SNC_MYNAME

getSncPartnerName

java.lang.String getSncPartnerName()
Returns the SNC partner as specified in the destination properties. Returns null if this property was not set.

Returns:
SNC partner name
See Also:
DestinationDataProvider.JCO_SNC_PARTNERNAME

getSncQOP

java.lang.String getSncQOP()
Returns the SNC level of security as specified in the destination properties. Returns null if this property was not set.

Returns:
SNC level of security
See Also:
DestinationDataProvider.JCO_SNC_QOP

getSncSSO

java.lang.String getSncSSO()
Returns the SNC SSO mode as specified in the destination properties. Returns null if this property was not set. return SNC SSO mode

Since:
JCo 3.0.9
See Also:
DestinationDataProvider.JCO_SNC_SSO

getAliasUser

java.lang.String getAliasUser()
Returns the alias of the logon user as specified in the destination properties. Returns null if this property was not set.

Returns:
alias of the logon user
See Also:
DestinationDataProvider.JCO_ALIAS_USER

getClient

java.lang.String getClient()
Returns SAP client as specified in the destination properties. Returns null if this property was not set.

Returns:
SAP client
See Also:
DestinationDataProvider.JCO_CLIENT

getLanguage

java.lang.String getLanguage()
Returns the logon language as specified in the destination properties. Returns null if this property was not set.

Returns:
logon language
See Also:
DestinationDataProvider.JCO_LANG

getUser

java.lang.String getUser()
Returns the logon user as specified in the destination properties. Returns null if this property was not set.

Returns:
logon user
See Also:
DestinationDataProvider.JCO_USER

getLogonCheck

java.lang.String getLogonCheck()
Returns the logon check mode as specified in the destination properties. Returns null if this property was not set.

Returns:
logon check mode
See Also:
DestinationDataProvider.JCO_LCHECK

getExternalIDData

java.lang.String getExternalIDData()
Returns the external identification user logon data as specified in the destination properties. Returns null if this property was not set.

Returns:
external ID data
Since:
JCo 3.0.9
See Also:
DestinationDataProvider.JCO_EXTID_DATA

getExternalIDType

java.lang.String getExternalIDType()
Returns the type of the external identification user logon data as specified in the destination properties. Returns null if this property was not set.

Returns:
external ID type
Since:
JCo 3.0.9
See Also:
DestinationDataProvider.JCO_EXTID_TYPE

getPeakLimit

int getPeakLimit()
Returns the maximum number of connections, that can be created for the destination simultaneously. This value is always greater than or equal to pool capacity.

Returns:
maximum number of active connections
See Also:
DestinationDataProvider.JCO_PEAK_LIMIT

getPoolCapacity

int getPoolCapacity()
Returns the maximum number of idle connections, that will be kept open in a pool.
A value of 0 means that the connections will be closed immedeatly after being released, which has the effect that there is no connection pooling.

Returns:
maximum number of pooled connections
See Also:
DestinationDataProvider.JCO_POOL_CAPACITY

getExpirationTime

long getExpirationTime()
Returns the time in ms, after which a free connection, that is hold internally for the destination, is being regarded as expired and will be closed during next run of the expiration checker.
A value of 0 means that the connections will be closed immediately after release.

Returns:
expiration time
See Also:
DestinationDataProvider.JCO_EXPIRATION_TIME

getExpirationCheckPeriod

long getExpirationCheckPeriod()
Returns the time in ms, after which a checker will close the expired connections.

Returns:
the length of the check interval in ms
See Also:
DestinationDataProvider.JCO_EXPIRATION_PERIOD

getMaxGetClientTime

long getMaxGetClientTime()
Returns the max time in ms for the allocation of a connection to a destination in case if the peak limit is already reached.

Returns:
max wait time in ms
See Also:
DestinationDataProvider.JCO_MAX_GET_TIME

getProperties

java.util.Properties getProperties()
Returns the complete property set describing the destination.

Returns:
Properties object describing the destination.

getAttributes

JCoAttributes getAttributes()
                            throws JCoException
Returns the attributes of the destination. If the destination will be initialized and a connection will be created if necessary.

Returns:
destination attributes
Throws:
JCoException - if an exception occurs during the initialization of the destination

getRepository

JCoRepository getRepository()
                            throws JCoException
Returns a repository instance that contains metadata for this destination. The repository will use either this destination instance for remote queries or the destination specified by repository destination property

Returns:
JCoRepository instance
Throws:
JCoException - if an exception occurs during the initialization of the destination used by repository instance
See Also:
DestinationDataProvider.JCO_REPOSITORY_DEST

getRepositoryUser

java.lang.String getRepositoryUser()
Returns the user that is used for communication when executing repository queries via this destination if there is no repository destination configured.

Returns:
the user used for repository queries
See Also:
DestinationDataProvider.JCO_REPOSITORY_USER

createCustomDestination

JCoCustomDestination createCustomDestination()
creates a new instance of custom destination with default values set from the current destination.
It is possible to modify the user logon data on the customizable destination

Returns:
JCoCustomDestination a new instance of JCoCustomDestination
See Also:
JCoCustomDestination.getUserLogonData(), JCoCustomDestination.getSNCConfiguration()

confirmTID

void confirmTID(java.lang.String tid)
                throws JCoException
Confirms that a transaction (tRFC/qRFC) has been executed successfully

Parameters:
tid - the ID of the transaction to confirm
Throws:
JCoException - thrown if something went wrong during the confirmation

createTID

java.lang.String createTID()
                           throws JCoException
Creates a new transaction ID that can be used for tRFC/qRFC requests

Returns:
the newly created transaction ID as a string
Throws:
JCoException - thrown if something went wrong during the creation

confirmFunctionUnit

void confirmFunctionUnit(JCoUnitIdentifier unitIdentifier)
                         throws JCoException
Confirms that a bgRFC unit has been executed successfully

Parameters:
unitIdentifier - the identifier of the function unit
Throws:
JCoException - thrown if something went wrong during the confirmation

getFunctionUnitState

JCoFunctionUnitState getFunctionUnitState(JCoUnitIdentifier unitIdentifier)
                                          throws JCoException
Returns the state of the unit with the given ID. This API allows the client side to ask the server for the current state of a function unit. Usually this API will be used after failure on the client side, if the state information for particular units is missing.

Parameters:
unitIdentifier - the identifier of the function unit
Throws:
JCoException - thrown if something went wrong during the confirmation

setThroughput

void setThroughput(JCoThroughput throughput)
sets the throughput instance to measure the call execute to this destination. The previously defined throughput instance will be overwritten.

Parameters:
throughput -

getThroughput

JCoThroughput getThroughput()
Returns the throughput instance

Returns:
the throughput instance

removeThroughput

void removeThroughput()
Removes the throughput instance from the destination. The measuring will be deactivated.


ping

void ping()
          throws JCoException
Executes a connection test for this destination

Throws:
JCoException - thrown if something went wrong during the ping

isValid

boolean isValid()
Returns true if the corresponding destination configuration was neither changed nor removed, false otherwise.

Returns:
true if destination configuration was neither changed nor removed
Since:
JCo 3.0.7

changePassword

void changePassword(java.lang.String oldPassword,
                    java.lang.String newPassword)
                    throws JCoException
Allows changing the password in the backend for the user associated with the destination. Please note, that this won't change the configuration in the registered DestinationDataProvider. This needs to be adjusted separately!

Parameters:
oldPassword - the old password of the user
newPassword - the new password chosen for the user
Throws:
JCoException - thrown if something went wrong during the password change
Since:
JCo 3.0.6

getMonitor

JCoDestinationMonitor getMonitor()
                                 throws JCoRuntimeException
Return a monitor instance describes the client connections created by the JCo runtime for this destination instance

Returns:
a monitor instance
Throws:
JCoRuntimeException - in case of destination instance is already removed or was not initialized properly

getRepositoryDestinationMonitor

JCoDestinationMonitor getRepositoryDestinationMonitor()
Return a monitor instance describing the client connections that have been created by the JCo runtime for the repository queries done via this destination instance. This method may return null, if this destination has not been used for any metadata query.

Returns:
a monitor instance or null


Copyright © 2008-2014 SAP AG. All Rights Reserved.