com.sap.mw.jco.jra

Interface SAPConnectionFactory

All Superinterfaces:

ConnectionFactory, ConnectionSpecFactory, InteractionSpecFactory, Referenceable, Serializable

public interface SAPConnectionFactory
extends ConnectionFactory, ConnectionSpecFactory, InteractionSpecFactory

This interface extension comprises several SAP extensions for SAP Java Resource Adapter. For details see inherited interfaces. The ConnectionFactory object returned from lookup also implements this interface. So the cast on SAPConnectionSpecFactory will allow the application developer to use methods defined in this interface. Usage of this interface requires referencing the SAPJRA from your application to compile and to runtime. How to reference SAPJRA is described in documentation to SAPJRA.

SAP API Classification:

This interface is intended to be used only and may not be implemented by client code.

Nested Class Summary

static class	SAPConnectionFactory.BgRfcUnitState
static class	SAPConnectionFactory.BgRfcUnitType
static class	SAPConnectionFactory.CustomDestinationProperty

Field Summary

static String	UNIT_ATTRIBUTE_CLIENT
static String	UNIT_ATTRIBUTE_COMMIT_CHECK
static String	UNIT_ATTRIBUTE_KERNEL_TRACE
static String	UNIT_ATTRIBUTE_LOCK
static String	UNIT_ATTRIBUTE_PROGRAM_NAME
static String	UNIT_ATTRIBUTE_UNIT_HISTORY
static String	UNIT_ATTRIBUTE_USER

Method Summary

Connection	getConnection(String destinationName) Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.
Connection	getConnection(String destinationName, Map<SAPConnectionFactory.CustomDestinationProperty,String> customProperties) Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.
RecordFactory	getRecordFactory(String destinationName) Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.
SAPConnectionFactory.BgRfcUnitState	getUnitState(String unitID, SAPConnectionFactory.BgRfcUnitType type) Returns the state of the unit with the given ID.

Methods inherited from interface javax.resource.cci.ConnectionFactory

getConnection, getConnection, getMetaData, getRecordFactory

Methods inherited from interface javax.resource.Referenceable

setReference

Methods inherited from interface javax.naming.Referenceable

getReference

Methods inherited from interface com.sap.mw.jco.jra.ConnectionSpecFactory

createConnectionSpec, createConnectionSpec, createConnectionSpec, createConnectionSpec, createConnectionSpec

Methods inherited from interface com.sap.mw.jco.jra.InteractionSpecFactory

createInteractionSpec, createInteractionSpec, createInteractionSpec, createInteractionSpec, createUnitInteractionSpec, createUnitInteractionSpec, createUnitMappedRecord, getID

Field Detail

UNIT_ATTRIBUTE_CLIENT

static final String UNIT_ATTRIBUTE_CLIENT

See Also:

Constant Field Values

UNIT_ATTRIBUTE_KERNEL_TRACE

static final String UNIT_ATTRIBUTE_KERNEL_TRACE

See Also:

Constant Field Values

UNIT_ATTRIBUTE_UNIT_HISTORY

static final String UNIT_ATTRIBUTE_UNIT_HISTORY

See Also:

Constant Field Values

UNIT_ATTRIBUTE_LOCK

static final String UNIT_ATTRIBUTE_LOCK

See Also:

Constant Field Values

UNIT_ATTRIBUTE_COMMIT_CHECK

static final String UNIT_ATTRIBUTE_COMMIT_CHECK

See Also:

Constant Field Values

UNIT_ATTRIBUTE_USER

static final String UNIT_ATTRIBUTE_USER

See Also:

Constant Field Values

UNIT_ATTRIBUTE_PROGRAM_NAME

static final String UNIT_ATTRIBUTE_PROGRAM_NAME

See Also:

Constant Field Values

Method Detail

getConnection

@Deprecated
Connection getConnection(String destinationName)
                         throws ResourceException

Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.

Gets a connection to an EIS instance using the configured destination. Here all the necessary configuration - especially connection pooling - is made within Destination Service. No explicit configuration of Resource Adapter or Connection Factory has to be done Important to note that here connection pooling management is not done by Connector Container, but by JCo ! With implementing this method there will be a JCo Client connection obtained and after call was made it is given back to JCo (which put it back to JCo connection pool)

Parameters:

destinationName - the RFC destination name as configured in the destinations service

Returns:

Connection instance

Throws:

ResourceException - Failed to get a connection to the EIS instance.

getConnection

@Deprecated
Connection getConnection(String destinationName,
                                    Map<SAPConnectionFactory.CustomDestinationProperty,String> customProperties)
                         throws ResourceException

Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.

Gets a connection to an EIS instance using the configured destination. Here all the necessary configuration - especially connection pooling - is made within Destination Service. No explicit configuration of Resource Adapter or Connection Factory has to be done Important to note that here connection pooling management is not done by Connector Container, but by JCo ! With implementing this method there will be a JCo Client connection obtained and after call was made it is given back to JCo (which put it back to JCo connection pool)

Parameters:

destinationName - the RFC destination name as configured in the destinations service

customProperties - to pass additional properties for logon

Returns:

Connection instance

Throws:

ResourceException - Failed to get a connection to the EIS instance.

getRecordFactory

@Deprecated
RecordFactory getRecordFactory(String destinationName)
                               throws ResourceException

Deprecated. Not part of the official JCA specification. Will not be supported any longer. Do not use.

Gets a RecordFactory instance based on the passed destination. The RecordFactory is used for creation of generic Record instances. The MetaData of the created Record instances will be retrieved from the backend on that the passed destination points.

Parameters:

destinationName - the RFC destination name as configured in the destinations service

Returns:

RecordFactory RecordFactory instance

Throws:

ResourceException - Failed to create a RecordFactory

getUnitState

SAPConnectionFactory.BgRfcUnitState getUnitState(String unitID,
                                                 SAPConnectionFactory.BgRfcUnitType type)
                                                 throws ResourceException

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:

unitID - the unitID of the bgRFC call

type - the BgRfcUnitType of the bgRFC call

Throws:

ResourceException - thrown if something went wrong during the confirmation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] ENGFACADE	[sap.com] tc/bl/jra/api	api	BC-JAS