com.ibm.websphere.xs.ra
Class XSConnectionSpec

java.lang.Object
  com.ibm.websphere.xs.ra.XSConnectionSpec

All Implemented Interfaces:

Cloneable, ConnectionSpec

public final class XSConnectionSpec
extends Object
implements ConnectionSpec, Cloneable

The ConnectionSpec for retrieving XSConnections from an XSConnectionFactory

Since:

8.5, XC10

See Also:

XSConnectionFactory

Constructor Summary

XSConnectionSpec()
Creates a default XSCOnnectionSpec instance.

Method Summary

Object	clone()
boolean	equals(Object obj)
CredentialGenerator	getCredentialGenerator() Returns the CredentialGenerator object for this client security for the connection.
ObjectGrid	getLocalObjectGrid() Return any local object grid instance used for the connection.
String	getObjectGridName() Returns the object grid name for the connection.
int	hashCode()
boolean	isBeginNoWriteThrough() Returns flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.
boolean	isMultiPartitionSupportEnabled() Retrieve boolean flag indicating whether this Session transaction can perform write operations to multiple partitions.
void	setBeginNoWriteThrough(boolean beginNoWriteThrough) Set the boolean flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.
void	setCredentialGenerator(CredentialGenerator credGen) Sets the CredentialGenerator object for the client security for the connection.
void	setLocalObjectGrid(ObjectGrid instance) Sets a local ObjectGrid instance to be used for connections.
void	setMultiPartitionSupportEnabled(boolean mpt) Set the boolean flag indicating that the Session transaction can perform write operations to a multiple partitions.
void	setObjectGridName(String objectGridName) Sets the object grid name to be used for the connection.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XSConnectionSpec

public XSConnectionSpec()

Creates a default XSCOnnectionSpec instance.

Method Detail

isBeginNoWriteThrough

public boolean isBeginNoWriteThrough()

Returns flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.

Returns:

flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.

setBeginNoWriteThrough

public void setBeginNoWriteThrough(boolean beginNoWriteThrough)

Set the boolean flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.

Parameters:

beginNoWriteThrough -

See Also:

Session.begin(), Session.beginNoWriteThrough()

getObjectGridName

public String getObjectGridName()

Returns the object grid name for the connection.

Returns:

object grid name

setObjectGridName

public void setObjectGridName(String objectGridName)

Sets the object grid name to be used for the connection.

Parameters:

objectGridName - object grid name to be used for the connection

getLocalObjectGrid

public ObjectGrid getLocalObjectGrid()

Return any local object grid instance used for the connection.

Returns:

null if the connection retrieves its ObjectGrid instance normally from the physical connection. Set if the connection spec overrides the normal behavior.

setLocalObjectGrid

public void setLocalObjectGrid(ObjectGrid instance)

Sets a local ObjectGrid instance to be used for connections. The local ObjectGrid instance overrides the standard behavior and allows a physical connection to be used with a specific local object grid.

Parameters:

instance -

getCredentialGenerator

public CredentialGenerator getCredentialGenerator()

Returns the CredentialGenerator object for this client security for the connection.

Returns:

the argument that was passed to the setCredGen(CredentialGenerator) method of this object or null if setCredGen was not previously called for this object.

setCredentialGenerator

public void setCredentialGenerator(CredentialGenerator credGen)

Sets the CredentialGenerator object for the client security for the connection.

Parameters:

credGen - a CredentialGenerator object

See Also:

CredentialGenerator

setMultiPartitionSupportEnabled

public void setMultiPartitionSupportEnabled(boolean mpt)

Set the boolean flag indicating that the Session transaction can perform write operations to a multiple partitions.

Parameters:

mpt -

isMultiPartitionSupportEnabled

public boolean isMultiPartitionSupportEnabled()

Retrieve boolean flag indicating whether this Session transaction can perform write operations to multiple partitions.

Returns:

Flag indicating Session transaction can perform write operations to multiple partitions.

clone

public Object clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object