com.ibm.websphere.ola

Interface OLARGE



  • public interface OLARGE
    • Method Detail

      • get_argeEye

        java.lang.String get_argeEye()
                                     throws java.lang.Exception
        Throws:
        java.lang.Exception
      • parseArgeEye

        void parseArgeEye()
                          throws java.io.UnsupportedEncodingException,
                                 OLAException
        Parses the arge name from shared memory, and sets the member attribute.
        Throws:
        java.io.UnsupportedEncodingException - if it cannot convert to codepage 1047
        OLAException - if the eye does not have the appropriate value of "BBOARGE "
      • get_argeName

        java.lang.String get_argeName()
                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • parseArgeName

        void parseArgeName()
                           throws java.io.UnsupportedEncodingException
        Parses the arge name from shared memory, and sets the member attribute.
        Throws:
        java.io.UnsupportedEncodingException - if it cannot convert to codepage 1047
      • get_argeJobName

        java.lang.String get_argeJobName()
                                         throws java.lang.Exception
        Throws:
        java.lang.Exception
      • parseArgeJobName

        void parseArgeJobName()
                              throws java.io.UnsupportedEncodingException
        Parses the arge job name from shared memory, and sets the member attribute.
        Throws:
        java.io.UnsupportedEncodingException - if it cannot convert to codepage 1047
      • get_argeUUID

        java.lang.String get_argeUUID()
                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • parseArgeUUID

        void parseArgeUUID()
                           throws java.io.UnsupportedEncodingException
        Parses the UUID name from shared memory, and sets the member attribute.
        Throws:
        java.io.UnsupportedEncodingException - if it cannot convert to codepage 1047
      • get_argeVersion

        java.lang.Short get_argeVersion()
      • parseArgeVersion

        void parseArgeVersion()
        Parses the Version from shared memory, and sets the member attribute.
      • get_argeSize

        java.lang.Integer get_argeSize()
      • parseArgeSize

        void parseArgeSize()
        Parses the Size from shared memory, and sets the member attribute.
      • get_argeJobNum

        java.lang.Integer get_argeJobNum()
      • parseArgeJobNum

        void parseArgeJobNum()
        Parses the job number from shared memory, and sets the member attribute.
      • get_argeConnectionsMin

        java.lang.Integer get_argeConnectionsMin()
      • parseArgeConnectionsMin

        void parseArgeConnectionsMin()
        Parses the minimum connections value from shared memory, and sets the member attribute.
      • get_argeConnectionsMax

        java.lang.Integer get_argeConnectionsMax()
      • parseArgeConnectionsMax

        void parseArgeConnectionsMax()
        Parses the maximum connections value from shared memory, and sets the member attribute.
      • get_argeActiveConnectionCount

        java.lang.Long get_argeActiveConnectionCount()
      • parseArgeActiveConnectionCount

        void parseArgeActiveConnectionCount()
        Parses the number of current active connections from shared memory, and sets the member attribute.
      • get_argeTraceLevel

        java.lang.Integer get_argeTraceLevel()
      • parseArgeTraceLevel

        void parseArgeTraceLevel()
        Parses the trace level from shared memory, and sets the member attribute.
      • get_argeState

        java.lang.Long get_argeState()
      • parseArgeState

        void parseArgeState()
        Parses the RGE state from shared memory, and sets the member attribute.
      • get_argeFlagDaemon

        java.lang.Boolean get_argeFlagDaemon()
      • parseArgeFlags

        void parseArgeFlags()
        Parses the type, transaction, and active flags from shared memory, and sets the member attribute. This is done all at once because these flags are all stored in the same byte. The bits are set as follows, from left to right: 1 - RGE daemon type flag 2 - RGE server type flag 3 - RGE external address space type flag 7 - Transactions supported flag 8 - Active RGE flag
      • get_argeFlagServer

        java.lang.Boolean get_argeFlagServer()
      • get_argeFlagExternalAddress

        java.lang.Boolean get_argeFlagExternalAddress()
      • get_argeFlagSecurity

        java.lang.Boolean get_argeFlagSecurity()
      • get_argeFlagWLM

        java.lang.Boolean get_argeFlagWLM()
      • get_argeFlagTransaction

        java.lang.Boolean get_argeFlagTransaction()
      • get_argeFlagActive

        java.lang.Boolean get_argeFlagActive()
      • get_argeServerRGEAddress

        long get_argeServerRGEAddress()
      • get_argeNextRGEAddress

        long get_argeNextRGEAddress()
      • get_argeConnectionPoolRGEAddress

        long get_argeConnectionPoolRGEAddress()
      • get_absoluteAddress

        long get_absoluteAddress()
      • parseAllAttributes

        void parseAllAttributes()
                                throws java.lang.Exception
        Sets all the values from shared memory. This method is to be called before returning an object to a user. This is because once it is sent elsewhere (eg a different jvm) it will not have access to the shared memory byte buffer, so it retrieves all of its values while it still can.
        Throws:
        java.lang.Exception
      • parseConnectionHandles

        void parseConnectionHandles()
      • toString

        java.lang.String toString()
        toString method for OLA RGE. Uses getter methods, which will parse values form the byte buffer as needed.
        Overrides:
        toString in class java.lang.Object