Class Hierarchy All Classes All Fields and Methods

Class com.ibm.connector2.ims.ico.IMSConnectionSpec

java.lang.Object
   |
   +----com.ibm.connector2.ims.ico.IMSConnectionSpec

public class IMSConnectionSpec
extends Object

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);
 

Field Index
Field Description
propertyChange Property change support
Constructor Index
Constructor Description
IMSConnectionSpec() Creates an IMSConnectionSpec instance.
Method Index
Method Description
void addPropertyChangeListener(PropertyChangeListener) Adds a PropertyChangeListener for all the properties.
void addPropertyChangeListener(String, PropertyChangeListener) Adds a PropertyChangeListener for a property.
boolean equals(Object) Determines if the passed instance is equal to this IMSConnectionSpec instance.
void firePropertyChange(PropertyChangeEvent) The firePropertyChange method was generated to support the propertyChange field.
void firePropertyChange(String, Object, Object) The firePropertyChange method was generated to support the propertyChange field.
String getClientID() Returns the value of the clientID property.
String getGroupName() Returns the value of the groupName property.
String getPassword() Returns the value of the password property.
PropertyChangeSupport getPropertyChange() Accessor for the propertyChange field.
String getUserName() Returns the value of the userName property.
int hashCode() Returns a hash code representation of the user name, password, and group name.
void removePropertyChangeListener(PropertyChangeListener) Removes a PropertyChangeListener from the listener list.
void removePropertyChangeListener(String, PropertyChangeListener) Removes a PropertyChangeListener for a specific property.
void setClientID(String) Sets the value of the clientID property.
void setGroupName(String) Sets the value of the groupName property.
void setPassword(String) Sets the value of the password property.
void setUserName(String) Sets the value of the userName property.

Fields

propertyChange

public transient java.beans.PropertyChangeSupport propertyChange

Property change support

Constructors

IMSConnectionSpec

public IMSConnectionSpec() 

Creates an IMSConnectionSpec instance.

Methods

addPropertyChangeListener

public synchronized void addPropertyChangeListener(PropertyChangeListener listener) 

Adds a PropertyChangeListener for all the properties.

addPropertyChangeListener

public synchronized void addPropertyChangeListener(String propertyName,
                                                   PropertyChangeListener listener) 

Adds a PropertyChangeListener for a property.

equals

public boolean equals(Object other) 

Determines if the passed instance is equal to this IMSConnectionSpec instance.

firePropertyChange

public void firePropertyChange(PropertyChangeEvent evt) 

The firePropertyChange method was generated to support the propertyChange field.

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue) 

The firePropertyChange method was generated to support the propertyChange field.

getClientID

public final String getClientID() 

Returns the value of the clientID property.

getGroupName

public final String getGroupName() 

Returns the value of the groupName property.

getPassword

public final String getPassword() 

Returns the value of the password property.

getPropertyChange

public PropertyChangeSupport getPropertyChange() 

Accessor for the propertyChange field.

getUserName

public final String getUserName() 

Returns the value of the userName property.

hashCode

public int hashCode() 

Returns a hash code representation of the user name, password, and group name.

removePropertyChangeListener

public synchronized void removePropertyChangeListener(PropertyChangeListener listener) 

Removes a PropertyChangeListener from the listener list.

removePropertyChangeListener

public synchronized void removePropertyChangeListener(String propertyName,
                                                      PropertyChangeListener listener) 

Removes a PropertyChangeListener for a specific property.

setClientID

public void setClientID(String newClientID) 

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.

setGroupName

public void setGroupName(String newGroupName) throws ResourceException

Sets the value of the groupName property. If provided, this property will be used by IMS OTMA during authorization of the user.

setPassword

public void setPassword(String newPassword) throws 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.

setUserName

public void setUserName(String newUserName) throws 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).

Class Hierarchy All Classes All Fields and Methods