Modifying available MBean attributes

The TeamServerMBean holds attributes that are relevant to the overall ClearQuest Web server behavior. Attributes that are specific to controlling how the ClearQuest server factory works are stored in the CqServerFactoryMBean server factory.

• cqFulltextSearchCacheSize[R,W] - The number of record hits saved in ClearQuest core for a single full-text search. This value is used to override the default behavior assumed by the ClearQuest core. The default value for this attribute is 0, which signifies to ClearQuest Web server that this value is unset and should not be used to override the ClearQuest core's default setting. A positive value will override the ClearQuest core's default setting.
• cqFulltextSearchPageSize[R,W] - The number of record hits in a page of full-text search results in ClearQuest core for a single full-text search. This value is used to override the default behavior assumed by the ClearQuest core. The default value for this attribute is 0, which signifies to the ClearQuest Web server that this value is unset and should not be used to override the ClearQuest core's default setting. A positive value will override the default setting for ClearQuest core.
• cqFulltextSearchRecordHitLimit[R,W] - The maximum number of record hits returned in one web service call for a single full-text search; also number of hits that could be cached in an application server. Default value is 100.
• cqLoginSessionTimeout[R,W] - The amount of time in seconds that a ClearQuest login session will persist before timing out. Default value is 1800 seconds (30 minutes). Each ClearQuest session employs a database connection, so setting this value too high may consume resources for longer than necessary. Do not change the default value.
• cqLoginSessionWaitTimeout[R,W] - The amount of time in seconds that a thread should wait to acquire the Rational ClearQuest login session. The default value is 300 seconds.
• cqServerFactory[R] - The object name for the ClearQuest, J2C connection factory MBean.
• cqUserDBListSecureAccess[R,W] - Indicates whether users can see the list of databases when they attempt to log on to ClearQuest Web with invalid credentials. The default value is false, indicating that users can see the database list if they try to log on with invalid credentials. If the value is set to true, user authentication is enabled to prevent users from seeing the database list if they try to log on with invalid credentials.
• ejbBufferLimit[R,W] - The maximum number of objects that will be returned by an EJB call. Default value is 100.
• keepAliveInterval[R,W] - If set to a value greater than 0 (zero) seconds, the ClearQuest Web server will issue keep alive messages between the client and backend server components at the specified periodic interval if no traffic has been sent during that interval. This is designed to ensure that long running ClearQuest queries can complete without the infrastructure removing the underlying sockets. This value should be at least 10 seconds less than the socket timeout values. Default value is 300 seconds (five minutes).
• largeReadSocketTimeoutMultiplier[R,W] - The multiplier to apply to the read timeout value on the socket between the middle tier and the backend server component for certain very long running operations.  The default value of 4 indicates that the read socket timeout value is four times the backend server factory default read socket timeout value. This multiplier is applied only to certain operations. Do not change the value unless IBM Support instructs you to do so.
• maxCqSessionsPerUser[R,W] - The maximum number of ClearQuest sessions that will be created for each user in a single session. The default value is 2; the minimum value is 1.
• maxProcureServerAttempts[R,W] - The maximum number of attempts to allow a backend ONC RPC server to be obtained before returning an exception to the managed connection pool. Default value is 6; must be greater than or equal to 2.
• mediumReadSocketTimeoutMultiplier[R,W] - The multiplier to apply to the read timeout value on the socket between the middle tier and the backend server component for certain long running operations.  The default value of 2 indicates that the read socket timeout value is two times the backend server factory default read socket timeout value.  This multiplier is applied only to certain operations. Do not change the value unless IBM Support instructs you to do so.
• numberOfActiveSessions[R] - The number of active sessions the server is currently handling.
• numberOfHttpSessionsCreated[R] - The total number of sessions this server has handled.
• oncrpcBufferLimit[R,W] - The maximum number of objects returned in a single ONC RPC call. Default value is 100.
• oncrpcInterruptLimit[R,W] - The maximum number of objects returned for a user's request. Default value is 1000.
• oncrpcServers[R] - The object names for the currently running ONC RPC server MBeans.
• procureServerInterval[R,W] - The total amount of time (in seconds) a request thread is allowed to wait when trying to obtain a server before returning an exception to the managed connection pool. Default value is 60 seconds.
• sessionObjectDefaultTimeout[R,W] - The default length of time in seconds that an object will stay in a session. Default value is 1800 seconds (30 minutes). Must be greater than or equal to 0.
• sessionQueryObjectTimeout[R,W] - The length of time a ClearQuest login session persists before timing out if a new or modified query or query folder has not been delivered. This value cannot be less than the cqLoginSessionTimeout value. Default value is 1800 seconds (30 minutes). This value overrides the value defined by sessionObjectDefaultTimeout.
• sessionRecordObjectTimeout[R,W] - The length of time a ClearQuest login session persists before timing out if a newly created or modified record exists that has not been delivered. This value cannot be less than the cqLoginSessionTimeout value. Default value is 10,800 seconds (3 hours). This value overrides the value defined by sessionObjectDefaultTimeout.
• sessionReaperThreadDelay[R,W] - Time delay in seconds for the session reaper thread. Default value is 900 seconds (15 minutes). Range of values is 300 through 1800 seconds. You may want to decrease this value if virtual memory is in high demand. You may want to increase this value if too much CPU is being consumed.
• totalNumberOfOncrpcServers[R] - The number of backend RPC servers currently running in all Rational ClearQuest connection factory instances.
• totalOncrpcCallCount[R] - The total number of oncrpc calls made since the server was started.
• totalWebServiceCallCount[R] - The total number of web service calls made since the server was started.
• versionNumber[R] - The ClearQuest Web server product version number, expressed as a string value, separated by periods. For example, 7.1.0.1.

This MBean holds configuration attributes relevant to the ClearQuest managed connection factory. The ClearQuest managed connection factory starts and manages the ClearQuest ONC RPC backend processes that communicate with the ClearQuest core. The attributes in this MBean do not affect ClearQuest general behavior as do some of the ClearQuest-specific attributes in the TeamServerMBean. Rather, the attributes in this MBean control the behavior of the factory and the management of the ClearQuest ONC RPC backend processes that it launches. Changes made to this MBean take effect immediately for newly launched backend processes (existing backend processes are not affected); you do not need to restart the server processes.

• activeHttpSessionThreshold[R,W] - The number of active HTTP sessions on an active backend ClearQuest ONC RPC server that, if exceeded, might cause another backend ClearQuest ONC RPC server to be started by this managed connection factory. Default is 30.
• cqrpcAbandonedProcessCleanupEnabled[R,W] - Indicates whether the ClearQuest Web server will launch the cleanup procedure that terminates any abandoned ClearQuest RPC processes. Default is TRUE.
• cqrpcAbandonedProcessCleanupInterval[R,W] - The length of time in minutes of the periodic interval that the ClearQuest Web server launches the cleanup procedure to terminate any abandoned ClearQuest RPC processes. Default is 30 minutes. The value must be greater than or equal to 0. The interval works in the nearest power of 2. A value of 0 indicates that the interval is set to 2.
• maximumActiveServers[R,W] - The maximum number of active backend ClearQuest ONC RPC servers allowed by this managed connection factory. Default is 10.
• recycleServerHttpSessionLimit[R,W] - The number of HTTP sessions that a backend ClearQuest ONC RPC server will process before being recycled by this managed connection factory. Default is 200. A value of zero indicates that this limit should not be checked.
• recycleServerLifetimeLimit[R,W] - The maximum lifetime, in seconds, that a backend ClearQuest ONC RPC server can run before being recycled by this managed connection factory. Default is 86,400 seconds (24 hours). A value of zero indicates that this limit will not be checked.
• recycleServerOncrpcCallLimit[R,W] - The maximum number of ONC RPC requests that a backend ClearQuest ONC RPC server will process before being recycled by this managed connection factory. Default is 100,000. A value of zero indicates that this limit will not be checked.
• recyclingPeriod[R,W] - The length of time, in seconds, that a recycling backend ClearQuest ONC RPC server is allowed to finish any outstanding session work before being terminated by this managed connection factory. The state of a recycling ClearQuest ONC RPC backend server will be 2 (STOPPING). Default is 1800 seconds (30 minutes). Must be greater than 0.
• remoteChartReportServerHostName[R,W] - For the UNIX system and Linux only. The host name of a Windows ClearQuest Web server designated to process chart and report requests. Default value is "" (empty string/unset).
• remoteChartReportServerPort[R,W] - For the UNIX system and Linux only. The port number of a Windows ClearQuest Web server designated to process chart and report requests. Default value is 0.
• serverWorkerThreadCount[R,W] - The number of threads that a backend ClearQuest ONC RPC server will use for handling incoming requests. Default is 30.

For each ONC RPC backend process that gets started by the ClearQuest managed connection factory, an instance of the CqOncrpcServerMBean is created. Each MBean contains the values defined in the base OncrpcServerMBean (note that the base OncrpcServerMBean is never instantiated). Each server process MBean lives only as long as the process that it represents is running on the ClearQuest Web server system. When the process terminates, the MBean that represents the process also terminates. Following are the base attributes that are in all server process MBeans:

• hostname[R] - The name of the host the backend ONC RPC server is running on.
• oncrpcCalls[R] - The total number of ONC RPC calls that the backend ONC RPC server has handled.
• port[R] - The integer port number the backend ONC RPC server is listening on.
• serverId[R] - The unique ID for the backend ONC RPC server.
• serverStartTime[R] - The timestamp of when the backend ONC RPC server started. The value is the number of milliseconds since January 1, 1970, 00:00:00 GMT.
• serverState[R] - The current state of the backend ONC RPC server, represented with an integer (0=STOPPED, 1=RUNNING, 2=STOPPING, 3=DEAD).
• serverStoppingTime[R] - The timestamp of when the backend ONC RPC server went into the STOPPING (2) state. The value is the number of milliseconds since January 1, 1970, 00:00:00 GMT.
• serverStopTime[R] - The timestamp of when the backend ONC RPC server went into the STOPPED (0) or DEAD (3) state. The value is the number of milliseconds since January 1, 1970, 00:00:00 GMT.
• serverType[R] - The type of the backend ONC RPC server (Rational ClearCase®).

For each ClearQuest ONC RPC backend process that gets started by the ClearQuest managed connection factory, an instance of the CqOncrpcServerMBean MBean is created. This instance only lives as long as the ClearQuest ONC RPC backend process that it represents is running on the ClearQuest Web server system. As soon as the process terminates, the MBean that represents the process also terminates.

The CqOncrpcServerMBean is an extension to the OncrpcServerMBean. Each CqOncrpcServerMBean contains all of the values defined by the OncrpcServerMBean plus the following additional values:

• activeHttpSessions[R] - The current number of active HTTP sessions that the backend ClearQuest ONC RPC server is handling.
• activeStatefulHttpSessions[R] - The current number of stateful HTTP sessions that the backend ClearQuest ONC RPC server is handling.
• recycleReasonCode[R] - The reason code (represented as an integer) indicating why the backend ClearQuest ONC RPC server is being recycled.
  • 1=RECYCLE_TIME_LIMIT_EXCEEDED
  • 2=ONCRPC_CALL_LIMIT_EXCEEDED
  • 3=SESSION_LIMIT_EXCEEDED

• recycleServerHttpSessionLimit[R,W] - The maximum number of sessions that the backend ClearQuest ONC RPC server will handle before being recycled. Default value is initially set using the recycleServerHttpSessionLimit attribute value in the CqServerFactoryMBean. Can only be set on a running ClearQuest ONC RPC backend server. Note that all ONC RPC backend server processes are volatile. Setting the value on a running ClearQuest ONC RPC server can fail if the server is terminated by the ClearQuest managed connection factory while attempting to change the value.
• totalHttpSessions[R] - The total number of HTTP sessions that the backend ClearQuest ONC RPC server has handled.
• workerThreadCount[R] - The number of threads the backend ClearQuest ONC RPC server is using to process requests.