com.sap.aii.af.lib.ra.cci

Interface XIConnectionSpec

All Superinterfaces:

ConnectionSpec

public interface XIConnectionSpec
extends ConnectionSpec

XiConnectionSpec allows to pass connection selection parameters from the XI AF to the resource adapter when a connection must be allocated. Whereas the properties userName and password are JCA 1.0 standard, the XI AF XiConnectionSpec defines more XI AF specific selection criterias which MAY be used by the resource adapter as e.g. the channel ID. The channel ID was determined by the XI RA mdb before and propagated to the module processor chain.

Method Summary

String	getChannelId() getChannelId() returns the XI channel ID for which a CCI connection was (is to be) requested.
String	getPassword() getPassword() returns the credential (password) used by the principal that requests (has requested) the corresponding CCI connection.
String	getUserName() getUserName() returns the principal (user name) that requests (has requested) the corresponding CCI connection.
void	setChannelId(String channelId) setChannelId() sets the XI channel ID for which a CCI connection is requested.
void	setPassword(String password) setPassword() sets the credential (password) used by the principal that requests a corresponding CCI connection.
void	setUserName(String userName) setUserName() sets the principal (user name) that requests a corresponding CCI connection.

Method Detail

getUserName

String getUserName()

getUserName() returns the principal (user name) that requests (has requested) the corresponding CCI connection. Details see JCA specification chapter 7 and 8.

Returns:

String The user name

getPassword

String getPassword()

getPassword() returns the credential (password) used by the principal that requests (has requested) the corresponding CCI connection. Details see JCA specification chapter 7 and 8.

Returns:

String The password

getChannelId

String getChannelId()

getChannelId() returns the XI channel ID for which a CCI connection was (is to be) requested. For details of the XI AF channel concept see the XI 3.0 Adapter Framework Interfaces documentation.

Returns:

String The password

setUserName

void setUserName(String userName)

setUserName() sets the principal (user name) that requests a corresponding CCI connection. Details see JCA specification chapter 7 and 8.

Parameters:

userName - The user name

setPassword

void setPassword(String password)

setPassword() sets the credential (password) used by the principal that requests a corresponding CCI connection. Details see JCA specification chapter 7 and 8.

Parameters:

password - The password

setChannelId

void setChannelId(String channelId)

setChannelId() sets the XI channel ID for which a CCI connection is requested. For details of the XI AF channel concept see the XI 3.0 Adapter Framework Interfaces documentation.