com.sap.conn.jco
Interface JCoCustomDestination

All Superinterfaces:
JCoDestination

public interface JCoCustomDestination
extends JCoDestination

Customizable destination, which allows to set specific user logon data and SNC configuration. A JCoCustomDestination is useful, if the destination obtained from JCoDestinationManager does not contain logon information or if it is necessary or desired to set call specific logon information.
Example use case:
In your application (server), you have a user management component that allows mapping the user to a fitting ABAP system user so that the same identity is executing the requests in the ABAP system like in your Java environment.


Nested Class Summary
static interface JCoCustomDestination.SncConfigurationData
          SncConfigurationData allows change SNC configuration for a JCoCustomDestination.
static interface JCoCustomDestination.UserData
          UserData allows change the logon configuration data for a JCoCustomDestination.
 
Method Summary
 JCoCustomDestination.SncConfigurationData getSNCConfiguration()
          Returns the holder for properties of SNC configuration
 JCoCustomDestination.UserData getUserLogonData()
          Returns the holder for properties of user logon data
 void setCodepage(String codepage)
          The RFC communication negotiates the codepage to use with its communication partner.
 void setRepositoryDestination(JCoDestination destination)
          Sets the destination, whose repository will be used for metadata queries for this destination.
 void setTrace(boolean trace)
          Allows turning on/off trace on the fly
 void setUseSapGui(boolean useSapGui)
          Allows turning on/off the association of an SAP GUI with the used JCo connection on the fly
 
Methods inherited from interface com.sap.conn.jco.JCoDestination
changePassword, confirmFunctionUnit, confirmTID, createCustomDestination, createTID, getAliasUser, getApplicationServerHost, getAttributes, getClient, getDestinationID, getDestinationName, getExpirationCheckPeriod, getExpirationTime, getExternalIDData, getExternalIDType, getFunctionUnitState, getGatewayHost, getGatewayService, getLanguage, getLogonCheck, getLogonGroup, getMaxGetClientTime, getMessageServerHost, getMessageServerService, getMonitor, getPeakLimit, getPoolCapacity, getProperties, getR3Name, getRepository, getRepositoryDestinationMonitor, getRepositoryUser, getSAPRouterString, getSncLibrary, getSncMode, getSncMyName, getSncPartnerName, getSncQOP, getSystemNumber, getThroughput, getTPHost, getTPName, getType, getUser, isValid, ping, removeThroughput, setThroughput
 

Method Detail

setRepositoryDestination

void setRepositoryDestination(JCoDestination destination)
                              throws JCoException
Sets the destination, whose repository will be used for metadata queries for this destination. In case a JCoCustomDestination is passed, the destination it originates from will provide its repository.

Parameters:
destination - the destination to ask for the repository
Throws:
JCoException - if an exception occurs during the initialization of connections to the given destination
See Also:
JCoDestination.getRepository()

getSNCConfiguration

JCoCustomDestination.SncConfigurationData getSNCConfiguration()
Returns the holder for properties of SNC configuration

Returns:
SncConfigurationData

getUserLogonData

JCoCustomDestination.UserData getUserLogonData()
Returns the holder for properties of user logon data

Returns:
UserData

setTrace

void setTrace(boolean trace)
Allows turning on/off trace on the fly

Parameters:
trace - if set to true, trace will be turned on otherwise trace will be turned off
Since:
JCo 3.0.2

setCodepage

void setCodepage(String codepage)
The RFC communication negotiates the codepage to use with its communication partner. Nevertheless, it can be necessary, to use a different initial one, if the logon language is not fitting to it. In case the logon data is changed, it might be necessary to adjust the codepage as well.

Parameters:
codepage - the codepage to use for the initial request
Since:
JCo 3.0.2

setUseSapGui

void setUseSapGui(boolean useSapGui)
Allows turning on/off the association of an SAP GUI with the used JCo connection on the fly

Parameters:
useSapGui - if set to true, a GUI will be associated with the connection, otherwise not
Since:
JCo 3.0.5


Copyright © 2014 SAP. All Rights Reserved.