com.ibm.websphere.ola

Class OLASearchObject

  • java.lang.Object
    • com.ibm.websphere.ola.OLASearchObject
  • All Implemented Interfaces:
    java.io.Serializable


    public class OLASearchObject
    extends java.lang.Object
    implements java.io.Serializable
    Object used to manage search criteria when searching for registrations using the Optimized Local Adapters MBean.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      OLASearchObject()
      Default constructor
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Integer get_currentActiveConnectionCount()
      Returns the number of active connections used by the search object.
      java.lang.String get_currentActiveConnectionCountOperator()
      Returns the value of the active connections operator.
      java.lang.Boolean get_flagActive()
      Returns the value of the active flag used by the search object.
      java.lang.Boolean get_flagDaemonType()
      Returns the value of the daemon registration flag used by the search object.
      java.lang.Boolean get_flagExternalAddressType()
      Returns the value of the external address space flag used by the search object.
      java.lang.Boolean get_flagSecurity()
      Returns the value of the security flag used by the search object.
      java.lang.Boolean get_flagServerType()
      Returns the value of the server registration flag used by the search object.
      java.lang.Boolean get_flagTransactionSupport()
      Returns the value of the transaction flag used by the search object.
      java.lang.String get_jobName()
      Returns the job name that will be used to search registrations.
      java.lang.String get_jobNum()
      Returns the job number that will be used to search registrations.
      java.lang.Integer get_maxConnections()
      Returns the number of maximum connections used by the search object.
      java.lang.String get_maxConnectionsOperator()
      Returns the value of the maximum connections operator.
      java.lang.Integer get_minConnections()
      Returns the number of minimum connections used by the search object.
      java.lang.String get_minConnectionsOperator()
      Returns the value of the minimum connections operator.
      java.lang.String get_name()
      Returns the registration name that will be used to search registrations.
      java.lang.Long get_serverRGEAddress()
      Returns the server RGE address used by the search object.
      java.lang.String get_serverRGEAddressOperator()
      Returns the value of the server RGE address operator.
      java.lang.Integer get_state()
      Returns the state value used by the search object.
      java.lang.String get_stateOperator()
      Returns the value of the state operator.
      java.lang.String get_uuid()
      Returns the uuid that will be used to search registered servers.
      java.lang.Short get_version()
      Returns the version value used by the search object.
      java.lang.String get_versionOperator()
      Returns the value of the version operator.
      void set_currentActiveConnectionCount(java.lang.Integer activeConnectionCount)
      Sets the number of active connections used by the search object.
      void set_currentActiveConnectionCountOperator(java.lang.String activeConnectionCountOperator)
      Sets the value of the active connections operator.
      void set_flagActive(java.lang.Boolean active)
      Sets the value of the active flag used by the search object.
      void set_flagDaemonType(java.lang.Boolean daemonType)
      Sets the value of the daemon registration flag used by the search object.
      void set_flagExternalAddressType(java.lang.Boolean externalAddressType)
      Sets the value of the external address space flag used by the search object.
      void set_flagSecurity(java.lang.Boolean security)
      Sets the value of the security flag used by the search object.
      void set_flagServerType(java.lang.Boolean serverType)
      Sets the value of the server registration flag used by the search object.
      void set_flagTransactionSupport(java.lang.Boolean transactionSupport)
      Sets the value of the transaction flag used by the search object.
      void set_jobName(java.lang.String jobName)
      Sets the job name that will be used to search registrations.
      void set_jobNum(java.lang.String jobNum)
      Sets the job number that will be used to search registrations.
      void set_maxConnections(java.lang.Integer connections)
      Sets the number of maximum connections used by the search object.
      void set_maxConnectionsOperator(java.lang.String connectionsOperator)
      Sets the value of the maximum connections operator.
      void set_minConnections(java.lang.Integer connections)
      Sets the number of minimum connections used by the search object.
      void set_minConnectionsOperator(java.lang.String connectionsOperator)
      Sets the value of the minimum connections operator.
      void set_name(java.lang.String name)
      Supplies the registration name that will be used to search registrations.
      void set_serverRGEAddress(java.lang.Long _serverrge)
      Sets the server RGE address used by the search object.
      void set_serverRGEAddressOperator(java.lang.String operator)
      Sets the value of the server RGE address operator.
      void set_state(java.lang.Integer state)
      Sets the state value used by the search object.
      void set_stateOperator(java.lang.String stateOperator)
      Sets the value of the state operator.
      void set_uuid(java.lang.String uuid)
      Sets the uuid that will be used to search registered servers.
      void set_version(java.lang.Short _version)
      Sets the version value used by the search object.
      void set_versionOperator(java.lang.String operator)
      Sets the value of the version operator.
      java.lang.String toString()
      toString method.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • OLASearchObject

        public OLASearchObject()
        Default constructor
    • Method Detail

      • get_name

        public java.lang.String get_name()
        Returns the registration name that will be used to search registrations. If null is returned, the registration name is not used to match registrations.
        Returns:
        the registration name used to search for registrations.
      • set_name

        public void set_name(java.lang.String name)
        Supplies the registration name that will be used to search registrations.
        Parameters:
        name - the registration name used to search for registrations.
      • get_jobName

        public java.lang.String get_jobName()
        Returns the job name that will be used to search registrations. Any registrations which were created by this job name will be matched. If null is returned, the job name is not used to match registrations.
        Returns:
        the job name used by the search object
      • set_jobName

        public void set_jobName(java.lang.String jobName)
        Sets the job name that will be used to search registrations. Any registrations which were created by this job name will be matched.
        Parameters:
        jobName - the job name used by the search object
      • get_jobNum

        public java.lang.String get_jobNum()
        Returns the job number that will be used to search registrations. Any registrations created by this job number will be matched. If null is returned, the job number is not used to match registrations.
        Returns:
        the job number used by the search object
      • set_jobNum

        public void set_jobNum(java.lang.String jobNum)
        Sets the job number that will be used to search registrations. Any registrations created by this job number will be matched. Note that the job number is supplied as a string.
        Parameters:
        jobNum - the job number used by the search object
      • get_uuid

        public java.lang.String get_uuid()
        Returns the uuid that will be used to search registered servers. Any WebSphere Application Server for z/OS server instance using this uuid will be matched. If null is returned, the uuid is not used to match registrations.
        Returns:
        the uuid used by the search object.
      • set_uuid

        public void set_uuid(java.lang.String uuid)
        Sets the uuid that will be used to search registered servers. Any WebSphere Application Server for z/OS server instance using this uuid will be matched.
        Parameters:
        uuid - the uuid used by the search object
      • get_flagDaemonType

        public java.lang.Boolean get_flagDaemonType()
        Returns the value of the daemon registration flag used by the search object. If the flag is set to true, any registrations representing WebSphere Application Server for z/OS daemon processes will be returned. If this method returns null, this flag is not used to match registrations.
        Returns:
        the daemon flag value
      • set_flagDaemonType

        public void set_flagDaemonType(java.lang.Boolean daemonType)
        Sets the value of the daemon registration flag used by the search object. If the flag is set to true, any registrations representing WebSphere Application Server for z/OS daemon processes will be returned.
        Parameters:
        daemonType - the value of the daemon flag variable
      • get_flagServerType

        public java.lang.Boolean get_flagServerType()
        Returns the value of the server registration flag used by the search object. If the flag is set to true, any registrations representing WebSphere Application Server for z/OS server processes will be returned. If this method returns null, this flag is not used to match registrations.
        Returns:
        the server flag value
      • set_flagServerType

        public void set_flagServerType(java.lang.Boolean serverType)
        Sets the value of the server registration flag used by the search object. If the flag is set to true, any registrations representing WebSphere Application Server for z/OS server processes will be returned.
        Parameters:
        serverType - the value of the server flag variable
      • get_flagExternalAddressType

        public java.lang.Boolean get_flagExternalAddressType()
        Returns the value of the external address space flag used by the search object. If the flag is set to true, any registration representing client registrations will be returned. These are registrations created by an address space using the BBOA1REG API. If this method returns null, the external address space flag is not used to match registrations.
        Returns:
        the value of the external address space flag
      • set_flagExternalAddressType

        public void set_flagExternalAddressType(java.lang.Boolean externalAddressType)
        Sets the value of the external address space flag used by the search object. If the flag is set to true, any registrations representing client registrations will be returned. These are registrations created by an address space using the BBOA1REG API.
        Parameters:
        externalAddressType - the value of the external address space flag
      • get_flagSecurity

        public java.lang.Boolean get_flagSecurity()
        Returns the value of the security flag used by the search object. If the flag is set to true, any registrations made with security enabled on the BBOA1REG call will be returned. If this method returns null, the security flag is not used to match registrations.
        Returns:
        the value of the security flag
      • set_flagSecurity

        public void set_flagSecurity(java.lang.Boolean security)
        Sets the value of the security flag used by the search object. If the flag is set to true, any registrations made with security enabled on the BBOA1REG call will be returned.
        Parameters:
        security - the the value of the security flag to set
      • get_flagTransactionSupport

        public java.lang.Boolean get_flagTransactionSupport()
        Returns the value of the transaction flag used by the search object. If the flag is set to true, any registrations specifying transactions on the BBOA1REG call will be returned. If null is returned, the transaction flag is not used to match registrations.
        Returns:
        the value of the transaction flag
      • set_flagTransactionSupport

        public void set_flagTransactionSupport(java.lang.Boolean transactionSupport)
        Sets the value of the transaction flag used by the search object. If the flag is set to true, any registrations specifying transactions on the BBOA1REG call will be returned.
        Parameters:
        transactionSupport - the value of the transaction flag
      • get_flagActive

        public java.lang.Boolean get_flagActive()
        Returns the value of the active flag used by the search object. If the flag is set to true, only active registrations will be returned. All registrations are considered active unless they have been unregistered with the BBOA1URG API, or the address space performing the registration terminates. If null is returned, the active flag is not used to match registrations.
        Returns:
        the value of the active flag
      • set_flagActive

        public void set_flagActive(java.lang.Boolean active)
        Sets the value of the active flag used by the search object. If the flag is set to true, only active registrations will be returned. All registrations are considered active unless they have been unregistered with the BBOA1URG API, or the address space performing the registration terminates. No guarantees are made as to the behavior when returning inactive registrations, as the control blocks used to store the registration information are deleted during the unregister process.
        Parameters:
        active - the value of the active flag
      • get_minConnections

        public java.lang.Integer get_minConnections()
        Returns the number of minimum connections used by the search object. If this value is set, it is used along with the minConnectionsOperator to build a list of matching registrations. If null is returned, the minimum number of connections is not used to match registrations.
        Returns:
        the value of minConnections
      • set_minConnections

        public void set_minConnections(java.lang.Integer connections)
        Sets the number of minimum connections used by the search object. This value is used along with the minConnectionsOperator to build a list of matching registrations.
        Parameters:
        connections - the value of minimum connections
      • get_minConnectionsOperator

        public java.lang.String get_minConnectionsOperator()
        Returns the value of the minimum connections operator. The operator is used along with the value of minConnections to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the minConnections operator
      • set_minConnectionsOperator

        public void set_minConnectionsOperator(java.lang.String connectionsOperator)
        Sets the value of the minimum connections operator. The operator is used along with the value of minConnections to build a list of matching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for minConnections is used to build the following conditional expression: registrationValue operator minConnectionsValue. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        connectionsOperator - the minConnectionsOperator to set
      • get_maxConnections

        public java.lang.Integer get_maxConnections()
        Returns the number of maximum connections used by the search object. If this value is set, it is used along with the maxConnectionsOperator to build a list of matching registrations. If null is returned, the maximum number of connections is not used to match registrations.
        Returns:
        the value of maxConnections
      • set_maxConnections

        public void set_maxConnections(java.lang.Integer connections)
        Sets the number of maximum connections used by the search object. This value is used along with the maxConnectionsOperator to build a list of matching registrations.
        Parameters:
        connections - the value of maximum connections
      • get_maxConnectionsOperator

        public java.lang.String get_maxConnectionsOperator()
        Returns the value of the maximum connections operator. The operator is used along with the value of maxConnections to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the maxConnections operator
      • set_maxConnectionsOperator

        public void set_maxConnectionsOperator(java.lang.String connectionsOperator)
        Sets the value of the maximum connections operator. The operator is used along with the value of maxConnections to build a list of matching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for maxConnections is used to build the following conditional expression: registrationValue operator maxConnectionsValue. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        connectionsOperator - the maxConnectionsOperator to set
      • get_currentActiveConnectionCount

        public java.lang.Integer get_currentActiveConnectionCount()
        Returns the number of active connections used by the search object. If this value is set, it is used along with the currentActiveConnectionsOperator to build a list of matching registrations. If null is returned, the number of active connections is not used to match registrations.
        Returns:
        the value of activeConnectionCount
      • set_currentActiveConnectionCount

        public void set_currentActiveConnectionCount(java.lang.Integer activeConnectionCount)
        Sets the number of active connections used by the search object. This value is used along with the currentActiveConnectionsOperator to build a list of matching registrations.
        Parameters:
        activeConnectionCount - the value of active connections
      • get_currentActiveConnectionCountOperator

        public java.lang.String get_currentActiveConnectionCountOperator()
        Returns the value of the active connections operator. The operator is used along with the value of currentActiveConnectionCount to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the currentActiveConnectionCount operator
      • set_currentActiveConnectionCountOperator

        public void set_currentActiveConnectionCountOperator(java.lang.String activeConnectionCountOperator)
        Sets the value of the active connections operator. The operator is used along with the value of currentActiveConnectionCount to build a list of m atching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for currentActiveConnectionCount is used to build the following conditional expression: registrationValue operator currentActiveConnectionCount. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        activeConnectioncountOperator - the currentActiveConnectionsOperator to set
      • get_state

        public java.lang.Integer get_state()
        Returns the state value used by the search object. If this value is set, it is used along with the stateOperator to build a list of matching registrations. If null is returned, the state is not used to match registrations.
        Returns:
        the state used by the search object
      • set_state

        public void set_state(java.lang.Integer state)
        Sets the state value used by the search object. This value is used along with the stateOperator to build a list of matching registrations.
        Parameters:
        state - the state value used by the search object
      • get_stateOperator

        public java.lang.String get_stateOperator()
        Returns the value of the state operator. The operator is used along with the value of state to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the state operator
      • set_stateOperator

        public void set_stateOperator(java.lang.String stateOperator)
        Sets the value of the state operator. The operator is used along with the value of state to build a list of matching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for state is used to build the following conditional expression: registrationValue operator state. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        stateOperator - the stateOperator to set
      • get_version

        public java.lang.Short get_version()
        Returns the version value used by the search object. If this value is set, it is used along with the versionOperator to build a list of matching registrations. If null is returned, the version is not used to match registrations.
        Returns:
        the version used by the search object
      • set_version

        public void set_version(java.lang.Short _version)
        Sets the version value used by the search object. This value is used along with the versionOperator to build a list of matching registrations.
        Parameters:
        _version - the version value used by the search object
      • get_versionOperator

        public java.lang.String get_versionOperator()
        Returns the value of the version operator. The operator is used along with the value of version to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the version operator
      • set_versionOperator

        public void set_versionOperator(java.lang.String operator)
        Sets the value of the version operator. The operator is used along with the value of version to build a list of matching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for version is used to build the following conditional expression: registrationValue operator version. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        operator - the versionOperator to set
      • get_serverRGEAddress

        public java.lang.Long get_serverRGEAddress()
        Returns the server RGE address used by the search object. If this value is set, it is used along with the serverRGEAddressOperator to build a list of matching registrations. If null is returned, the server RGE address is not used to match registrations.
        Returns:
        the server RGE address used by the search object
      • set_serverRGEAddress

        public void set_serverRGEAddress(java.lang.Long _serverrge)
        Sets the server RGE address used by the search object. This value is used along with the serverRGEAddressOperator to build a list of matching registrations. The server RGE address can be located with help from IBM Support to help diagnose certain kinds of problems with the Optimized Local Adapter.
        Parameters:
        _serverrge - The server RGE address
      • get_serverRGEAddressOperator

        public java.lang.String get_serverRGEAddressOperator()
        Returns the value of the server RGE address operator. The operator is used along with the server RGE address to build a list of matching registrations. If null is returned, an operator of "=" is implied.
        Returns:
        the server RGE address operator
      • set_serverRGEAddressOperator

        public void set_serverRGEAddressOperator(java.lang.String operator)
        Sets the value of the server RGE address operator. The operator is used along with the value of server RGE address to build a list of matching registrations. The operator can be one of the following values: =, >, <, >= or <=. The registration's value for server RGE address is used to build the following conditional expression: registrationValue operator version. If this expression is true, the registration matches and is added to the list of matching registrations.
        Parameters:
        operator - the serverRGEAddressOperator to set
      • toString

        public java.lang.String toString()
        toString method. Displays options all on the same line.
        Overrides:
        toString in class java.lang.Object