com.ibm.websphere.management

Interface AdminConstants


  1. public interface AdminConstants
AdminConstants holds many of the public constant strings needed by various other admin APIs.

The Strings representing the possible types of WebSphere processes are defined in this interface. Several property key strings are also defined in this interface.


Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
ADMIN_AGENT
  1. static
  2. java.lang.String
ADMIN_AGENT_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Admin Agent.
  1. static
  2. java.lang.String
ADMIN_AGENT_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the Admin Agent.
  1. static
  2. java.lang.String
BASE
  1. static
  2. java.lang.String
CONFIGURE_MBEAN
This is an optional attribute on MBean in MBean's XML descriptor file to indicate if a MBean is a configuration related MBean.
  1. static
  2. java.lang.String
CONTROL_JVM_TYPE
The AdminService.isControlJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value
  1. static
  2. java.lang.String
CRA_JVM_TYPE
The AdminService.isCRAJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value
  1. static
  2. java.lang.String
DEFAULT_APPLICATION_TYPE
  1. static
  2. java.lang.String
DEPLOYER_MBEAN
This is an optional attribute on MBean in MBean's XML descriptor file to indicate if a MBean is a deployment related MBean.
  1. static
  2. java.lang.String
DEPLOYMENT_MANAGER
  1. static
  2. java.lang.String
DEPLOYMENT_MANAGER_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Deployment Manager.
  1. static
  2. java.lang.String
DEPLOYMENT_MANAGER_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the deployment manager.
  1. static
  2. java.lang.String
DISCOVERY_THREADS_PROP
This property defines the maximum number of threads used by the process discovery system for process discovery messages.
  1. static
  2. java.lang.String
ENABLE_CONFIG_MBEAN_PROP
Users will set this property so that they can have the ConfigService MBean and AppManagement MBean activated in the node agents.
  1. static
  2. java.lang.String
ENABLE_FILE_SERVICE_MBEAN_PROP
Users will set this property to enable/disable the File Service MBean in the node agent.
  1. static
  2. java.lang.String
JOB_MANAGER
  1. static
  2. java.lang.String
JOB_MANAGER_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Job Manager.
  1. static
  2. java.lang.String
JOB_MANAGER_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the Job Manager.
  1. static
  2. java.lang.String
MANAGED_PROCESS
The AdminService.getProcessType() method will return this value when the current process is a managed process such as an Application Server or JMS Server.
  1. static
  2. java.lang.String
NODE_AGENT_LAUNCH_TIMEOUT
This property defines the timeout interval (in seconds) used by default when the node agent launches a server process.
  1. static
  2. java.lang.String
NODE_AGENT_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Node Agent.
  1. static
  2. java.lang.String
PROFILE_KEY
  1. static
  2. java.lang.String
SECURE_PROXY
  1. static
  2. java.lang.String
SERVANT_JVM_TYPE
The AdminService.isServantJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value
  1. static
  2. java.lang.String
SERVER_DISCOVERY_ADDRESS
This is the EndPoint name for application servers.
  1. static
  2. java.lang.String
SINGLE_JVM_TYPE
The AdminService.getJvmType() method will return this value when the current process is a Distributed (Single) JVM.
  1. static
  2. java.lang.String
SOAP_CONNECTOR_THREAD_POOL_GROWABLE
This property defines if the soap connector thread Pool size should be grow or not This property is specified as a -D system property for the process.
  1. static
  2. java.lang.String
SOAP_SERVER_THREADS_PROP
This property defines the maximum number of threads used by the Soap Connector for administrative messages.
  1. static
  2. java.lang.String
STANDALONE_PROCESS
The AdminService.getProcessType() method will return this value when the current process is a standalone server process (not integrated with the Network Deployment environment).

Field Detail

DEPLOYMENT_MANAGER_PROCESS

  1. static final java.lang.String DEPLOYMENT_MANAGER_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Deployment Manager.
See Also:

DEPLOYMENT_MANAGER_SERVER_TYPE

  1. static final java.lang.String DEPLOYMENT_MANAGER_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the deployment manager.
See Also:

NODE_AGENT_PROCESS

  1. static final java.lang.String NODE_AGENT_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Node Agent.
See Also:

MANAGED_PROCESS

  1. static final java.lang.String MANAGED_PROCESS
The AdminService.getProcessType() method will return this value when the current process is a managed process such as an Application Server or JMS Server.
See Also:

STANDALONE_PROCESS

  1. static final java.lang.String STANDALONE_PROCESS
The AdminService.getProcessType() method will return this value when the current process is a standalone server process (not integrated with the Network Deployment environment).
See Also:

ENABLE_CONFIG_MBEAN_PROP

  1. static final java.lang.String ENABLE_CONFIG_MBEAN_PROP
Users will set this property so that they can have the ConfigService MBean and AppManagement MBean activated in the node agents. Typically these MBeans will only be active in Deployment Manager or in unmanaged single server processes.

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.enableConfigMBean. The value of the property should be true or false. By default it is false.

When this property is set, the user will be warned that they have an ability to make configuration changes by connecting to a node agent and that their changes can be erased if a config synchronization happens (either automatically or manually).

See Also:

ENABLE_FILE_SERVICE_MBEAN_PROP

  1. static final java.lang.String ENABLE_FILE_SERVICE_MBEAN_PROP
Users will set this property to enable/disable the File Service MBean in the node agent.

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.enableFileServiceMBean. The value of the property should be true or false. By default it is true.

See Also:

SOAP_SERVER_THREADS_PROP

  1. static final java.lang.String SOAP_SERVER_THREADS_PROP
This property defines the maximum number of threads used by the Soap Connector for administrative messages. The default value is 5.

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.soapThreads.

See Also:

SOAP_CONNECTOR_THREAD_POOL_GROWABLE

  1. static final java.lang.String SOAP_CONNECTOR_THREAD_POOL_GROWABLE
This property defines if the soap connector thread Pool size should be grow or not

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.soapConnectorThreadPoolGrowable. The value of the property should be true or false. By default it is true.

Set this property tofalse if donot want to grow the thread pool size.


DISCOVERY_THREADS_PROP

  1. static final java.lang.String DISCOVERY_THREADS_PROP
This property defines the maximum number of threads used by the process discovery system for process discovery messages. The default value is 2.

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.processDiscoveryThreads.


NODE_AGENT_LAUNCH_TIMEOUT

  1. static final java.lang.String NODE_AGENT_LAUNCH_TIMEOUT
This property defines the timeout interval (in seconds) used by default when the node agent launches a server process. The node agent launcher will wait this number of seconds for a status callback from the launched server before assuming that the server process failed to initialize. The default value is 1200 seconds.

This property is specified as a -D system property for the process. The property string is com.ibm.websphere.management.nodeAgentLaunchTimeout.


CONFIGURE_MBEAN

  1. static final java.lang.String CONFIGURE_MBEAN
This is an optional attribute on MBean in MBean's XML descriptor file to indicate if a MBean is a configuration related MBean.

The default value for this attribute is false.


DEPLOYER_MBEAN

  1. static final java.lang.String DEPLOYER_MBEAN
This is an optional attribute on MBean in MBean's XML descriptor file to indicate if a MBean is a deployment related MBean.

The default value for this attribute is false.


SERVER_DISCOVERY_ADDRESS

  1. static final java.lang.String SERVER_DISCOVERY_ADDRESS
This is the EndPoint name for application servers. It's used when multicasting is turned off. The discovery protocol associated with this discovery endpoint is the same as that of the nodeagent process.

CONTROL_JVM_TYPE

  1. static final java.lang.String CONTROL_JVM_TYPE
The AdminService.isControlJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value

SERVANT_JVM_TYPE

  1. static final java.lang.String SERVANT_JVM_TYPE
The AdminService.isServantJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value

CRA_JVM_TYPE

  1. static final java.lang.String CRA_JVM_TYPE
The AdminService.isCRAJvmType() method will return true when a JVM type (string format) is successfully compared to this constant value

SINGLE_JVM_TYPE

  1. static final java.lang.String SINGLE_JVM_TYPE
The AdminService.getJvmType() method will return this value when the current process is a Distributed (Single) JVM.

DEFAULT_APPLICATION_TYPE

  1. static final java.lang.String DEFAULT_APPLICATION_TYPE

ADMIN_AGENT_PROCESS

  1. static final java.lang.String ADMIN_AGENT_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Admin Agent.

ADMIN_AGENT_SERVER_TYPE

  1. static final java.lang.String ADMIN_AGENT_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the Admin Agent.

JOB_MANAGER_SERVER_TYPE

  1. static final java.lang.String JOB_MANAGER_SERVER_TYPE
The AdminService.getServerType() method will return this value when the current process is the Job Manager.

JOB_MANAGER_PROCESS

  1. static final java.lang.String JOB_MANAGER_PROCESS
The AdminService.getProcessType() method will return this value when the current process is the Job Manager.

PROFILE_KEY

  1. static final java.lang.String PROFILE_KEY

BASE

  1. static final java.lang.String BASE

ADMIN_AGENT

  1. static final java.lang.String ADMIN_AGENT

DEPLOYMENT_MANAGER

  1. static final java.lang.String DEPLOYMENT_MANAGER

JOB_MANAGER

  1. static final java.lang.String JOB_MANAGER

SECURE_PROXY

  1. static final java.lang.String SECURE_PROXY