com.ibm.connector2.ims.ico

Class IMSConnectionSpec

  1. java.lang.Object
  2. extended bycom.ibm.connector2.ims.ico.IMSConnectionSpec
All implemented interfaces:
com.ibm.ims.ico.IMSICOProperties

  1. public class IMSConnectionSpec
  2. extends java.lang.Object
  3. implements com.ibm.ims.ico.IMSICOProperties
An IMSConnectionSpec instance is used by an application component to pass information to the getConnection method. One example of this is an application using component-managed EIS sign-on. In this case, the application uses an IMSConnectionSpec instance to pass security information such as user name, password and group name to be used for that connection.
        Connection connection = null;
        // Populate an IMSConnectionSpec object
        IMSConnectionSpec aCSpec = new IMSConnectionSpec();
        aCSpec.setUserName("myUserName");
        aCSpec.setPassword("myPassword");
        aCSpec.setGroupName("myGroupName");
        // Obtain a connection handle
        connection = connectionFactory.getConnection(aCSpec);
 

Another example is an application using a dedicated persistent socket connection to IMS Connect. In this case, the application uses an IMSConnectionSpec instance to provide the clientID to be used for the connection. This form is used, even when the application uses container-managed sign-on.

        Connection connection = null;
        // Populate an IMSConnectionSpec object
        IMSConnectionSpec aCSpec = new IMSConnectionSpec();
        aCSpec.setClientID("CLIENT01");
        // Obtain a connection handle
        connection = connectionFactory.getConnection(aCSpec);
 
See Also:
com.ibm.connector2.ims.ico.IMSConnectionFactory#getConnection(ConnectionSpec)

Field Summary

Modifier and Type Field and Description
  1. java.beans.PropertyChangeSupport
propertyChange
Property change support
Fields inherited from interface com.ibm.ims.ico.IMSICOProperties
COMMIT_THEN_SEND, DEFAULT_ALTCLIENTID_NAME, DEFAULT_CANCELTIMER, DEFAULT_CM0DEDICATED, DEFAULT_CM0RESPONSE, DEFAULT_COMMIT_MODE, DEFAULT_CONVID_HEX_ZEROES, DEFAULT_CONVID_STRING, DEFAULT_CURRENT_SEGMENT, DEFAULT_DATASTORE_NAME, DEFAULT_ENCRYPTYPE, DEFAULT_GROUPNAME, DEFAULT_HOSTNAME, DEFAULT_IGNORE_PURG_CALL, DEFAULT_IMSCONNNAME, DEFAULT_ISSSL, DEFAULT_KEYSTORENAME, DEFAULT_KEYSTOREPASSWD, DEFAULT_LTERM_NAME, DEFAULT_MAP_NAME, DEFAULT_PASSWORD, DEFAULT_PORTNUMBER, DEFAULT_REROUTE_NAME, DEFAULT_TRANSEXPIRATION, DEFAULT_TRUSTSTORENAME, DEFAULT_TRUSTSTOREPASSWD, DEFAULT_USECONVID, DEFAULT_USERNAME, ENCRYPTYPE_0, ENCRYPTYPE_1, ENCRYPTYPE_2, IBM_SSL_CERT_TYPE, MAX_ALTCLIENTIDNAME, MAX_CIPHER_ARRAY, MAX_CLIENTID, MAX_CONVID_STRING, MAX_DATASTORENAME, MAX_GROUPNAME, MAX_IMSCONNNAME, MAX_LTERMNAME, MAX_MAPNAME, MAX_PASSWORD, MAX_REROUTENAME, MAX_SSLSTOREPASSWORD, MAX_USERNAME, MODE_ACK_TEXT, MODE_COMMIT_TEXT, MODE_END_CONVERSATION_TEXT, MODE_FORGET_TEXT, MODE_NACK_TEXT, MODE_PREPARE_TEXT, MODE_RECEIVE_ASYNCOUTPUT_AUTO_TEXT, MODE_RECEIVE_ASYNCOUTPUT_SINGLE_NOWAIT_TEXT, MODE_RECEIVE_ASYNCOUTPUT_SINGLE_WAIT_TEXT, MODE_RECEIVE_ASYNCOUTPUT_TEXT, MODE_RECEIVE_TEXT, MODE_RECOVER_TEXT, MODE_ROLLBACK_TEXT, MODE_SEND_ONLY_TEXT, MODE_SEND_RECEIVE_TEXT, MODE_SYNCCAL_RESPONSE_TEXT, SEND_THEN_COMMIT, SSL_PROVIDER, SSL_STORE_TYPE_JCE4758RACFKS, SSL_STORE_TYPE_JCERACFKS, SSL_STORE_TYPE_JKS, SUN_SSL_CERT_TYPE, SYNC_LEVEL_CONFIRM, SYNC_LEVEL_NONE, SYNC_LEVEL_SYNCPT

Constructor Summary

Constructor and Description
IMSConnectionSpec()
Creates an IMSConnectionSpec instance.

Method Summary

Modifier and Type Method and Description
  1. void
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.
  1. void
addPropertyChangeListener(java.lang.String propertyName,java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for a property.
  1. boolean
equals(java.lang.Object other)
Determines if the passed instance is equal to this IMSConnectionSpec instance.
  1. void
firePropertyChange(java.beans.PropertyChangeEvent evt)
The firePropertyChange method was generated to support the propertyChange field.
  1. void
firePropertyChange(java.lang.String propertyName,java.lang.Object oldValue,java.lang.Object newValue)
The firePropertyChange method was generated to support the propertyChange field.
  1. java.lang.String
getClientID()
Returns the value of the clientID property.
  1. java.lang.String
getGroupName()
Returns the value of the groupName property.
  1. java.lang.String
getPassword()
Returns the value of the password property.
  1. java.lang.String
getPasswordPhrase()
Returns the value of the password phrase property.
  1. java.beans.PropertyChangeSupport
getPropertyChange()
Accessor for the propertyChange field.
  1. java.lang.String
getUserName()
Returns the value of the userName property.
  1. int
hashCode()
Returns a hash code representation of the user name, password, and group name.
  1. void
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.
  1. void
removePropertyChangeListener(java.lang.String propertyName,java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener for a specific property.
  1. void
setClientID(java.lang.String newClientID)
Sets the value of the clientID property.
  1. void
setGroupName(java.lang.String newGroupName)
Sets the value of the groupName property.
  1. void
setPassword(java.lang.String newPassword)
Sets the value of the password property.
  1. void
setPasswordPhrase(java.lang.String newPasswordPhrase)
Sets the value of the password phrase property.
  1. void
setUserName(java.lang.String newUserName)
Sets the value of the userName property.
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

propertyChange

  1. public transient java.beans.PropertyChangeSupport propertyChange
Property change support

Constructor Detail

IMSConnectionSpec

  1. public IMSConnectionSpec()
Creates an IMSConnectionSpec instance.

Method Detail

addPropertyChangeListener

  1. public void addPropertyChangeListener( java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.
Parameters:
listener - The PropertyChangeListener to be added.

addPropertyChangeListener

  1. public void addPropertyChangeListener( java.lang.String propertyName,
  2. java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for a property.
Parameters:
listener - The PropertyChangeListener to be added.
propertyName - The name of the property to listen on.

equals

  1. public boolean equals(java.lang.Object other)
Determines if the passed instance is equal to this IMSConnectionSpec instance.
Overrides:
equals in class java.lang.Object
Returns:
boolean A value of true is returned if the instances are equivalent; false otherwise.

firePropertyChange

  1. public void firePropertyChange( java.beans.PropertyChangeEvent evt)
The firePropertyChange method was generated to support the propertyChange field.

firePropertyChange

  1. public void firePropertyChange( java.lang.String propertyName,
  2. java.lang.Object oldValue,
  3. java.lang.Object newValue)
The firePropertyChange method was generated to support the propertyChange field.

getClientID

  1. public final java.lang.String getClientID( )
Returns the value of the clientID property.
Returns:
The clientID value.
See Also:

getGroupName

  1. public final java.lang.String getGroupName( )
Returns the value of the groupName property.
Returns:
The groupName value.
See Also:

getPassword

  1. public final java.lang.String getPassword( )
Returns the value of the password property.
Returns:
The password value.
See Also:

getPropertyChange

  1. public java.beans.PropertyChangeSupport getPropertyChange( )
Accessor for the propertyChange field.

getUserName

  1. public final java.lang.String getUserName( )
Returns the value of the userName property.
Returns:
The userName value.
See Also:

hashCode

  1. public int hashCode()
Returns a hash code representation of the user name, password, and group name.
Overrides:
hashCode in class java.lang.Object
Returns:
int The hash code representation.

removePropertyChangeListener

  1. public void removePropertyChangeListener( java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.
Parameters:
listener - The PropertyChangeListener to be removed.

removePropertyChangeListener

  1. public void removePropertyChangeListener( java.lang.String propertyName,
  2. java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener for a specific property.
Parameters:
propertyName - The name of the property that was listened on.
listener - The PropertyChangeListener to be removed.

setClientID

  1. public void setClientID(java.lang.String newClientID)
  2. throws javax.resource.ResourceException
Sets the value of the clientID property. A value for this property is provided when an application component is using a dedicated persistent socket connection to IMS Connect. The value identifies the client to which the socket connection is dedicated. A dedicated persistent socket connection can only be used for Commit Mode 0 interactions with interactionVerb SYNC_SEND_RECEIVE and SYNC_RECEIVE_ASYNCOUTPUT.
Parameters:
newClientID - The clientID value.
Throws:
javax.resource.ResourceException
See Also:

setGroupName

  1. public void setGroupName(java.lang.String newGroupName)
  2. throws javax.resource.ResourceException
Sets the value of the groupName property. If provided, this property will be used by IMS OTMA during authorization of the user.
Parameters:
newGroupName - The new groupName value.
Throws:
javax.resource.ResourceException - If newGroupName contains more than the maximum number of characters (8).
See Also:

setPassword

  1. public void setPassword(java.lang.String newPassword)
  2. throws javax.resource.ResourceException
Sets the value of the password property. This property contains the password to be used by the Security Access Facility (for example, RACF) to authenticate the user identified by the userName property.
Parameters:
newPassword - The new password value.
Throws:
javax.resource.ResourceException - If newPassword contains more than the maximum number of characters (8).
See Also:

setUserName

  1. public void setUserName(java.lang.String newUserName)
  2. throws javax.resource.ResourceException
Sets the value of the userName property. This property contains the user name to be authenticated by the Security Access Facility (for example, RACF).
Parameters:
newUserName - The new userName value.
Throws:
javax.resource.ResourceException - If newUserName contains more than the maximum number of characters (8).
See Also:

setPasswordPhrase

  1. public void setPasswordPhrase(java.lang.String newPasswordPhrase)
  2. throws javax.resource.ResourceException
Sets the value of the password phrase property. This property contains the password phrase to be used by the Security Access Facility (for example, RACF) to authenticate the user identified by the userName property.
Parameters:
newPasswordPhrase - The new password value.
Throws:
javax.resource.ResourceException - If newPasswordPhrase contains more than the maximum number of characters (100).
See Also:

getPasswordPhrase

  1. public java.lang.String getPasswordPhrase( )
Returns the value of the password phrase property.
Returns:
The password phrase value.
See Also: