com.ibm.websphere.ola

Class OLARGEInformation

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


    public class OLARGEInformation
    extends java.lang.Object
    implements java.io.Serializable
    Object encapsulating the details of an Optimized Local Adapters registration
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      OLARGEInformation(OLARGE currentRGE)
      Constructor that takes a OLARGE object as a parameter, and sets all of the attributes of the current OLARGEInformation object with the same attributes of the passed in RGE.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object thatObject)
      Equals
      java.lang.Long get_argeActiveConnectionCount()
      If this registration represents a client, returns the number of currently active connections.
      java.lang.Integer get_argeConnectionsMax()
      If this registration represents a client, returns the maximum number of connections in the connection pool.
      java.lang.Integer get_argeConnectionsMin()
      If this registration represents a client, returns the minimum number of connections in the connection pool.
      java.lang.String get_argeEye()
      Returns the value of the eye catcher for this registration
      java.lang.Boolean get_argeFlagActive()
      Indicates that this registration is active
      java.lang.Boolean get_argeFlagDaemon()
      Indicates that this registration represents a WebSphere Application Server for z/OS daemon address space.
      java.lang.Boolean get_argeFlagExternalAddress()
      Indicates that this registration represents a client registration.
      java.lang.Boolean get_argeFlagSecurity()
      Indicates that this registration was created with security enabled
      java.lang.Boolean get_argeFlagServer()
      Indicates that this registration represents a WebSphere Application Server for z/OS server address space
      java.lang.Boolean get_argeFlagTransaction()
      Indicates that this registration was created with transactions enabled
      java.lang.Boolean get_argeFlagWLM()
      Indicates that this registration supports the propagation of the transaction ID from a CICS performance block into WebSphere.
      java.lang.String get_argeJobName()
      Returns the name of the job which created this registration
      java.lang.Integer get_argeJobNum()
      Returns the job number which created this registration
      java.lang.String get_argeName()
      Returns the register name for this registration
      java.lang.Integer get_argeSize()
      Returns the number of bytes of memory used by the registration object
      java.lang.Long get_argeState()
      Returns the state of the registration
      java.lang.Integer get_argeTraceLevel()
      Returns the level of tracing used by this registration
      java.lang.String get_argeUUID()
      If this registration represents a WebSphere Application Server for z/OS server, returns the UUID for that server.
      java.lang.Short get_argeVersion()
      Returns the version of the registration
      java.util.Iterator<OLAConnectionHandle> getConnectionHandlesIterator()
      Returns a list of objects representing the active connection handles for this registration
      java.lang.String getTypeString()
      Displays the RGE type.
      int hashCode()
      Hash code
      java.lang.String toString()
      Formats all of the OLARGEInformation information to a human readable format.
      • Methods inherited from class java.lang.Object

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

      • OLARGEInformation

        public OLARGEInformation(OLARGE currentRGE)
                          throws java.lang.Exception
        Constructor that takes a OLARGE object as a parameter, and sets all of the attributes of the current OLARGEInformation object with the same attributes of the passed in RGE.
        Parameters:
        currentRGE - The RGE that the information will be copied from
        Throws:
        java.lang.Exception
    • Method Detail

      • get_argeEye

        public java.lang.String get_argeEye()
        Returns the value of the eye catcher for this registration
        Returns:
        the eye catcher as a string
      • get_argeVersion

        public java.lang.Short get_argeVersion()
        Returns the version of the registration
        Returns:
        the version number
      • get_argeSize

        public java.lang.Integer get_argeSize()
        Returns the number of bytes of memory used by the registration object
        Returns:
        the number of bytes of memory used by the registration object
      • get_argeFlagDaemon

        public java.lang.Boolean get_argeFlagDaemon()
        Indicates that this registration represents a WebSphere Application Server for z/OS daemon address space.
        Returns:
        true if a daemon
      • get_argeFlagServer

        public java.lang.Boolean get_argeFlagServer()
        Indicates that this registration represents a WebSphere Application Server for z/OS server address space
        Returns:
        true if a server
      • get_argeFlagExternalAddress

        public java.lang.Boolean get_argeFlagExternalAddress()
        Indicates that this registration represents a client registration.
        Returns:
        true if a client
      • get_argeFlagSecurity

        public java.lang.Boolean get_argeFlagSecurity()
        Indicates that this registration was created with security enabled
        Returns:
        true if security is enabled
      • get_argeFlagWLM

        public java.lang.Boolean get_argeFlagWLM()
        Indicates that this registration supports the propagation of the transaction ID from a CICS performance block into WebSphere.
        Returns:
        true if transaction ID is propagated
      • get_argeFlagTransaction

        public java.lang.Boolean get_argeFlagTransaction()
        Indicates that this registration was created with transactions enabled
        Returns:
        true if transactions are enabled
      • get_argeFlagActive

        public java.lang.Boolean get_argeFlagActive()
        Indicates that this registration is active
        Returns:
        true if active
      • get_argeName

        public java.lang.String get_argeName()
        Returns the register name for this registration
        Returns:
        the register name
      • get_argeJobName

        public java.lang.String get_argeJobName()
        Returns the name of the job which created this registration
        Returns:
        the job name
      • get_argeJobNum

        public java.lang.Integer get_argeJobNum()
        Returns the job number which created this registration
        Returns:
        the job number
      • get_argeUUID

        public java.lang.String get_argeUUID()
        If this registration represents a WebSphere Application Server for z/OS server, returns the UUID for that server.
        Returns:
        the UUID for a server, or null if this registration does not represent a server
      • get_argeConnectionsMin

        public java.lang.Integer get_argeConnectionsMin()
        If this registration represents a client, returns the minimum number of connections in the connection pool.
        Returns:
        the minimum number of connections in the connection pool.
      • get_argeConnectionsMax

        public java.lang.Integer get_argeConnectionsMax()
        If this registration represents a client, returns the maximum number of connections in the connection pool.
        Returns:
        the maximum number of connections in the connection pool.
      • get_argeActiveConnectionCount

        public java.lang.Long get_argeActiveConnectionCount()
        If this registration represents a client, returns the number of currently active connections.
        Returns:
        the number of active connections
      • get_argeTraceLevel

        public java.lang.Integer get_argeTraceLevel()
        Returns the level of tracing used by this registration
        Returns:
        the trace level
      • get_argeState

        public java.lang.Long get_argeState()
        Returns the state of the registration
        Returns:
        the state
      • getConnectionHandlesIterator

        public java.util.Iterator<OLAConnectionHandle> getConnectionHandlesIterator()
        Returns a list of objects representing the active connection handles for this registration
        Returns:
        A list of objects representing connection handles for this registration.
      • getTypeString

        public java.lang.String getTypeString()
        Displays the RGE type. Could be one of three: 'd' for daemon, 's' for server, or 'e' for external address space (client).
        Returns:
        The RGE type, as a single character string
      • toString

        public java.lang.String toString()
        Formats all of the OLARGEInformation information to a human readable format.
        Overrides:
        toString in class java.lang.Object
      • hashCode

        public int hashCode()
        Hash code
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals(java.lang.Object thatObject)
        Equals
        Overrides:
        equals in class java.lang.Object