|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 that contains all necessary information for the JCo runtime 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.
Field Summary | |
---|---|
static java.lang.String |
BACK
The destination BACK is only available in JCo RFC server scenarios,
between the point in time when an RFC request is dispatched and the point
in time when the RFC response is returned. |
Method Summary | |
---|---|
void |
changePassword(java.lang.String oldPassword,
java.lang.String newPassword)
Allows changing the password in the back-end 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()
Returns a monitor instance describing the client connections that have been 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()
Returns 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 this destination. |
void |
setThroughput(JCoThroughput throughput)
Sets the throughput instance for measuring the RFC executions to this destination. |
Field Detail |
---|
static final java.lang.String BACK
BACK
is only available in JCo RFC server scenarios,
between the point in time when an RFC request is dispatched and the point
in time when the RFC response is returned. It represents the same RFC connection
that was used to transmit the request and will also be used to transmit the
corresponding response at the end. The destination BACK
can only be
used as a call-back destination for executing remote function modules at the RFC
client side without having to configure a destination explicitly. Use this name
to obtain the destination JCoDestination
instance via
JCoDestinationManager.getDestination(JCoDestination.BACK)
.
JCoDestinationManager.getDestination(String)
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getDestinationName()
java.lang.String getDestinationID()
char getType()
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 getApplicationServerHost()
DestinationDataProvider.JCO_ASHOST
java.lang.String getSAPRouterString()
DestinationDataProvider.JCO_SAPROUTER
java.lang.String getGatewayHost()
DestinationDataProvider.JCO_GWHOST
java.lang.String getGatewayService()
DestinationDataProvider.JCO_GWSERV
java.lang.String getSystemNumber()
DestinationDataProvider.JCO_SYSNR
java.lang.String getLogonGroup()
DestinationDataProvider.JCO_GROUP
java.lang.String getMessageServerHost()
DestinationDataProvider.JCO_MSHOST
java.lang.String getMessageServerService()
DestinationDataProvider.JCO_MSSERV
java.lang.String getR3Name()
DestinationDataProvider.JCO_R3NAME
java.lang.String getTPHost()
DestinationDataProvider.JCO_TPHOST
java.lang.String getTPName()
DestinationDataProvider.JCO_TPNAME
java.lang.String getSncLibrary()
DestinationDataProvider.JCO_SNC_LIBRARY
java.lang.String getSncMode()
DestinationDataProvider.JCO_SNC_MODE
java.lang.String getSncMyName()
DestinationDataProvider.JCO_SNC_MYNAME
java.lang.String getSncPartnerName()
DestinationDataProvider.JCO_SNC_PARTNERNAME
java.lang.String getSncQOP()
DestinationDataProvider.JCO_SNC_QOP
java.lang.String getSncSSO()
DestinationDataProvider.JCO_SNC_SSO
java.lang.String getAliasUser()
DestinationDataProvider.JCO_ALIAS_USER
java.lang.String getClient()
DestinationDataProvider.JCO_CLIENT
java.lang.String getLanguage()
DestinationDataProvider.JCO_LANG
java.lang.String getUser()
DestinationDataProvider.JCO_USER
java.lang.String getLogonCheck()
DestinationDataProvider.JCO_LCHECK
java.lang.String getExternalIDData()
DestinationDataProvider.JCO_EXTID_DATA
java.lang.String getExternalIDType()
DestinationDataProvider.JCO_EXTID_TYPE
int getPeakLimit()
DestinationDataProvider.JCO_PEAK_LIMIT
int getPoolCapacity()
DestinationDataProvider.JCO_POOL_CAPACITY
long getExpirationTime()
DestinationDataProvider.JCO_EXPIRATION_TIME
long getExpirationCheckPeriod()
DestinationDataProvider.JCO_EXPIRATION_PERIOD
long getMaxGetClientTime()
DestinationDataProvider.JCO_MAX_GET_TIME
java.util.Properties getProperties()
JCoAttributes getAttributes() throws JCoException
JCoException
- if an exception occurs during the initialization of the destinationJCoRepository getRepository() throws JCoException
JCoException
- if an exception occurs during the initialization of the destination
used by repository instanceDestinationDataProvider.JCO_REPOSITORY_DEST
java.lang.String getRepositoryUser()
DestinationDataProvider.JCO_REPOSITORY_USER
JCoCustomDestination createCustomDestination()
JCoCustomDestination.getUserLogonData()
,
JCoCustomDestination.getSNCConfiguration()
void confirmTID(java.lang.String tid) throws JCoException
tid
- the ID of the transaction to confirm
JCoException
- thrown if something went wrong during the confirmationjava.lang.String createTID() throws JCoException
JCoException
- thrown if something went wrong during the creationvoid confirmFunctionUnit(JCoUnitIdentifier unitIdentifier) throws JCoException
unitIdentifier
- the identifier of the function unit
JCoException
- thrown if something went wrong during the confirmationJCoFunctionUnitState getFunctionUnitState(JCoUnitIdentifier unitIdentifier) throws JCoException
unitIdentifier
- the identifier of the function unit
JCoException
- thrown if something went wrong during the confirmationvoid setThroughput(JCoThroughput throughput)
throughput
- the throughput instance for storing the performance dataJCoThroughput getThroughput()
void removeThroughput()
void ping() throws JCoException
JCoException
- thrown if something went wrong during the pingboolean isValid()
void changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws JCoException
oldPassword
- the old password of the usernewPassword
- the new password chosen for the user
JCoException
- thrown if something went wrong during the password changeJCoDestinationMonitor getMonitor() throws JCoRuntimeException
JCoRuntimeException
- in case of destination instance is already removed or was not
initialized properlyJCoDestinationMonitor getRepositoryDestinationMonitor()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |