com.ibm.connector2.ims.ico.inbound

Class IMSActivationSpec

  1. java.lang.Object
  2. extended byWBIActivationSpecWithXid
  3. extended bycom.ibm.connector2.ims.ico.inbound.IMSActivationSpec
All implemented interfaces:
com.ibm.ims.ico.IMSICOProperties, java.io.Serializable

  1. public class IMSActivationSpec
  2. extends WBIActivationSpecWithXid
  3. implements com.ibm.ims.ico.IMSICOProperties, java.io.Serializable
An IMSActivationSpec instance is used to configure the properties for inbound communication from IMS.

Field Summary

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
IMSActivationSpec()
The default constructor

Method Summary

Modifier and Type Method and Description
  1. void
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.
  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
getDataStoreName()
Returns the value of the DataStoreName property.
  1. java.lang.String
getGroupName()
Returns the groupName property value.
  1. java.lang.String
getHostName()
Returns the HostName property value.
  1. java.lang.String
getPassword()
Returns the Password property value.
  1. java.lang.String
getPasswordPhrase()
Returns the password phrase property value.
  1. java.lang.Integer
getPortNumber()
Returns the value of the PortNumber property.
  1. java.beans.PropertyChangeSupport
getPropertyChange()
Return a PropertyChangeSupport object to be used to maintain a property change listener list and fire property change events for the IMSActivationSpec object.
  1. java.lang.String
getQueueNames()
Returns the value of the QueueNames property.
  1. java.lang.Integer
getRetryInterval()
Returns the value of the retryInterval property of an IMSActivationSpec instance.
  1. java.lang.Integer
getRetryLimit()
Returns the value of the retryLimit property of an IMSActivationSpec instance.
  1. java.lang.Boolean
getSSLEnabled()
Returns the value of the SSLEnabled property.
  1. java.lang.String
getSSLEncryptionType()
Returns the value of the SSLEncryptionType property.
  1. java.lang.String
getSSLKeyStoreName()
Returns the value of the SSLKeyStoreName property.
  1. java.lang.String
getSSLKeyStorePassword()
Returns the value of the SSLKeyStorePassword property.
  1. java.lang.String
getSSLTrustStoreName()
Returns the value of the SSLTrustStoreName property.
  1. java.lang.String
getSSLTrustStorePassword()
Returns the value of the SSLTrustStorePassword property.
  1. java.lang.String
getUserName()
Returns the UserName property value.
  1. void
setDataStoreName(java.lang.String newDataStoreName)
Sets the value of the DataStoreName property of an IMSActivationSpec instance.
  1. void
setGroupName(java.lang.String groupName)
Sets the value of the GroupName property of an IMSActivationSpec instance.
  1. void
setHostName(java.lang.String hostName)
Sets the value of the HostName property of an IMSActivationSpec instance.
  1. void
setPassword(java.lang.String password)
Sets the value of the Password property of an IMSActivationSpec instance.
  1. void
setPasswordPhrase(java.lang.String password)
Sets the value of the password phrase property.
  1. void
setPortNumber(java.lang.Integer portNumber)
Sets the value of the PortNumber property of an IMSActivationSpec instance.
  1. void
setQueueNames(java.lang.String queueNames)
Sets the value of the QueueNames property on an IMSActivationSpec instance.
  1. void
setRetryInterval(java.lang.Integer interval)
Specifies the time delay before trying to restart the listener on IMS Connect.
  1. void
setRetryLimit(java.lang.Integer n)
Sets the value of the retryLimit property of an IMSActivationSpec instance.
  1. void
setSSLEnabled(java.lang.Boolean isSSL)
Sets the value of the SSLEnabled property of an IMSActivationSpec instance.
  1. void
setSSLEncryptionType(java.lang.String aEncrypType)
Sets the value of the SSLEncryptionType property of an IMSActivationSpec instance.
  1. void
setSSLKeyStoreName(java.lang.String aKeyStoreName)
Sets the value of the SSLKeyStoreName property of an IMSActivationSpec instance.
  1. void
setSSLKeyStorePassword(java.lang.String aKeyStorePasswd)
Sets the value of the SSLKeyStorePassword property of an IMSActivationSpec instance.
  1. void
setSSLTrustStoreName(java.lang.String aTrustStoreName)
Sets the value of the SSLTrustStoreName property of an IMSActivationSpec instance.
  1. void
setSSLTrustStorePassword(java.lang.String aTrustStorePasswd)
Sets the value of the SSLTrustStorePassword property of an IMSActivationSpec instance.
  1. void
setUserName(java.lang.String userName)
Sets the value of the UserName property of an IMSActivationSpec instance.
  1. void
validate()
Validates the configuration properties specified on the IMSActivationSpec instance to ensure they comply with documented constraints.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IMSActivationSpec

  1. public IMSActivationSpec()
The default constructor

Method Detail

getDataStoreName

  1. public java.lang.String getDataStoreName( )
Returns the value of the DataStoreName property.
Returns:
A string object containing the DataStoreName property value.
See Also:

setDataStoreName

  1. public void setDataStoreName(java.lang.String newDataStoreName)
Sets the value of the DataStoreName property of an IMSActivationSpec instance. This method is most likely used by a tool, possibly provided by the application server.
Parameters:
newDataStoreName - - A comma-delimited list of data store names. Each data store name in the list must match the ID parameter of the Datastore statement that is specified in the IMS Connect configuration member when IMS Connect is installed. It also serves as the XCF member name for IMS during internal XCF communications between IMS Connect and OTMA.
Throws:
javax.resource.ResourceException -
  • If the length of aDataStoreName is zero or greater than the maximum allowable length (8).
  • If value of aDataStoreName is null.

Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.

See Also:

getPortNumber

  1. public java.lang.Integer getPortNumber( )
Returns the value of the PortNumber property.
Returns:
The PortNumber property value.
See Also:

setPortNumber

  1. public void setPortNumber(java.lang.Integer portNumber)
Sets the value of the PortNumber property of an IMSActivationSpec instance. This method is most likely used by a tool, possibly provided by the application server.

This property applies to TCP/IP communication only.

Parameters:
portNumber - The new value for the PortNumber property. This property represents the number of a port used by the target IMS Connect for TCP/IP connections (sockets).
Throws:
javax.resource.ResourceException -
  • If aPortNumber is null.

Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.

See Also:

getQueueNames

  1. public java.lang.String getQueueNames( )
Returns the value of the QueueNames property.
Returns:
The QueueNames property value.
See Also:

setQueueNames

  1. public void setQueueNames(java.lang.String queueNames)
Sets the value of the QueueNames property on an IMSActivationSpec instance. QueueNames are a comma-delimited list of queues on which the IMS TM Resource Adapter will listen for messages from IMS. Each QueueName must be from 1-8 alphanumeric characters (A-Z, 0-9, @, #, $)
Parameters:
queueNames - The new value for the QueueNames property

getSSLEncryptionType

  1. public java.lang.String getSSLEncryptionType( )
Returns the value of the SSLEncryptionType property.
Returns:
A String object containing the SSLEncryptionType property value.
See Also:

getSSLEnabled

  1. public java.lang.Boolean getSSLEnabled( )
Returns the value of the SSLEnabled property.
Returns:
A Boolean object containing the SSLEnabled property value.
See Also:

getSSLKeyStoreName

  1. public java.lang.String getSSLKeyStoreName( )
Returns the value of the SSLKeyStoreName property.
Returns:
A String object containing the SSLKeyStoreName property value.
See Also:

getSSLKeyStorePassword

  1. public java.lang.String getSSLKeyStorePassword( )
Returns the value of the SSLKeyStorePassword property.
Returns:
A String object containing the SSLKeyStorePassword property value.
See Also:

getSSLTrustStoreName

  1. public java.lang.String getSSLTrustStoreName( )
Returns the value of the SSLTrustStoreName property.
Returns:
A String object containing the SSLTrustStoreName property value.
See Also:

getSSLTrustStorePassword

  1. public java.lang.String getSSLTrustStorePassword( )
Returns the value of the SSLTrustStorePassword property.
Returns:
A String object containing the SSLTrustStorePassword property value.
See Also:

setSSLEnabled

  1. public void setSSLEnabled(java.lang.Boolean isSSL)
Sets the value of the SSLEnabled property of an IMSActivationSpec instance. This method is most likely used by a tool, possibly provided by the application server.
Parameters:
isSSL - The new value for the SSLEnabled property. This property is only valid for TCP/IP connections. A value of true indicates that IMS Connector for Java will create an SSL socket connection to IMS Connect using the HostName and PortNumber specified in these connection properties. This port must be configured as an SSL port by IMS Connect. A value of false indicates that SSL sockets will not be used for connecting to the port specified in the Port Number property.

setSSLEncryptionType

  1. public void setSSLEncryptionType( java.lang.String aEncrypType)
  2. throws javax.resource.ResourceException
Sets the value of the SSLEncryptionType property of an IMSActivationSpec instance. This method is most likely used by a tool, such as WAS connection factory configuration.

This property applies to TCP/IP SSL communication only.

Parameters:
aEncrypType - The new value, strong or weak, for the SSLEncryptionType property. Strong and weak are related to the strength of the ciphers, that is, the key length. All those ciphers that can be used for export come under the weak category and the rest go into the strong category. By default, the encryption type is set to weak.
Throws:
javax.resource.ResourceException -
  • If value of SSLEncryptionType is a String other than "strong" or "weak".

Note: The tooling may ignore these exceptions, in which case a default value will be used and an exception will be thrown later.

See Also:

setSSLKeyStoreName

  1. public void setSSLKeyStoreName( java.lang.String aKeyStoreName)
  2. throws javax.resource.ResourceException
Sets the value of the SSLKeyStoreName property of an IMSActivationSpec instance. This method is most likely used by a tool, such as WAS connection factory configuration.

This property applies to TCP/IP SSL communication only.

Parameters:
aKeyStoreName - The new value for the SSLKeyStoreName property. This is the name (including its full file path) of the keystore. Private keys and their associated public key certificates are stored in password-protected databases called keystores. For convenience, Trusted certificates can also be stored in the keystore and the truststore property can either be empty or could point to the keystore file. An example of a keystore name is c:\keystore\MyKeystore.ks

Note: The file can have other file extensions; it does not have to be .ks.

Note: A value for SSLKeyStoreName is mandatory if the server (IMS Connect) has been configured to require client authentication. However, this cannot be determined at the time this set method is invoked.

Throws:
javax.resource.ResourceException -
  • If length of aKeyStoreName is 0.
  • If aKeyStoreName is null.

Note: The tooling may ignore these exceptions, in which case a default value will be used and an exception will be thrown later.

See Also:

setSSLTrustStoreName

  1. public void setSSLTrustStoreName( java.lang.String aTrustStoreName)
  2. throws javax.resource.ResourceException
Sets the value of the SSLTrustStoreName property of an IMSActivationSpec instance. This method is most likely used by a tool, such as WAS connection factory configuration.

This property applies to TCP/IP SSL communication only.

Parameters:
aTrustStoreName - The new value for the SSLTrustStoreName property. This is the full path and name of the location of the Keystore file containing security credentials; i.e., certificates . A value for SSLTrustStoreName is not mandatory, if a keystore is used. name (including its full file path) of the truststore. A truststore file is a key database file that contains public keys or certificates. For convenience, private keys can also be stored in the Truststore and the Keystore property can either be empty or could point to the Truststore file. An example of a truststore name is c:\keystore\MyTruststore.ks

Note: The file can have other file extensions; it does not have to be .ks.

Throws:
javax.resource.ResourceException -
  • If Length of aTrustStoreName is 0.
  • If aTrustStoreName is null.

Note: The tooling may ignore these exceptions, in which case a default value will be used and an exception will be thrown later.

See Also:

setSSLTrustStorePassword

  1. public void setSSLTrustStorePassword( java.lang.String aTrustStorePasswd)
  2. throws javax.resource.ResourceException
Sets the value of the SSLTrustStorePassword property of an IMSActivationSpec instance. This method is most likely used by a tool, such as WAS connection factory configuration.

This property applies to TCP/IP SSL communication only.

Parameters:
aTrustStorePasswd - The new value for the SSLTrustStorePassword property, the password for the truststore. A truststore file is a key database file that contains public keys.
Throws:
javax.resource.ResourceException -
  • If Length of aTrustStorePasswd is 0.
  • If aTrustStorePasswd is null.

Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.

See Also:

setSSLKeyStorePassword

  1. public void setSSLKeyStorePassword( java.lang.String aKeyStorePasswd)
  2. throws javax.resource.ResourceException
Sets the value of the SSLKeyStorePassword property of an IMSActivationSpec instance. This method is most likely used by a tool, possibly provided by the application server.

This property applies to TCP/IP SSL communication only.

Parameters:
aKeyStorePasswd - The new value for the SSLKeyStorePassword property, the password for the keystore. Private keys and their associated public key certificates are stored in password-protected databases called keystores.
Throws:
javax.resource.ResourceException -
  • If Length of aKeyStorePasswd is 0.
  • If aKeyStorePasswd is null.

Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.

See Also:

getHostName

  1. public java.lang.String getHostName( )
Returns the HostName property value.
Returns:
The HostName property value.
See Also:

setHostName

  1. public void setHostName(java.lang.String hostName)
Sets the value of the HostName property of an IMSActivationSpec instance.
Parameters:
hostName -

getGroupName

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

setGroupName

  1. public void setGroupName(java.lang.String groupName)
Sets the value of the GroupName property of an IMSActivationSpec instance.
Parameters:
groupName -

getPassword

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

setPassword

  1. public void setPassword(java.lang.String password)
Sets the value of the Password property of an IMSActivationSpec instance.
Parameters:
password -

getUserName

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

setRetryLimit

  1. public void setRetryLimit(java.lang.Integer n)
Sets the value of the retryLimit property of an IMSActivationSpec instance. This is the maximum number of times the IMS TM Resource Adapter will attempt to reconnect to IMS Connect if a connection is lost.

getRetryLimit

  1. public java.lang.Integer getRetryLimit( )
Returns the value of the retryLimit property of an IMSActivationSpec instance.

setRetryInterval

  1. public void setRetryInterval(java.lang.Integer interval)
Specifies the time delay before trying to restart the listener on IMS Connect. The value should be specified in milliseconds.

getRetryInterval

  1. public java.lang.Integer getRetryInterval( )
Returns the value of the retryInterval property of an IMSActivationSpec instance.

setUserName

  1. public void setUserName(java.lang.String userName)
Sets the value of the UserName property of an IMSActivationSpec instance. This method is most likely used by a tool, possibly provided by the application server.
Parameters:
userName - The new value for the UserName property. This value will be used if no UserName property is provided by the application component.
Throws:
javax.resource.ResourceException -
  • If the length of aUserName is greater than the maximum allowable length (8).

Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.

See Also:

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.

getPropertyChange

  1. public java.beans.PropertyChangeSupport getPropertyChange( )
Return a PropertyChangeSupport object to be used to maintain a property change listener list and fire property change events for the IMSActivationSpec object.

addPropertyChangeListener

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

validate

  1. public void validate()
  2. throws InvalidPropertyException
Validates the configuration properties specified on the IMSActivationSpec instance to ensure they comply with documented constraints.
Throws:
InvalidPropertyException - if one or more property values are invalid }
See Also:
javax.resource.spi.ActivationSpec#validate()

setPasswordPhrase

  1. public void setPasswordPhrase(java.lang.String password)
Sets the value of the password phrase property. This property contains the password phrase to be used by the Security Access Facility (RACF) to authenticate the user.
See Also:

getPasswordPhrase

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