Class IMSManagedConnectionFactory
- java.lang.Object
-
- com.ibm.connector2.ims.ico.IMSManagedConnectionFactory
-
- All Implemented Interfaces:
- com.ibm.ims.ico.IMSICOProperties, java.io.Serializable
public class IMSManagedConnectionFactory extends java.lang.Object implements com.ibm.ims.ico.IMSICOProperties, java.io.Serializable
An IMSManagedConnectionFactory instance is a factory for IMSConnectionFactory instances and IMSManagedConnection instances.In addition, an IMSManagedConnectionFactory supports connection pooling by providing methods for matching and creating connections.
In a managed environment, instances of IMSManagedConnectionFactory are created by using a deployment tool. Each instance is configured by the tool using a property set. A property set represents a specific configuration for creating connections to a specific EIS instance. In a non-managed environment, an application developer writes this code.
- See Also:
- Serialized Form
-
-
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_CONNPOOLENABLED, DEFAULT_CONVID_HEX_ZEROES, DEFAULT_CONVID_STRING, DEFAULT_CURRENT_SEGMENT, DEFAULT_DATASTORE_NAME, DEFAULT_ENCRYPTYPE, DEFAULT_GROUPNAME, DEFAULT_HOSTNAME, DEFAULT_IDLEDURATION, DEFAULT_IGNORE_PURG_CALL, DEFAULT_IMSCONNNAME, DEFAULT_ISSSL, DEFAULT_KEYSTORENAME, DEFAULT_KEYSTOREPASSWD, DEFAULT_LTERM_NAME, DEFAULT_MAP_NAME, DEFAULT_MAXCONN, DEFAULT_PASSWORD, DEFAULT_POOLCHECK, DEFAULT_PORTNUMBER, DEFAULT_REROUTE_NAME, DEFAULT_SOWA, 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
Constructors Constructor and Description IMSManagedConnectionFactory()
-
Method Summary
Methods Modifier and Type Method and Description void
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.void
addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for a specific property.java.lang.Object
createConnectionFactory()
This variant of the createConnectionFactory method (with no arguments) is used by an application in a non-managed environment to create an IMSConnectionFactory instance.java.lang.Object
createConnectionFactory(javax.resource.spi.ConnectionManager aConnManager)
This variant of the createConnectionFactory method is used by an application in a managed environment to create an IMSConnectionFactory instance.javax.resource.spi.ManagedConnection
createManagedConnection(javax.security.auth.Subject aSubject, ConnectionRequestInfo aConnectionRequestInfo)
Creates a new IMSManagedConnection instance to represent the physical connection between IMS TM Resource Adapter and IMS Connect.boolean
equals(java.lang.Object anObject)
Determines if the input object matches set of configuration properties that make this IMSManagedConnectionFactory instance unique and specific to a particular IMS Connect.void
firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
The firePropertyChange method was generated to support the propertyChange field.java.lang.Boolean
getCM0Dedicated()
Returns the value of the CM0Dedicated property.java.lang.String
getDataStoreName()
Returns the value of the DataStoreName property.java.lang.String
getGroupName()
Returns the value of the GroupName property.java.lang.String
getHostName()
Returns the value of the HostName property.java.lang.String
getIMSConnectName()
Returns the value of the IMS Connect name property.com.ibm.ims.ico.IMSConnFunction
getIMSConnFunction()
LogUtils
getLogUtil()
java.io.PrintWriter
getLogWriter()
Returns the value of the logWriter property.java.lang.String
getPassword()
Returns the value of the Password property.java.lang.String
getPasswordPhrase()
Returns the password phrase property value.java.lang.Integer
getPortNumber()
Returns the value of the PortNumber property.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 IMSManagedConnectionFactory object.ResourceAdapter
getResourceAdapter()
Return ResourceAdapter JavaBean associated with this ManagedConnectionFactory JavaBean.java.lang.Boolean
getRRSTransactional()
Returns the value of the RRSTransactional property.java.lang.Boolean
getSSLEnabled()
Returns the value of the SSLEnabled property.java.lang.String
getSSLEncryptionType()
Returns the value of the SSLEncryptionType property.java.lang.String
getSSLKeyStoreName()
Returns the value of the SSLKeyStoreName property.java.lang.String
getSSLKeyStorePassword()
Returns the value of the SSLKeyStorePassword property.java.lang.String
getSSLTrustStoreName()
Returns the value of the SSLTrustStoreName property.java.lang.String
getSSLTrustStorePassword()
Returns the value of the SSLTrustStorePassword property.java.lang.String
getThreadIdentitySupport()
Returns the value of the appropriate xxxthreadIdentitySupport property, where xxx is either TCPIP or LocalOption.boolean
getThreadSecurity()
Returns the value of the threadSecurity property.java.lang.Integer
getTraceLevel()
Returns the value of the traceLevel property.java.lang.String
getUserName()
Returns the value of the UserName property.int
hashCode()
Returns the hash code of the configuration properties that make this IMSManagedConnectionFactory instance unique.javax.resource.spi.ManagedConnection
matchManagedConnections(java.util.Set aConnectionSet, javax.security.auth.Subject aSubject, ConnectionRequestInfo aConnRequestInfo)
Returns an IMSManagedConnection instance from aConnectionSet.void
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.void
removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener for a specific property.void
setCM0Dedicated(java.lang.Boolean isCM0Dedicated)
Sets the value of the CM0Dedicated property of an IMSManagedConnectionFactory instance.void
setDataStoreName(java.lang.String aDataStoreName)
Sets the value of the DataStoreName property of an IMSManagedConnectionFactory instance.void
setGroupName(java.lang.String aGroupName)
Sets the value of the GroupName property of an IMSManagedConnectionFactory instance.void
setHostName(java.lang.String aHostName)
Sets the value of the HostName property of an IMSManagedConnectionFactory instance.void
setIMSConnectName(java.lang.String aIMSConnName)
Sets the value of the IMS Connect Name property of an IMSManagedConnectionFactory instance.void
setIMSConnFunction(byte[] func)
void
setLogUtil(LogUtils logUtil)
void
setLogWriter(java.io.PrintWriter aLogWriter)
Sets the value of the logWriter property of an IMSManagedConnectionFactory instance.void
setPassword(java.lang.String aPassword)
Sets the value of the Password property of an IMSManagedConnectionFactory instance.void
setPasswordPhrase(java.lang.String aPasswordPhrase)
Sets the value of the password phrase property.void
setPortNumber(java.lang.Integer aPortNumber)
Sets the value of the PortNumber property of an IMSManagedConnectionFactory instance.void
setResourceAdapter(ResourceAdapter aResourceAdapter)
Prior to using a ManagedConnectionFactory JavaBean, the application server must create an association between the ManagedConnectionFactory JavaBean and a ResourceAdapter JavaBean by calling setResourceAdapter().void
setSSLEnabled(java.lang.Boolean isSSL)
Sets the value of the SSLEnabled property of an IMSManagedConnectionFactory instance.void
setSSLEncryptionType(java.lang.String aEncrypType)
Sets the value of the SSLEncryptionType property of an IMSManagedConnectionFactory instance.void
setSSLKeyStoreName(java.lang.String aKeyStoreName)
Sets the value of the SSLKeyStoreName property of an IMSManagedConnectionFactory instance.void
setSSLKeyStorePassword(java.lang.String aKeyStorePasswd)
Sets the value of the SSLKeyStorePassword property of an IMSManagedConnectionFactory instance.void
setSSLTrustStoreName(java.lang.String aTrustStoreName)
Sets the value of the SSLTrustStoreName property of an IMSManagedConnectionFactory instance.void
setSSLTrustStorePassword(java.lang.String aTrustStorePasswd)
Sets the value of the SSLTrustStorePassword property of an IMSManagedConnectionFactory instance.void
setTraceLevel(java.lang.Integer aTraceLevel)
Sets the value of the traceLevel property of an IMSManagedConnectionFactory instance.void
setUserName(java.lang.String aUserName)
Sets the value of the UserName property of an IMSManagedConnectionFactory instance.
-
-
-
Method Detail
-
getPropertyChange
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 IMSManagedConnectionFactory object.
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for all the properties.- Parameters:
listener
- The PropertyChangeListener to be added.
-
addPropertyChangeListener
public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener for a specific property.- Parameters:
listener
- The PropertyChangeListener to be added.propertyName
- The name of the property to listen on.
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list.- Parameters:
listener
- The PropertyChangeListener to be removed.
-
removePropertyChangeListener
public void removePropertyChangeListener(java.lang.String propertyName, 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.
-
firePropertyChange
public void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
The firePropertyChange method was generated to support the propertyChange field.
-
createConnectionFactory
public java.lang.Object createConnectionFactory() throws javax.resource.ResourceException
This variant of the createConnectionFactory method (with no arguments) is used by an application in a non-managed environment to create an IMSConnectionFactory instance. A non-managed environment is a two-tier operational environment. The first tier, an application client, uses the IMS TM Resource Adapter resource adapter directly to access IMS via IMS Connect. IMS OTMA, accessed via IMS Connect, defines the second tier.For this form of the createConnectionFactory method, an IMSConnectionFactory instance is created with the default connection manager from the IBM Common Connector Framework 2 class libraries (com.ibm.connector2.spi.DefaultConnectionManager).
- Returns:
- A new IMSConnectionFactory object.
- Throws:
javax.resource.ResourceException
- If there is a problem creating a new IMSConnectionFactory object.
-
createConnectionFactory
public java.lang.Object createConnectionFactory(javax.resource.spi.ConnectionManager aConnManager) throws javax.resource.ResourceException
This variant of the createConnectionFactory method is used by an application in a managed environment to create an IMSConnectionFactory instance. A managed environment is a J2EE-based multi-tier operational environment. In a managed environment the application server, rather than the resource adapter (IMS TM Resource Adapter), provides a connection manager instance.- Parameters:
aConnManager
- A ConnectionManager instance, provided by the application server.- Returns:
- A new IMSConnectionFactory object.
- Throws:
javax.resource.ResourceException
- If the value passed for aConnManager is null.
-
createManagedConnection
public javax.resource.spi.ManagedConnection createManagedConnection(javax.security.auth.Subject aSubject, ConnectionRequestInfo aConnectionRequestInfo) throws javax.resource.ResourceException
Creates a new IMSManagedConnection instance to represent the physical connection between IMS TM Resource Adapter and IMS Connect. For example, in the case of TCP/IP this method creates an object to represent the TCP/IP socket between IMS TM Resource Adapter and IMS Connect.An application component uses an IMSConnection object, an application level handle to an IMSManagedConnection instance, to access IMS OTMA through IMS Connect.
- Parameters:
aSubject
- Security information for container-managed sign-on.aConnectionRequestInfo
- Security information (UserName, Password, and GroupName) for component-managed sign-on.- Returns:
- An IMSManagedConnection instance.
- Throws:
javax.resource.ResourceException
- if:- aConnectionRequestInfo is not of type IMSConnectionRequestInfo
- Length of UserName, Password, GroupName, or DataStoreName used to create the instance is greater than the maximum allowable length
- See Also:
IMSManagedConnection
-
equals
public boolean equals(java.lang.Object anObject)
Determines if the input object matches set of configuration properties that make this IMSManagedConnectionFactory instance unique and specific to a particular IMS Connect.- Overrides:
equals
in classjava.lang.Object
- Parameters:
anObject
- IMSManagedConnectionFactory object to test.- Returns:
- A boolean value - True if equivalent; False otherwise
-
getDataStoreName
public java.lang.String getDataStoreName()
Returns the value of the DataStoreName property.- Returns:
- A string object containing the DataStoreName property value.
- See Also:
setDataStoreName(String)
-
getGroupName
public java.lang.String getGroupName()
Returns the value of the GroupName property.- Returns:
- A String object containing the GroupName property value.
- See Also:
setGroupName(String)
-
getHostName
public java.lang.String getHostName()
Returns the value of the HostName property.- Returns:
- A String object containing the HostName property value.
- See Also:
setHostName(String)
-
getIMSConnectName
public java.lang.String getIMSConnectName()
Returns the value of the IMS Connect name property.- Returns:
- The IMS Connect name property value.
- See Also:
setIMSConnectName(String)
-
getLogWriter
public java.io.PrintWriter getLogWriter() throws javax.resource.ResourceException
Returns the value of the logWriter property.- Returns:
- A java.io.PrintWriter object that is used as the logWriter.
- Throws:
javax.resource.ResourceException
- See Also:
setLogWriter(PrintWriter)
-
getPassword
public java.lang.String getPassword()
Returns the value of the Password property.- Returns:
- A String object containing the Password property value.
- See Also:
setPassword(String)
-
getPortNumber
public java.lang.Integer getPortNumber()
Returns the value of the PortNumber property.- Returns:
- The PortNumber property value.
- See Also:
setPortNumber(Integer)
-
getRRSTransactional
public java.lang.Boolean getRRSTransactional()
Returns the value of the RRSTransactional property. This property is used by the WebSphere Application Server for z/OS and OS/390 to determine if the IMSManagedConnectionFactory instance is configured to support RRS transactions with 2-phase-commit support.Currently, IMS TM Resource Adapter supports RRS transactions if the IMSManagedConnectionFactory instance is configured to use local option communication.
- Returns:
- java.lang.Boolean
-
getThreadIdentitySupport
public java.lang.String getThreadIdentitySupport()
Returns the value of the appropriate xxxthreadIdentitySupport property, where xxx is either TCPIP or LocalOption.- Returns:
- A String object containing the xxxthreadIdentitySupport property value.
- See Also:
setPortNumber(java.lang.Integer)
-
getThreadSecurity
public boolean getThreadSecurity()
Returns the value of the threadSecurity property.- Returns:
- A Boolean object containing the threadSecurity property value. IMS TM Resource Adapter does not support placing the ACEE on the OS thread so threadSecurity is initialized to false and therefore false is always returned.
-
getTraceLevel
public java.lang.Integer getTraceLevel()
Returns the value of the traceLevel property.- Returns:
- An Integer object containing the traceLevel property value.
- See Also:
setTraceLevel(Integer)
,IMSTraceLevelProperties
-
getUserName
public java.lang.String getUserName()
Returns the value of the UserName property.- Returns:
- A String object containing the UserName property value.
- See Also:
setUserName(String)
-
hashCode
public int hashCode()
Returns the hash code of the configuration properties that make this IMSManagedConnectionFactory instance unique.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- An int value containing the hashCode of this IMSManagedConnectionFactory instance.
-
matchManagedConnections
public javax.resource.spi.ManagedConnection matchManagedConnections(java.util.Set aConnectionSet, javax.security.auth.Subject aSubject, ConnectionRequestInfo aConnRequestInfo) throws javax.resource.ResourceException
Returns an IMSManagedConnection instance from aConnectionSet. Since IMS TM Resource Adapter supports re-authentication, the security information associated with the instance is overwritten by the first getConnection() method invocation.The matchManagedConnections method also sets the DataStoreName parameter of the returned instance to that of the IMSManagedConnectionFactory instance.
- Parameters:
aConnectionSet
- A set of IMSManagedConnection instances provided by the application server.aSubject
- Currently this parameter is not used by this implementation of matchManagedConnections.aConnRequestInfo
- Used to obtain the clientID when locating an appropriate IMSManagedConnection instance to use for a dedicated persistent socket connection.- Returns:
- An IMSManagedConnection instance or null.
- Throws:
javax.resource.ResourceException
-
setDataStoreName
public void setDataStoreName(java.lang.String aDataStoreName) throws javax.resource.ResourceException
Sets the value of the DataStoreName property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
aDataStoreName
- The new value for the DataStoreName property. It 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:
getDataStoreName()
-
setGroupName
public void setGroupName(java.lang.String aGroupName) throws javax.resource.ResourceException
Sets the value of the GroupName property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
aGroupName
- The new value that will be used for all connections if the default user name is used. GroupName is used by IMS OTMA during authorization of the user. Note: The GroupName property can only be provided in a component-managed environment.- Throws:
javax.resource.ResourceException
-- If the length of aGroupName 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:
getGroupName()
-
setHostName
public void setHostName(java.lang.String aHostName) throws javax.resource.ResourceException
Sets the value of the HostName property of an IMSManagedConnectionFactory 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:
aHostName
- The new value for the HostName property, the IP address or host name of the machine running the target IMS Connect.- Throws:
javax.resource.ResourceException
-- If the length of aHostName is 0.
- If aHostName 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()
-
setIMSConnectName
public void setIMSConnectName(java.lang.String aIMSConnName) throws javax.resource.ResourceException
Sets the value of the IMS Connect Name property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.This property applies to Local Option communication only. This property must be set to null (the default) if TCP/IP communication is used.
- Parameters:
aIMSConnName
- The new value for the IMSConnName property, the job name of the target IMS Connect. This value must match the 'HWS ID' of the target IMS Connect.- Throws:
javax.resource.ResourceException
-- If the length of aIMSConnName is greater than 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:
getIMSConnectName()
-
setLogWriter
public void setLogWriter(java.io.PrintWriter aLogWriter) throws javax.resource.ResourceException
Sets the value of the logWriter property of an IMSManagedConnectionFactory instance.- Parameters:
aLogWriter
- A log writer (character output stream) to which all logging and tracing messages for an IMSManagedConnectionFactory instance are printed. The log writer is initially null. When the log writer is null, logging is disabled.Note: Logging and tracing are also controlled by the value of the traceLevel property, in addition to the value of the logWriter property.
- Throws:
javax.resource.ResourceException
- See Also:
getLogWriter()
,IMSTraceLevelProperties
-
setPassword
public void setPassword(java.lang.String aPassword) throws javax.resource.ResourceException
Sets the value of the Password property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
aPassword
- The new value for the Password property, the password that will be used for connections if the user name is used.- Throws:
javax.resource.ResourceException
-- If the length of aPassword 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:
getPassword()
-
setPortNumber
public void setPortNumber(java.lang.Integer aPortNumber) throws javax.resource.ResourceException
Sets the value of the PortNumber property of an IMSManagedConnectionFactory 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:
aPortNumber
- 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:
getPortNumber()
-
setTraceLevel
public void setTraceLevel(java.lang.Integer aTraceLevel) throws javax.resource.ResourceException
Sets the value of the traceLevel property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
aTraceLevel
- The new value for the traceLevel property. The value of this property controls the information that is traced.- RAS_TRACE_OFF (0)
- No tracing or logging occurs.
- RAS_TRACE_ERROR_EXCEPTION (1)
- Only errors and exceptions are logged.
- RAS_TRACE_ENTRY_EXIT (2)
- Errors and exceptions plus the entry and exit of important methods are logged.
- RAS_TRACE_INTERNAL (3)
- Errors and exceptions, the entry and exit of important methods, and the contents of buffers sent to and received from IMS Connect are logged.
Note: Logging and tracing is also controlled by the value of the logWriter property, in addition to the value of the traceLevel property.
- Throws:
javax.resource.ResourceException
-- Value of aTraceLevel is invalid.
Note: The tooling may ignore these exceptions, in which case default values will be used and an exception will be thrown later.
- See Also:
getTraceLevel()
,IMSTraceLevelProperties
-
setUserName
public void setUserName(java.lang.String aUserName) throws javax.resource.ResourceException
Sets the value of the UserName property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
aUserName
- 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:
getUserName()
-
getSSLEncryptionType
public java.lang.String getSSLEncryptionType()
Returns the value of the SSLEncryptionType property.- Returns:
- A String object containing the SSLEncryptionType property value.
- See Also:
setSSLEncryptionType(String)
-
getSSLEnabled
public java.lang.Boolean getSSLEnabled()
Returns the value of the SSLEnabled property.- Returns:
- A Boolean object containing the SSLEnabled property value.
- See Also:
setSSLEnabled(Boolean)
-
getSSLKeyStoreName
public java.lang.String getSSLKeyStoreName()
Returns the value of the SSLKeyStoreName property.- Returns:
- A String object containing the SSLKeyStoreName property value.
- See Also:
setSSLKeyStoreName(String)
-
getSSLKeyStorePassword
public java.lang.String getSSLKeyStorePassword()
Returns the value of the SSLKeyStorePassword property.- Returns:
- A String object containing the SSLKeyStorePassword property value.
- See Also:
setSSLKeyStorePassword(String)
-
getSSLTrustStoreName
public java.lang.String getSSLTrustStoreName()
Returns the value of the SSLTrustStoreName property.- Returns:
- A String object containing the SSLTrustStoreName property value.
- See Also:
setSSLTrustStoreName(String)
-
getSSLTrustStorePassword
public java.lang.String getSSLTrustStorePassword()
Returns the value of the SSLTrustStorePassword property.- Returns:
- A String object containing the SSLTrustStorePassword property value.
- See Also:
setSSLTrustStorePassword(String)
-
getCM0Dedicated
public java.lang.Boolean getCM0Dedicated()
Returns the value of the CM0Dedicated property.- Returns:
- A Boolean object containing the CM0Dedicated property value.
- See Also:
setCM0Dedicated(Boolean)
-
setSSLEnabled
public void setSSLEnabled(java.lang.Boolean isSSL)
Sets the value of the SSLEnabled property of an IMSManagedConnectionFactory 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
public void setSSLEncryptionType(java.lang.String aEncrypType) throws javax.resource.ResourceException
Sets the value of the SSLEncryptionType property of an IMSManagedConnectionFactory 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:
getSSLEncryptionType()
-
setSSLKeyStoreName
public void setSSLKeyStoreName(java.lang.String aKeyStoreName) throws javax.resource.ResourceException
Sets the value of the SSLKeyStoreName property of an IMSManagedConnectionFactory 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.ksNote: 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:
getSSLKeyStoreName()
-
setSSLTrustStoreName
public void setSSLTrustStoreName(java.lang.String aTrustStoreName) throws javax.resource.ResourceException
Sets the value of the SSLTrustStoreName property of an IMSManagedConnectionFactory 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.ksNote: 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:
getSSLTrustStoreName()
-
setSSLTrustStorePassword
public void setSSLTrustStorePassword(java.lang.String aTrustStorePasswd) throws javax.resource.ResourceException
Sets the value of the SSLTrustStorePassword property of an IMSManagedConnectionFactory 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:
getSSLTrustStorePassword()
-
setSSLKeyStorePassword
public void setSSLKeyStorePassword(java.lang.String aKeyStorePasswd) throws javax.resource.ResourceException
Sets the value of the SSLKeyStorePassword property of an IMSManagedConnectionFactory 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:
getSSLKeyStorePassword()
-
setCM0Dedicated
public void setCM0Dedicated(java.lang.Boolean isCM0Dedicated)
Sets the value of the CM0Dedicated property of an IMSManagedConnectionFactory instance. This method is most likely used by a tool, possibly provided by the application server.- Parameters:
isCM0Dedicated
- The new value for the CM0Dedicated property. The default is false. A value of FALSE indicates the connection factory will generate shareable persistent socket connections and IMS TM Resource Adapter will generate a clientID to identify the socket connection. These connections can be used by commit mode 0 and commit mode 1 interactions. A value of TRUE indicates the connection factory will generate dedicated persistent socket connections, which require user-specified clientIDs to identify the socket connections. A dedicated persistent socket connection is reserved for a particular clientID and only commit mode 0 interactions are allowed. This property applies to TCP/IP connections only.
-
setResourceAdapter
public void setResourceAdapter(ResourceAdapter aResourceAdapter)
Prior to using a ManagedConnectionFactory JavaBean, the application server must create an association between the ManagedConnectionFactory JavaBean and a ResourceAdapter JavaBean by calling setResourceAdapter().
-
getResourceAdapter
public ResourceAdapter getResourceAdapter()
Return ResourceAdapter JavaBean associated with this ManagedConnectionFactory JavaBean.
-
getLogUtil
public LogUtils getLogUtil()
-
setLogUtil
public void setLogUtil(LogUtils logUtil)
-
setPasswordPhrase
public void setPasswordPhrase(java.lang.String aPasswordPhrase) 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 (RACF) to authenticate the user.- Parameters:
aPasswordPhrase
- The new password value.- Throws:
javax.resource.ResourceException
- See Also:
getPasswordPhrase()
-
getPasswordPhrase
public java.lang.String getPasswordPhrase()
Returns the password phrase property value.- Returns:
- The password phrase property value.
- See Also:
setPasswordPhrase(java.lang.String)
-
getIMSConnFunction
public com.ibm.ims.ico.IMSConnFunction getIMSConnFunction()
-
setIMSConnFunction
public void setIMSConnFunction(byte[] func)
-
-