ConnectionFactory MBean

All Parent MBeans:
J2EEResourceFactory, DiagnosticProvider

Partial ObjectName:
WebSphere:*,type=ConnectionFactory

MBean ConnectionFactory

Generic management interface for a connection factory.

Attribute Summary
java.lang.IntegerauthMechanismPreference
          
java.lang.IntegerstuckTimerTime
           Frequency of stuck time thread
java.lang.StringcurrentActivePool
           Return the pool that is currently being used when using resource adapter failover.
java.lang.IntegerstuckTime
           Connection stuck time.
java.lang.IntegerstuckThreshold
           Number of connections threshold.
java.lang.IntegersurgeThreshhold
           Connection creation will be restricted when this number is exceeded by the amount of surge time.
java.lang.IntegersurgeCreationInterval
           A connection will be created every surge time seconds while in surge threshold mode.
java.lang.IntegerconnectionTimeout
           Interval, in seconds after which a connection request times out and a ConnectionWaitTimeoutException is thrown
java.lang.IntegermaxConnections
           The maximun number of managed connections that can be created in this connection pool
java.lang.IntegerminConnections
           The minimum number of managed connection that should be maintained for all cases except if agedTimeout is set.
java.lang.StringpurgePolicy
           Specifies how to purge the connections when a connection error occurs.
java.lang.IntegerreapTime
           Interval in seconds between runs of the connection pool maintenance thread
java.lang.IntegerunusedTimeout
           Interval in seconds after which an unused connection is discarded by the connection pool maintenance thread
java.lang.IntegeragedTimeout
           Interval in seconds after which an unused aged connection is discarded by the connection pool maintenance thread
java.lang.IntegernumberOfPoolReserves
           The number of reserve pools to utilize
java.lang.IntegermaxConnectionsInPoolReserve
           The maximum number of connections in a reserve pool
java.lang.IntegerfreePoolDistributionTableSize
           Specifies the size of the distribution table used for distributing user data (Subject and CRI).
java.lang.IntegerfreePoolPartitions
           Specifies how many free pool partitions are created
java.lang.IntegersharedPoolPartitions
           Specifies how many shared pool partitions are created
java.lang.IntegerholdTimeLimit
           For diagnosticMode 1 and 2 will cause the tracking of connection hold time by an application.
java.lang.BooleanpopulateAlternateResource
           Disables and enables populate alternate resource.
java.lang.BooleanresourceFailOver
           Disables and enables resource fail over.
java.lang.BooleanresourceFailBack
           Disables and enables resource fail back.

Attributes inherited from MBean J2EEResourceFactory
name, Description, jndiName, category

Attributes inherited from MBean DiagnosticProvider
diagnosticProviderName

Operation Summary
voidfailOverToAlternateResource()
           Manual fail over to alternate resource.
voidfailOverToAlternateResource(java.lang.String action)
           Manual fail over to alternate resource.
voidfailBackToPrimaryResource()
           Manual fail back to primary resource.
voidfailBackToPrimaryResource(java.lang.String action)
           Manual fail back to primary resource.
java.lang.StringshowPoolContents()
           Returns a listing of the Connections in the ConnectionPool for this Object.
java.lang.StringshowAllPoolContents()
           Returns a listing of the Connections for All ConnectionPools on the Applcation Server.
voidpurgePoolContents()
           Purge connection pool.
voidpurgePoolContents(java.lang.String action)
           Purge connection pool.
voidpurgePoolContents(java.lang.Integer numConnectionsToRemain)
           Purge connection pool.
java.lang.StringgetPoolContents()
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringgetAllPoolContents()
           Deprecated.  As of 6,0, this method is deprecated.
java.lang.StringshowAllocationHandleList()
           Deprecated.  As of 6,1, this method is deprecated.
voidpause()
           ConnectionPool for this object will be paused.
voidresume()
           ConnectionPool for this obect will resumed.
java.lang.IntegergetStatus()
           Lifecycle status: 0=Status request failed; 1=Active; 2=Paused; 3=Stopped; 4=Paused - Mixed: some of the ConnectionFactories, DataSources, and ActivationSpecs are Paused while others are active; 99=Failed

Operations inherited from MBean DiagnosticProvider
getDiagnosticProviderId, getRegisteredDiagnostics, configDump, stateDump, selfDiagnostic, localize

Attribute Detail

authMechanismPreference

public java.lang.Integer authMechanismPreference
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

stuckTimerTime

public java.lang.Integer stuckTimerTime
Frequency of stuck time thread
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

currentActivePool

public java.lang.String currentActivePool
Return the pool that is currently being used when using resource adapter failover.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

stuckTime

public java.lang.Integer stuckTime
Connection stuck time.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

stuckThreshold

public java.lang.Integer stuckThreshold
Number of connections threshold.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

surgeThreshhold

public java.lang.Integer surgeThreshhold
Connection creation will be restricted when this number is exceeded by the amount of surge time.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

surgeCreationInterval

public java.lang.Integer surgeCreationInterval
A connection will be created every surge time seconds while in surge threshold mode.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

connectionTimeout

public java.lang.Integer connectionTimeout
Interval, in seconds after which a connection request times out and a ConnectionWaitTimeoutException is thrown
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

maxConnections

public java.lang.Integer maxConnections
The maximun number of managed connections that can be created in this connection pool
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

minConnections

public java.lang.Integer minConnections
The minimum number of managed connection that should be maintained for all cases except if agedTimeout is set.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

purgePolicy

public java.lang.String purgePolicy
Specifies how to purge the connections when a connection error occurs. (EntirePool or FailingConnectionOnly)
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

reapTime

public java.lang.Integer reapTime
Interval in seconds between runs of the connection pool maintenance thread
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

unusedTimeout

public java.lang.Integer unusedTimeout
Interval in seconds after which an unused connection is discarded by the connection pool maintenance thread
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

agedTimeout

public java.lang.Integer agedTimeout
Interval in seconds after which an unused aged connection is discarded by the connection pool maintenance thread
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

numberOfPoolReserves

public java.lang.Integer numberOfPoolReserves
The number of reserve pools to utilize
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

maxConnectionsInPoolReserve

public java.lang.Integer maxConnectionsInPoolReserve
The maximum number of connections in a reserve pool
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

freePoolDistributionTableSize

public java.lang.Integer freePoolDistributionTableSize
Specifies the size of the distribution table used for distributing user data (Subject and CRI).
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

freePoolPartitions

public java.lang.Integer freePoolPartitions
Specifies how many free pool partitions are created
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

sharedPoolPartitions

public java.lang.Integer sharedPoolPartitions
Specifies how many shared pool partitions are created
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

holdTimeLimit

public java.lang.Integer holdTimeLimit
For diagnosticMode 1 and 2 will cause the tracking of connection hold time by an application. If the hold time is greater then the holdTimeLimit it will be reported in the getPoolContents information. If the dianosticMode is 2, it will also collect the callstack at the time of the getConnection request for those connections exceeding the limit.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

populateAlternateResource

public java.lang.Boolean populateAlternateResource
Disables and enables populate alternate resource.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

resourceFailOver

public java.lang.Boolean resourceFailOver
Disables and enables resource fail over.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

resourceFailBack

public java.lang.Boolean resourceFailBack
Disables and enables resource fail back.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

Operation Detail

failOverToAlternateResource

public void failOverToAlternateResource()
Manual fail over to alternate resource.
Security Roles:
administrator
operator

failOverToAlternateResource

public void failOverToAlternateResource(java.lang.String action)
Manual fail over to alternate resource.
Parameters:
action - hold or automated, default is hold without automated failback.
Security Roles:
administrator
operator

failBackToPrimaryResource

public void failBackToPrimaryResource()
Manual fail back to primary resource.
Security Roles:
administrator
operator

failBackToPrimaryResource

public void failBackToPrimaryResource(java.lang.String action)
Manual fail back to primary resource.
Parameters:
action - automated or hold, default is automated with automated failover.
Security Roles:
administrator
operator

showPoolContents

public java.lang.String showPoolContents()
Returns a listing of the Connections in the ConnectionPool for this Object.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

showAllPoolContents

public java.lang.String showAllPoolContents()
Returns a listing of the Connections for All ConnectionPools on the Applcation Server.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

purgePoolContents

public void purgePoolContents()
Purge connection pool.
Security Roles:
administrator
operator

purgePoolContents

public void purgePoolContents(java.lang.String action)
Purge connection pool.
Parameters:
action - normal or immediate, default is normal
Security Roles:
administrator
operator

purgePoolContents

public void purgePoolContents(java.lang.Integer numConnectionsToRemain)
Purge connection pool.
Parameters:
numConnectionsToRemain - The number of connections to remain in the pool after the purge.
Security Roles:
administrator
operator

getPoolContents

public java.lang.String getPoolContents()
Deprecated.  As of 6,0, this method is deprecated.
Returns a listing of the Connections in the ConnectionPool for this Object.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllPoolContents

public java.lang.String getAllPoolContents()
Deprecated.  As of 6,0, this method is deprecated.
Returns a listing of the Connections for All ConnectionPools on the Applcation Server.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

showAllocationHandleList

public java.lang.String showAllocationHandleList()
Deprecated.  As of 6,1, this method is deprecated.
Returns a listing of Handles for All ConnectionPools on the Applcation Server.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

pause

public void pause()
ConnectionPool for this object will be paused.
Security Roles:
administrator
operator

resume

public void resume()
ConnectionPool for this obect will resumed.
Security Roles:
administrator
operator

getStatus

public java.lang.Integer getStatus()
Lifecycle status: 0=Status request failed; 1=Active; 2=Paused; 3=Stopped; 4=Paused - Mixed: some of the ConnectionFactories, DataSources, and ActivationSpecs are Paused while others are active; 99=Failed
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Copyright IBM Corp. 1996-2005