Package com.ibm.websphere.ola
Class OLASearchObject
java.lang.Object
com.ibm.websphere.ola.OLASearchObject
- All Implemented Interfaces:
Serializable
Object used to manage search criteria when searching for registrations
using the Optimized Local Adapters MBean.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the number of active connections used by the search object.Returns the value of the active connections operator.Returns the value of the active flag used by the search object.Returns the value of the daemon registration flag used by the search object.Returns the value of the external address space flag used by the search object.Returns the value of the security flag used by the search object.Returns the value of the server registration flag used by the search object.Returns the value of the transaction flag used by the search object.Returns the job name that will be used to search registrations.Returns the job number that will be used to search registrations.Returns the number of maximum connections used by the search object.Returns the value of the maximum connections operator.Returns the number of minimum connections used by the search object.Returns the value of the minimum connections operator.get_name()Returns the registration name that will be used to search registrations.Returns the server RGE address used by the search object.Returns the value of the server RGE address operator.Returns the state value used by the search object.Returns the value of the state operator.get_uuid()Returns the uuid that will be used to search registered servers.Returns the version value used by the search object.Returns the value of the version operator.voidset_currentActiveConnectionCount(Integer activeConnectionCount) Sets the number of active connections used by the search object.voidset_currentActiveConnectionCountOperator(String activeConnectionCountOperator) Sets the value of the active connections operator.voidset_flagActive(Boolean active) Sets the value of the active flag used by the search object.voidset_flagDaemonType(Boolean daemonType) Sets the value of the daemon registration flag used by the search object.voidset_flagExternalAddressType(Boolean externalAddressType) Sets the value of the external address space flag used by the search object.voidset_flagSecurity(Boolean security) Sets the value of the security flag used by the search object.voidset_flagServerType(Boolean serverType) Sets the value of the server registration flag used by the search object.voidset_flagTransactionSupport(Boolean transactionSupport) Sets the value of the transaction flag used by the search object.voidset_jobName(String jobName) Sets the job name that will be used to search registrations.voidset_jobNum(String jobNum) Sets the job number that will be used to search registrations.voidset_maxConnections(Integer connections) Sets the number of maximum connections used by the search object.voidset_maxConnectionsOperator(String connectionsOperator) Sets the value of the maximum connections operator.voidset_minConnections(Integer connections) Sets the number of minimum connections used by the search object.voidset_minConnectionsOperator(String connectionsOperator) Sets the value of the minimum connections operator.voidSupplies the registration name that will be used to search registrations.voidset_serverRGEAddress(Long _serverrge) Sets the server RGE address used by the search object.voidset_serverRGEAddressOperator(String operator) Sets the value of the server RGE address operator.voidSets the state value used by the search object.voidset_stateOperator(String stateOperator) Sets the value of the state operator.voidSets the uuid that will be used to search registered servers.voidset_version(Short _version) Sets the version value used by the search object.voidset_versionOperator(String operator) Sets the value of the version operator.toString()toString method.
-
Constructor Details
-
OLASearchObject
public OLASearchObject()Default constructor
-
-
Method Details
-
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
Supplies the registration name that will be used to search registrations.- Parameters:
name- the registration name used to search for registrations.
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
toString method. Displays options all on the same line.
-