com.sap.conn.jco.ext
Interface DestinationDataProvider


public interface DestinationDataProvider

The JCo framework defines the DestinationDataProvider interface to retrieve the destination configuration that must be implemented by infrastructure components. At runtime JCo will use the provided implementation to get the destination configuration that is stored and managed elsewhere and not by the application using the JCo (separation of concerns). For example, if the destination configuration is stored on an LDAP server the instance method getProperties of the interface DestinationDataProvider needs to get the relevant configuration data from the LDAP server. Applications using these destinations (JCoDestination), i.e. want to execute function modules existing in an ABAP system, can rely on the fact that these data is managed elsewhere and retrieve the data. It is not the responsibility of the business application logic to manage the destination parameters. A business application should only use destinations that encapsulate these parameters.

Example CustomDestinationDataProvider demonstrates a simple implementation of this interface and how to register the instance implementing this interface at JCo runtime.

Note:

Destination configuration

In most scenarios the destination configuration will consists of the properties of the following groups

The minimum configuration contains user the logon properties and the physical connection configuration, i.e. at least this configuration data has to be provided.

The configuration data is divided to into the following groups:

a) Authentication type
Destination with an explicitly configured user that is used no matter which user is running the application using the JCo.
Destination with the current user. This may be used in an application server scenario. In this case the current user being logged on to the application server and his password or SSO ticket are used.
b) User logon properties
SAP client and language
User or user alias with password
SSO ticket or X.509 certificate
External identification user logon data and type
c) Configuration of the physical connection
Direct connection to an SAP application server instance
SAP application server host and system number
Load balancing connection to a group of SAP application servers via a message server
SAP message server host and either message server service/port or the SAP system ID plus an optional logon group name of SAP application servers
Direct connection to a registered RFC server program
SAP gateway host and gateway service/port and the registered RFC server program ID
If the SAP system is behind an SAP router, the SAP router string can be used.
To avoid lookups in the etc/services file you may define an SAP message server port for logon load balanced configuration. If no port number for the message server is defined in the configuration data the etc/services file needs to be maintained.
e) SNC configuration
SNC mode has to be set to 1, if secure communication is required
If you need to define other SNC properties, look here for details security in details
f) destination pool configuration
Maximum number of connections that can be created by the destination and kept open for reuse,
waiting time, if all connections are in use. JCo waits the specified waiting time for connections released by other threads
g) repository configuration
can be empty - the destination itself will be used for repository calls,
a destination, whose repository will be used for repository calls,
repository user and password, which will be used for repository connections.
Below is the list of all supported properties:
destination authentication information
jco.destination.auth_typeauthentication type - configured user or current user
user logon properties
jco.client.client SAP client
jco.client.user Logon user
jco.client.alias_user Logon user alias
jco.client.passwd Logon password
jco.client.lang Logon language
jco.client.mysapsso2 SAP Cookie Version 2 as logon ticket
jco.client.x509cert X.509 certificate as logon ticket
jco.client.extid_data External identification user logon data
jco.client.extid_type Type of the external identification user logon data
connection configuration
jco.client.type Connection type (optional)
jco.client.ashost SAP application server host
jco.client.sysnr SAP system number
jco.client.mshost SAP message server host
jco.client.msserv SAP message server service or port number (optional)
jco.client.r3name System ID of the SAP system, the so-called SID
jco.client.group Logon group name of SAP application servers (optional, default is PUBLIC)
jco.client.tpname Registered RFC server program ID
jco.client.gwhost SAP gateway host
jco.client.gwserv SAP gateway service or port number
jco.client.saprouter SAP router string to use for networks being protected by a firewall
trace configuration
jco.client.trace Enable/disable RFC trace (0 or 1)
jco.client.cpic_trace Enable/disable CPIC trace (-1 [take over environment value <CPIC_TRACE>], 0 no trace, 1,2,3 different trace levels)
special parameters
jco.client.lcheck Enable/disable logon check at open time (1 - enable [default] or 0 - disable)
jco.client.use_sapgui Start a SAP GUI and associate with the connection (0 - do not start [default], 1 - start GUI, 2 - start GUI and hide if not used)
jco.client.codepage Initial logon codepage in SAP notation
jco.client.pcs Initial logon codepage type (1 - non-unicode or 2 - unicode enabled, optional)
jco.client.delta Enable/disable table parameter delta management (1 - enable [default] or 0 - disable)
jco.client.getsso2 Get/don't get an SSO ticket after logon (1 or 0)
jco.client.deny_initial_passworddeny usage of initial passwords (0 [default] or 1)
destination pool configuration
jco.destination.peak_limit Maximum number of active connections that can be created for a destination simultaneously
jco.destination.pool_capacity Maximum number of idle connections kept open by the destination. A value of 0 has the effect that there is no connection pooling, i.e. connections will be closed after each request.
jco.destination.expiration_time Time in ms after that the connections hold by the internal pool can be closed
jco.destination.expiration_check_periodInterval in ms with which the timeout checker thread checks the connections in the pool for expiration
jco.destination.max_get_client_time Max time in ms to wait for a connection, if the max allowed number of connections is allocated by the application
SNC configuration
jco.client.snc_mode Secure network connection (SNC) mode, 0 (off) or 1 (on)
jco.client.snc_partnernameSNC partner, e.g. p:CN=R3, O=XYZ-INC, C=EN
jco.client.snc_qop SNC level of security, 1 to 9
jco.client.snc_myname SNC name. (optional - overrides the default SNC name)
jco.client.snc_lib Path to library which provides SNC service
jco.client.snc_sso Turn on/off SSO of SNC mechanism. If set to 0 fall back to user/password credentials instead. Valid values are 1 (yes, default) and 0 (no).
repository configuration
jco.destination.repository_destinationSpecifies which destination should be used for repository queries.
jco.destination.repository.user Optional: If repository destination is not set, and this property is set, it will be used as user for repository queries. This allows using a different user for repository lookups and restrict the permissions accordingly.
jco.destination.repository.passwd The password for a repository user. Mandatory, if a repository user should be used.
jco.destination.repository.snc_mode Optional: If SNC is used for this destination, it is possible to turn it off for repository connections, if this property is set to 0. Defaults to the value of jco.client.snc_mode
jco.destination.one_roundtrip_repository1 forces the usage of RFC_METADATA_GET in ABAP System, 0 deactivates it. If the property is not set, the destination will initially do a remote call to check whether RFC_METADATA_GET is available. In case it is available, it will use it.
Note:

Configuration of destination pool and connection pooling

Each destination is associated with a connection factory and, if the pooling feature is used, with a connection pool.
Initially the destination pool is empty. JCo runtime does not preallocate connections. The first connection will be created if the first call is sent. The property peak_limit describes how many connections can be created simultaneously, if applications allocate connections (either executes a remote call or for a stateful call sequence) in different sessions at the same time.
After peak_limit connections are allocated (in peak_limit sessions), the next session will wait for maximum max_get_client_time ms until a different session releases a connection (either finishes the remote call or ends the stateful call sequence). In case the waiting session does not get any connection during the max_get_client_time ms, the function request will be aborted with a JCoException with the key JCO_ERROR_RESOURCE.
The connections that are no longer used by applications are put back to the internal destination pool. There are at most pool_capacity connections kept opened by the pool. Further connections (peak_limit-pool_capacity) will be closed immediately after usage. The pooled connections (open connection in the pool) are marked as expired if they are not used during the expiration_time ms. The expired connections will be closed by a timeout checker thread, that executes the check every expiration_check_period ms.


Field Summary
static java.lang.String JCO_ALIAS_USER
          Logon user alias, can be used instead of logon user.
static java.lang.String JCO_ASHOST
          SAP ABAP application server host, mandatory for a direct application server instance connection.
static java.lang.String JCO_AUTH_TYPE
          Authentication type used by the destination.
static java.lang.String JCO_AUTH_TYPE_CONFIGURED_USER
          Value to use for the property JCO_AUTH_TYPE.
static java.lang.String JCO_AUTH_TYPE_CURRENT_USER
          Value to use for the property JCO_AUTH_TYPE.
static java.lang.String JCO_CLIENT
          SAP client, mandatory logon parameter.
static java.lang.String JCO_CODEPAGE
          Additional logon parameter to define the codepage that will be used to convert the logon parameters.
static java.lang.String JCO_CPIC_TRACE
          Enable/disable CPIC trace [0..3].
static java.lang.String JCO_DELTA
          Use the table delta management for reducing the amount of data being sent via the network, especially if dealing with big RFC table parameters.
static java.lang.String JCO_DENY_INITIAL_PASSWORD
          If set to 1, using initial passwords will lead to an exception (default=0).
static java.lang.String JCO_DEST
          For internal purposes only.
static java.lang.String JCO_EXPIRATION_PERIOD
          Period in ms after that the destination checks the released connections for expiration.
static java.lang.String JCO_EXPIRATION_TIME
          Time in ms after that a free connections hold internally by the destination can be closed.
static java.lang.String JCO_EXTID_DATA
          External identification user logon data.
static java.lang.String JCO_EXTID_TYPE
          Type of the external identification user logon data.
static java.lang.String JCO_GETSSO2
          Order a SSO ticket after logon, the obtained ticket is available in the destination attributes.
static java.lang.String JCO_GROUP
          Logon group of the logon load balanced connections, which is identifying a set of SAP application servers (optional, default is PUBLIC)
static java.lang.String JCO_GWHOST
          SAP gateway host to use for the connection.
static java.lang.String JCO_GWSERV
          SAP gateway service or port number, should be specified when using JCO_GWHOST.
static java.lang.String JCO_LANG
          Logon language, if not defined the default user language is used.
static java.lang.String JCO_LCHECK
          Postpone the authentication until the first call.
static java.lang.String JCO_MAX_GET_TIME
          Max time in ms to wait for a connection, if the max allowed number of connections is allocated by the application.
static java.lang.String JCO_MSHOST
          SAP message server host, mandatory property for a logon load balanced connection.
static java.lang.String JCO_MSSERV
          SAP message server service name or port number.
static java.lang.String JCO_MYSAPSSO2
          SAP Cookie Version 2 as logon ticket for SSO based authentication.
static java.lang.String JCO_PASSWD
          Logon password, logon parameter for password based authentication.
static java.lang.String JCO_PCS
          Additional logon parameter to define the codepage type of the SAP System, 1 - non-unicode, 2 - unicode enabled.
static java.lang.String JCO_PEAK_LIMIT
          Maximum number of active connections that can be created for a destination simultaneously.
static java.lang.String JCO_POOL_CAPACITY
          Maximum number of idle connections kept open by the destination.
static java.lang.String JCO_R3NAME
          System ID of the SAP system, the so-called SID.
static java.lang.String JCO_REPOSITORY_DEST
          Specifies which destination should be used as repository, i.e.
static java.lang.String JCO_REPOSITORY_PASSWD
          The password for a repository user.
static java.lang.String JCO_REPOSITORY_ROUNDTRIP_OPTIMIZATION
          Enable the usage of RFC_METADATA_GET API, which is providing repository data in one single roundtrip.
static java.lang.String JCO_REPOSITORY_SNC
          Optional: If SNC is used for this destination, it is possible to turn it off for repository connections, if this property is set to 0.
static java.lang.String JCO_REPOSITORY_USER
          If repository destination is not set, and this property is set, it will be used as user for repository calls.
static java.lang.String JCO_SAPROUTER
          SAP Router string for connection to systems behind a SAP Router.
static java.lang.String JCO_SNC_LIBRARY
          Path to library which provides SNC service.
static java.lang.String JCO_SNC_MODE
          Secure network connection (SNC) mode, 0 (off) or 1 (on).
static java.lang.String JCO_SNC_MYNAME
          Own SNC name.
static java.lang.String JCO_SNC_PARTNERNAME
          SNC partner, e.g.
static java.lang.String JCO_SNC_QOP
          SNC level of security, the quality of protection ranges from 1 to 9.
static java.lang.String JCO_SNC_SSO
          When connecting via SNC, the SNC identity is typically used for authenticating the caller.
static java.lang.String JCO_SYSNR
          System number of the SAP ABAP application server, mandatory for a direct application server instance connection.
static java.lang.String JCO_TPHOST
          External RFC server program host.
static java.lang.String JCO_TPNAME
          Registered RFC server program ID.
static java.lang.String JCO_TRACE
          Enable/disable RFC trace (0 or 1).
static java.lang.String JCO_TYPE
          The connection type.
static java.lang.String JCO_USE_SAPGUI
          Use a visible, hidden, or do not use SAP GUI.
static java.lang.String JCO_USER
          Logon user, logon parameter for password based authentication.
static java.lang.String JCO_USER_ID
          Deprecated. Will be removed in future versions without further notice. As of JCo 3.0.10 this property has become obsolete and is no longer needed.
static java.lang.String JCO_X509CERT
          X509 certificate for certificate based authentication.
 
Method Summary
 java.util.Properties getDestinationProperties(java.lang.String destinationName)
          getDestinationProperties should return a properties object that contains a subset of the supported properties mentioned above representing the configuration of the given destination in your destination configuration repository.
 void setDestinationDataEventListener(DestinationDataEventListener eventListener)
          This method sets a DestinationDataEventListener implemented by JCo that processes the fired events within the JCo runtime.
 boolean supportsEvents()
          Returns true if the implementation can support DestinationDataEvents that allow a better integration into the JCo runtime management.
 

Field Detail

JCO_AUTH_TYPE

static final java.lang.String JCO_AUTH_TYPE
Authentication type used by the destination. Known types are Note:This property is optional, default value is CONFIGURED_USER

See Also:
Constant Field Values

JCO_AUTH_TYPE_CONFIGURED_USER

static final java.lang.String JCO_AUTH_TYPE_CONFIGURED_USER
Value to use for the property JCO_AUTH_TYPE.

See Also:
Constant Field Values

JCO_AUTH_TYPE_CURRENT_USER

static final java.lang.String JCO_AUTH_TYPE_CURRENT_USER
Value to use for the property JCO_AUTH_TYPE.

See Also:
Constant Field Values

JCO_USER_ID

static final java.lang.String JCO_USER_ID
Deprecated. Will be removed in future versions without further notice. As of JCo 3.0.10 this property has become obsolete and is no longer needed.
User identity which was only used by the JCo runtime locally.

See Also:
Constant Field Values

JCO_CLIENT

static final java.lang.String JCO_CLIENT
SAP client, mandatory logon parameter.

See Also:
Constant Field Values

JCO_USER

static final java.lang.String JCO_USER
Logon user, logon parameter for password based authentication.

See Also:
Constant Field Values

JCO_ALIAS_USER

static final java.lang.String JCO_ALIAS_USER
Logon user alias, can be used instead of logon user.

See Also:
Constant Field Values

JCO_PASSWD

static final java.lang.String JCO_PASSWD
Logon password, logon parameter for password based authentication.

See Also:
Constant Field Values

JCO_LANG

static final java.lang.String JCO_LANG
Logon language, if not defined the default user language is used.

See Also:
Constant Field Values

JCO_CODEPAGE

static final java.lang.String JCO_CODEPAGE
Additional logon parameter to define the codepage that will be used to convert the logon parameters. Use in special cases only.

See Also:
Constant Field Values

JCO_PCS

static final java.lang.String JCO_PCS
Additional logon parameter to define the codepage type of the SAP System, 1 - non-unicode, 2 - unicode enabled. Use in special cases only.

See Also:
Constant Field Values

JCO_ASHOST

static final java.lang.String JCO_ASHOST
SAP ABAP application server host, mandatory for a direct application server instance connection.

See Also:
Constant Field Values

JCO_SYSNR

static final java.lang.String JCO_SYSNR
System number of the SAP ABAP application server, mandatory for a direct application server instance connection.

See Also:
Constant Field Values

JCO_MSHOST

static final java.lang.String JCO_MSHOST
SAP message server host, mandatory property for a logon load balanced connection.

See Also:
Constant Field Values

JCO_MSSERV

static final java.lang.String JCO_MSSERV
SAP message server service name or port number. For logon load balanced connections either the SAP message server service or the SAP system ID needs to be specified. In order to resolve the service name sapms<SID> a lookup in etc/services is performed by the network layer of the operating system. If using port numbers instead of symbolic service names, no lookups are performed and no additional entries are needed.

See Also:
Constant Field Values

JCO_R3NAME

static final java.lang.String JCO_R3NAME
System ID of the SAP system, the so-called SID. For logon load balanced connections either the SAP system ID or the SAP message server service needs to be specified. If no SAP message server service is specified, sapms<SID> will be automatically set as service name, which needs to be resolved by the network layer of the operating system.

See Also:
Constant Field Values

JCO_GROUP

static final java.lang.String JCO_GROUP
Logon group of the logon load balanced connections, which is identifying a set of SAP application servers (optional, default is PUBLIC)

See Also:
Constant Field Values

JCO_SAPROUTER

static final java.lang.String JCO_SAPROUTER
SAP Router string for connection to systems behind a SAP Router. SAP Router string contains the chain of SAP Routers and its port numbers and has the form:
(/H/<host>[/S/<port>])+

See Also:
Constant Field Values

JCO_MYSAPSSO2

static final java.lang.String JCO_MYSAPSSO2
SAP Cookie Version 2 as logon ticket for SSO based authentication.

See Also:
Constant Field Values

JCO_GETSSO2

static final java.lang.String JCO_GETSSO2
Order a SSO ticket after logon, the obtained ticket is available in the destination attributes.

See Also:
Constant Field Values

JCO_X509CERT

static final java.lang.String JCO_X509CERT
X509 certificate for certificate based authentication.

See Also:
Constant Field Values

JCO_EXTID_DATA

static final java.lang.String JCO_EXTID_DATA
External identification user logon data. Use in conjunction with JCO_EXTID_TYPE. Its format depends on the external ID type. The mapping to the actual logon user has to be defined in the AS ABAP system table VUSREXTID.
Note: This is an old logon mechanism and should no longer be used.

Since:
JCo 3.0.9
See Also:
Constant Field Values

JCO_EXTID_TYPE

static final java.lang.String JCO_EXTID_TYPE
Type of the external identification user logon data. Use in conjunction with JCO_EXTID_DATA. Possible values are for example "NT" for an NT Domain User (NTLM), "MP" for a Microsoft .NET Passport UID (PUID), "ID" for ID data from a trusted RFC system, or "DN" for a Distinguished Name (DN) of a Certificate (X.500).
Note: This is an old logon mechanism and should no longer be used.

Since:
JCo 3.0.9
See Also:
Constant Field Values

JCO_LCHECK

static final java.lang.String JCO_LCHECK
Postpone the authentication until the first call. The default value is 1 (enable). Use in special cases only.

See Also:
Constant Field Values

JCO_DELTA

static final java.lang.String JCO_DELTA
Use the table delta management for reducing the amount of data being sent via the network, especially if dealing with big RFC table parameters. The default value is 1 and enables the feature, which means that only appended/deleted/updated table rows are transferred back to the caller. A value of 0 disables the feature and means that always the whole table parameter is sent back. This destination property is only relevant if the 'jco.delta_management' RFC protocol feature is not generally turned off. Use in special cases only.

See Also:
JCo.setProperty(String, String), Constant Field Values

JCO_SNC_PARTNERNAME

static final java.lang.String JCO_SNC_PARTNERNAME
SNC partner, e.g. p:CN=R3, O=XYZ-INC, C=EN

See Also:
Constant Field Values

JCO_SNC_QOP

static final java.lang.String JCO_SNC_QOP
SNC level of security, the quality of protection ranges from 1 to 9.

See Also:
Constant Field Values

JCO_SNC_MYNAME

static final java.lang.String JCO_SNC_MYNAME
Own SNC name. Overrides environment settings

See Also:
Constant Field Values

JCO_SNC_MODE

static final java.lang.String JCO_SNC_MODE
Secure network connection (SNC) mode, 0 (off) or 1 (on).

See Also:
Constant Field Values

JCO_SNC_SSO

static final java.lang.String JCO_SNC_SSO
When connecting via SNC, the SNC identity is typically used for authenticating the caller. If it is required to override this default behavior, then this property can be set to 0, so that user/password information can be used for authenticating the caller, but the line is still encrypted. The default value is 1, which means to make use of the SSO behavior of SNC.

Since:
JCo 3.0.9
See Also:
Constant Field Values

JCO_SNC_LIBRARY

static final java.lang.String JCO_SNC_LIBRARY
Path to library which provides SNC service.

See Also:
Constant Field Values

JCO_DEST

static final java.lang.String JCO_DEST
For internal purposes only.

See Also:
Constant Field Values

JCO_PEAK_LIMIT

static final java.lang.String JCO_PEAK_LIMIT
Maximum number of active connections that can be created for a destination simultaneously. A value of 0 allows an unlimited number of active connections, otherwise if the value is less than the value of jco.destination.pool_capacity, it will be automatically increased to this value. Default setting is the value of jco.destination.pool_capacity, or in case of jco.destination.pool_capacity not being specified as well, the default is 0 (unlimited).

See Also:
Constant Field Values

JCO_POOL_CAPACITY

static final java.lang.String JCO_POOL_CAPACITY
Maximum number of idle connections kept open by the destination. A value of 0 has the effect that there is no connection pooling (default=1)

See Also:
Constant Field Values

JCO_EXPIRATION_TIME

static final java.lang.String JCO_EXPIRATION_TIME
Time in ms after that a free connections hold internally by the destination can be closed.

See Also:
Constant Field Values

JCO_EXPIRATION_PERIOD

static final java.lang.String JCO_EXPIRATION_PERIOD
Period in ms after that the destination checks the released connections for expiration.

See Also:
Constant Field Values

JCO_MAX_GET_TIME

static final java.lang.String JCO_MAX_GET_TIME
Max time in ms to wait for a connection, if the max allowed number of connections is allocated by the application.

See Also:
Constant Field Values

JCO_REPOSITORY_DEST

static final java.lang.String JCO_REPOSITORY_DEST
Specifies which destination should be used as repository, i.e. use this destination's repository.

See Also:
Constant Field Values

JCO_REPOSITORY_USER

static final java.lang.String JCO_REPOSITORY_USER
If repository destination is not set, and this property is set, it will be used as user for repository calls. This allows using a different user for repository lookups.

See Also:
Constant Field Values

JCO_REPOSITORY_PASSWD

static final java.lang.String JCO_REPOSITORY_PASSWD
The password for a repository user. Mandatory, if a repository user should be used.

See Also:
Constant Field Values

JCO_REPOSITORY_SNC

static final java.lang.String JCO_REPOSITORY_SNC
Optional: If SNC is used for this destination, it is possible to turn it off for repository connections, if this property is set to 0. Default setting is the value of jco.client.snc_mode. For special cases only.

See Also:
Constant Field Values

JCO_CPIC_TRACE

static final java.lang.String JCO_CPIC_TRACE
Enable/disable CPIC trace [0..3].

See Also:
Constant Field Values

JCO_TRACE

static final java.lang.String JCO_TRACE
Enable/disable RFC trace (0 or 1).

See Also:
Constant Field Values

JCO_GWHOST

static final java.lang.String JCO_GWHOST
SAP gateway host to use for the connection. If not specified the gateway on the application server host is used by default.

See Also:
Constant Field Values

JCO_GWSERV

static final java.lang.String JCO_GWSERV
SAP gateway service or port number, should be specified when using JCO_GWHOST. If not specified the port of the gateway on the application server is used. In order to resolve the service names sapgw<NN> or sapgw<NN>s a lookup in etc/services is performed by the network layer of the operating system. If using port numbers instead of symbolic service names, no lookups are performed and no additional entries are needed.

See Also:
Constant Field Values

JCO_TPHOST

static final java.lang.String JCO_TPHOST
External RFC server program host. This property is not supported in all runtime environments.

See Also:
Constant Field Values

JCO_TPNAME

static final java.lang.String JCO_TPNAME
Registered RFC server program ID.

See Also:
Constant Field Values

JCO_TYPE

static final java.lang.String JCO_TYPE
The connection type. Should not be specified and will be determined and set automatically according to the other specified logon properties.
Valid values are:
  3 - ABAP system with unspecified logon method
  A - ABAP system with direct application server host logon
  B - ABAP system with message server driven load balanced logon
  E - External RFC server program
  R - Registered RFC server program

See Also:
Constant Field Values

JCO_USE_SAPGUI

static final java.lang.String JCO_USE_SAPGUI
Use a visible, hidden, or do not use SAP GUI.

See Also:
Constant Field Values

JCO_DENY_INITIAL_PASSWORD

static final java.lang.String JCO_DENY_INITIAL_PASSWORD
If set to 1, using initial passwords will lead to an exception (default=0).

See Also:
Constant Field Values

JCO_REPOSITORY_ROUNDTRIP_OPTIMIZATION

static final java.lang.String JCO_REPOSITORY_ROUNDTRIP_OPTIMIZATION
Enable the usage of RFC_METADATA_GET API, which is providing repository data in one single roundtrip.

1 forces the usage of RFC_METADATA_GET in ABAP System, 0 deactivates it. If the property is not set, the destination will initially do a remote call to check whether RFC_METADATA_GET is available. In case it is available, it will use it.

Note: If the repository is already initializated, for example because it is used by some other destination, this property does not have any effect. Generally, this property is related to the ABAP System, and should have the same value on all destinations pointing to the same ABAP System. See note 1456826 for SAP AS ABAP system prerequisites.

See Also:
Constant Field Values
Method Detail

getDestinationProperties

java.util.Properties getDestinationProperties(java.lang.String destinationName)
getDestinationProperties should return a properties object that contains a subset of the supported properties mentioned above representing the configuration of the given destination in your destination configuration repository. null means that the destination is not available. In that case JCoException with key JCO_ERROR_RESOURCE will be thrown. The implementation may throw DataProviderException in order to signal severe issues in an existing configuration or some other internal error, like a wrong setup. As consequence JCoDestinationManager. getDestination() method throws JCoRuntimerException with the appropriate key. By other exceptions JCo runtime assume that the destination was not found and generates JCoException with key JCO_ERROR_RESOURCE.

Parameters:
destinationName - the name of the destination for which the provider should return the properties
Returns:
Properties for the destination or null if the destination was not found

supportsEvents

boolean supportsEvents()
Returns true if the implementation can support DestinationDataEvents that allow a better integration into the JCo runtime management. If the implementation cannot support the events it should return false. If you're not sure about the ability that your DestinationDataProvider can guarantee to fire all events you can return false to be on the safe side.

If the implementation can support DestinationDataEvents, JCo runtime sets a DestinationDataEventListener implemented by JCo.

Returns:
whether the implementation supports DestinationDataEvents completely
See Also:
setDestinationDataEventListener(DestinationDataEventListener)

setDestinationDataEventListener

void setDestinationDataEventListener(DestinationDataEventListener eventListener)
This method sets a DestinationDataEventListener implemented by JCo that processes the fired events within the JCo runtime.
The JCo runtime will register only a single DestinationDataEventListener instance.

Parameters:
eventListener - the DestinationDataEventListener to which configuration events need to be fired


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