com.ibm.websphere.management

Interface AdminConstants



  • 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

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ADMIN_AGENT 
      static java.lang.String ADMIN_AGENT_PROCESS
      The AdminService.getProcessType() method will return this value when the current process is the Admin Agent.
      static java.lang.String ADMIN_AGENT_SERVER_TYPE
      The AdminService.getServerType() method will return this value when the current process is the Admin Agent.
      static java.lang.String BASE 
      static 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.
      static 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
      static 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
      static java.lang.String DEFAULT_APPLICATION_TYPE 
      static 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.
      static java.lang.String DEPLOYMENT_MANAGER 
      static java.lang.String DEPLOYMENT_MANAGER_PROCESS
      The AdminService.getProcessType() method will return this value when the current process is the Deployment Manager.
      static java.lang.String DEPLOYMENT_MANAGER_SERVER_TYPE
      The AdminService.getServerType() method will return this value when the current process is the deployment manager.
      static java.lang.String DISCOVERY_THREADS_PROP
      This property defines the maximum number of threads used by the process discovery system for process discovery messages.
      static 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.
      static java.lang.String ENABLE_FILE_SERVICE_MBEAN_PROP
      Users will set this property to enable/disable the File Service MBean in the node agent.
      static java.lang.String JOB_MANAGER 
      static java.lang.String JOB_MANAGER_PROCESS
      The AdminService.getProcessType() method will return this value when the current process is the Job Manager.
      static java.lang.String JOB_MANAGER_SERVER_TYPE
      The AdminService.getServerType() method will return this value when the current process is the Job Manager.
      static 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.
      static 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.
      static java.lang.String NODE_AGENT_PROCESS
      The AdminService.getProcessType() method will return this value when the current process is the Node Agent.
      static java.lang.String PROFILE_KEY 
      static java.lang.String SECURE_PROXY 
      static 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
      static java.lang.String SERVER_DISCOVERY_ADDRESS
      This is the EndPoint name for application servers.
      static java.lang.String SINGLE_JVM_TYPE
      The AdminService.getJvmType() method will return this value when the current process is a Distributed (Single) JVM.
      static java.lang.String SOAP_CONNECTOR_THREAD_POOL_GROWABLE
      This property defines whether the soap connector thread Pool size should grow beyond the maximum pool size.
      static java.lang.String SOAP_CONNECTOR_THREAD_POOL_LOG_GROWTH
      This property defines whether the soap connector thread Pool should log warning messages whenever the pool size reaches a multiple of the maximum pool size.
      static java.lang.String SOAP_SERVER_THREADS_PROP
      This property defines the maximum number of threads used by the Soap Connector for administrative messages.
      static 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

        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:
        AdminService.getProcessType(), Constant Field Values
      • DEPLOYMENT_MANAGER_SERVER_TYPE

        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:
        AdminService.getServerType(), Constant Field Values
      • MANAGED_PROCESS

        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:
        AdminService.getProcessType(), Constant Field Values
      • STANDALONE_PROCESS

        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:
        AdminService.getProcessType(), Constant Field Values
      • ENABLE_CONFIG_MBEAN_PROP

        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:
        Constant Field Values
      • ENABLE_FILE_SERVICE_MBEAN_PROP

        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:
        Constant Field Values
      • SOAP_SERVER_THREADS_PROP

        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:
        Constant Field Values
      • SOAP_CONNECTOR_THREAD_POOL_GROWABLE

        static final java.lang.String SOAP_CONNECTOR_THREAD_POOL_GROWABLE
        This property defines whether the soap connector thread Pool size should grow beyond the maximum pool size.

        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 do not want to grow the thread pool size.

        See Also:
        Constant Field Values
      • SOAP_CONNECTOR_THREAD_POOL_LOG_GROWTH

        static final java.lang.String SOAP_CONNECTOR_THREAD_POOL_LOG_GROWTH
        This property defines whether the soap connector thread Pool should log warning messages whenever the pool size reaches a multiple of the maximum pool size.

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

        Set this property totrue if you want the soap connector thread pool to log whenever the pool size equals a multiple of the maximum pool size.

        See Also:
        Constant Field Values
      • DISCOVERY_THREADS_PROP

        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.

        See Also:
        Constant Field Values
      • NODE_AGENT_LAUNCH_TIMEOUT

        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.

        See Also:
        Constant Field Values
      • CONFIGURE_MBEAN

        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.

        See Also:
        Constant Field Values
      • DEPLOYER_MBEAN

        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.

        See Also:
        Constant Field Values
      • SERVER_DISCOVERY_ADDRESS

        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.
        See Also:
        Constant Field Values
      • CONTROL_JVM_TYPE

        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
        See Also:
        Constant Field Values
      • SERVANT_JVM_TYPE

        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
        See Also:
        Constant Field Values
      • CRA_JVM_TYPE

        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
        See Also:
        Constant Field Values
      • SINGLE_JVM_TYPE

        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.
        See Also:
        AdminService.getJvmType(), Constant Field Values
      • DEFAULT_APPLICATION_TYPE

        static final java.lang.String DEFAULT_APPLICATION_TYPE
        See Also:
        Constant Field Values
      • ADMIN_AGENT_SERVER_TYPE

        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.
        See Also:
        AdminService.getServerType(), Constant Field Values
      • JOB_MANAGER_SERVER_TYPE

        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.
        See Also:
        AdminService.getServerType(), Constant Field Values
IBM WebSphere Application ServerTM
Release 9.0