com.sap.mw.jco.jra

Interface InteractionSpecFactory

All Known Subinterfaces:

SAPConnectionFactory

public interface InteractionSpecFactory

This API extention may be used by applications for SAP tRFC protocol.

Method Summary

InteractionSpec	createInteractionSpec() Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call).
InteractionSpec	createInteractionSpec(boolean createTid, String queueName) Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call).
InteractionSpec	createInteractionSpec(String tid) Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call).
InteractionSpec	createInteractionSpec(String tid, String queueName) Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call).
InteractionSpec	createUnitInteractionSpec(Set<String> queueNames, Properties unitAttributes)
InteractionSpec	createUnitInteractionSpec(String unitID, Set<String> queueNames, Properties unitAttributes)
MappedRecord	createUnitMappedRecord(List<MappedRecord> requests)
String	getID(InteractionSpec iSpec)

Method Detail

createInteractionSpec

InteractionSpec createInteractionSpec()

Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call). If an the call execute(InteractionSpec ispec, Record input, Record output) failed, then it should be repeated again with the same InteractionSpec instance. The InteractionSpec object allows using tRFC protocol over SAP JCA implementation. The overwritten method InteractionSpec.toString() returns tid. The ConnectionFactory object returned from lookup also implements this interface. So the cast on InteractionSpecFactory 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.

Returns:

InteractionSpec instance

createInteractionSpec

InteractionSpec createInteractionSpec(String tid)
                                      throws ResourceException

Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call). If an the call execute(InteractionSpec ispec, Record input, Record output) failed, then it should be repeated again with the same InteractionSpec instance. The InteractionSpec object allows using tRFC protocol over SAP JCA implementation. The overwritten method InteractionSpec.toString() returns tid.

Parameters:

tid - is a valid transaction Id that identifies tRFC call

Returns:

ConnectionSpec instance

Throws:

ResourceException - for invalid configuration conditions

createInteractionSpec

InteractionSpec createInteractionSpec(String tid,
                                      String queueName)
                                      throws ResourceException

Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call). If an the call execute(InteractionSpec ispec, Record input, Record output) failed, then it should be repeated again with the same InteractionSpec instance. The InteractionSpec object allows using tRFC protocol over SAP JCA implementation. The overwritten method InteractionSpec.toString() returns tid.

Parameters:

tid - is a valid transaction Id that identifies tRFC call

queueName - is a Queue Name needed for qRFC

Returns:

ConnectionSpec instance

Throws:

ResourceException - for invalid configuration conditions

createInteractionSpec

InteractionSpec createInteractionSpec(boolean createTid,
                                      String queueName)
                                      throws ResourceException

Creates InteractionSpec instance for SAP Java Resource Adapter that can be passed in Interaction.execute() method as a ticket identifying transaction (SAP tRFC call). If an the call execute(InteractionSpec ispec, Record input, Record output) failed, then it should be repeated again with the same InteractionSpec instance. The InteractionSpec object allows using tRFC protocol over SAP JCA implementation. The overwritten method InteractionSpec.toString() returns tid.

Parameters:

createTid - on true generates TID that can be retrieved by toString() method. On false throws an exception

queueName - is a Queue Name needed for qRFC

Returns:

ConnectionSpec instance

Throws:

ResourceException - for invalid configuration conditions

NotSupportedException - if for first paremeter the false is passed

createUnitInteractionSpec

InteractionSpec createUnitInteractionSpec(Set<String> queueNames,
                                          Properties unitAttributes)

createUnitInteractionSpec

InteractionSpec createUnitInteractionSpec(String unitID,
                                          Set<String> queueNames,
                                          Properties unitAttributes)

createUnitMappedRecord

MappedRecord createUnitMappedRecord(List<MappedRecord> requests)

getID

String getID(InteractionSpec iSpec)
             throws NotSupportedException

Throws:

NotSupportedException

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