IBM WebSphere® DataPower® XC10 Appliance
Release 2.5 Client API Specification

com.ibm.websphere.xs.ra
Class XSConnectionSpec

java.lang.Object
  extended by 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()
          Retrieve the local object grid instance used for the connection, if set.
 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()
          Answers true if the Session will have the Session.getTxCommitProtocol() set to Session.TxCommitProtocol.TWOPHASE.
 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 mptEnabled)
          Set to true to retrieve a connection with a Session that has the Session.getTxCommitProtocol() set to Session.TxCommitProtocol.TWOPHASE.
 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()
Retrieve the local object grid instance used for the connection, if set.

Returns:
null if the connection retrieves its ObjectGrid instance normally from the physical connection, or non-null if setLocalObjectGrid(ObjectGrid) was specified.
Since:
8.6

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 ObjectGrid instance, such as a shard.

Parameters:
instance - the local ObjectGrid instance.
Since:
8.6

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 mptEnabled)
Set to true to retrieve a connection with a Session that has the Session.getTxCommitProtocol() set to Session.TxCommitProtocol.TWOPHASE.

Parameters:
mptEnabled - set to true if the Session should be configured to write to multiple partitions.
Since:
8.6

isMultiPartitionSupportEnabled

public boolean isMultiPartitionSupportEnabled()
Answers true if the Session will have the Session.getTxCommitProtocol() set to Session.TxCommitProtocol.TWOPHASE.

Returns:
true if the Session is capable of writing to multiple partitions.
Since:
8.6

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

IBM WebSphere® DataPower® XC10 Appliance
Release 2.5 Client API Specification

© Copyright International Business Machines Corp 2005,2013. All rights reserved.