Module ibm.jzos
Package com.ibm.jzos.wlm

Class ServerClassification

  • public class ServerClassification
extends java.lang.Object
    Class used to represent the server classification needed for WLM Work Unit creation.

    Uses JNI wrappers to the following C Library APIs:

    • __server_classifyCreate
    • __server_classify
    • __server_classifyDestroy
    Since:
    2.3.2
    See Also:
    WorkloadManager.createServerClassification(), WorkUnit

    • Field Detail

      • _SERVER_CLASSIFY_TRANSACTION_CLASS

        public static final int _SERVER_CLASSIFY_TRANSACTION_CLASS
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_TRANSACTION_NAME

        public static final int _SERVER_CLASSIFY_TRANSACTION_NAME
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_USERID

        public static final int _SERVER_CLASSIFY_USERID
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SUBSYSTEM_PARM

        public static final int _SERVER_CLASSIFY_SUBSYSTEM_PARM
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_ACCTINFO

        public static final int _SERVER_CLASSIFY_ACCTINFO
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SOURCELU

        public static final int _SERVER_CLASSIFY_SOURCELU
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_LUNAME

        public static final int _SERVER_CLASSIFY_LUNAME
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_COLLECTION

        public static final int _SERVER_CLASSIFY_COLLECTION
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_CONNECTION

        public static final int _SERVER_CLASSIFY_CONNECTION
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_PACKAGE

        public static final int _SERVER_CLASSIFY_PACKAGE
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_CORRELATION

        public static final int _SERVER_CLASSIFY_CORRELATION
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_PERFORM

        public static final int _SERVER_CLASSIFY_PERFORM
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_PRCNAME

        public static final int _SERVER_CLASSIFY_PRCNAME
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_PRIORITY

        public static final int _SERVER_CLASSIFY_PRIORITY
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SERVCLS

        public static final int _SERVER_CLASSIFY_SERVCLS
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SRVCLSNM

        public static final int _SERVER_CLASSIFY_SRVCLSNM
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_RPTCLSNM

        public static final int _SERVER_CLASSIFY_RPTCLSNM
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_PROCESS_NAME

        public static final int _SERVER_CLASSIFY_PROCESS_NAME
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SUBCOLN

        public static final int _SERVER_CLASSIFY_SUBCOLN
        See Also:
        Constant Field Values

      • _SERVER_CLASSIFY_SCHEDENV

        public static final int _SERVER_CLASSIFY_SCHEDENV
        See Also:
        Constant Field Values

    • Method Detail

      • reset

        public void reset()
           throws ErrnoException
        Reset a server classification instance to its initial state. This is equivalent to destroying the ServerClassification and creating another, and is intended to be a higher performance path for applications which must repeatedly change parameters in a classify area. After calling __server_classify_reset(), the original connection token is reestablished.
        Throws:
        ErrnoException

      • setAccountInfo

        public void setAccountInfo​(java.lang.String value)
                    throws ErrnoException
        Set the account information.
        Parameters:
        value - a string of up to 143 characters containing the account information for the work unit to be created.
        Throws:
        ErrnoException

      • setCollection

        public void setCollection​(java.lang.String value)
                   throws ErrnoException
        Set the customer defined name for a group of associated packages.
        Parameters:
        value - a string of up to 18 characters containing the collection name associated with the work unit to be created.
        Throws:
        ErrnoException

      • setConnection

        public void setConnection​(java.lang.String value)
                   throws ErrnoException
        Set the name associated with the environment creating the workunit.
        Parameters:
        value - a string of up to 8 characters containing the connection name associated with the environment creating the work unit.
        Throws:
        ErrnoException

      • setCorrelation

        public void setCorrelation​(java.lang.String value)
                    throws ErrnoException
        Set the name associated with the user/program creating the work unit.
        Parameters:
        value - a string of up to 12 characters that contains the name associated with the user/program creating the work unit.
        Throws:
        ErrnoException

      • setLUName

        public void setLUName​(java.lang.String value)
               throws ErrnoException
        Set the local LU name associated with the requester.
        Parameters:
        value - a string of up to 8 characters containing the local LU name associated with the requester.
        Throws:
        ErrnoException

      • setNetworkID

        public void setNetworkID​(java.lang.String value)
                  throws ErrnoException
        Set the network ID associated with the requester.
        Parameters:
        value - a string of up to 8 characters containing the network ID associated with the requester.
        Throws:
        ErrnoException

      • setPackage

        public void setPackage​(java.lang.String value)
                throws ErrnoException
        Set the package name for a set of associated SQL statements.
        Parameters:
        value - a string of up to 8 characters containing the package name associated with the work unit to be created.
        Throws:
        ErrnoException

      • setPerformanceGroup

        public void setPerformanceGroup​(java.lang.String value)
                         throws ErrnoException
        Set the performance group number (PGN) associated with the work unit.
        Parameters:
        value - a string of up to 8 characters containing the PGN associated with the work unit to be created.
        Throws:
        ErrnoException

      • setPlan

        public void setPlan​(java.lang.String value)
             throws ErrnoException
        Set the access plan name for a set of associated SQL statements.
        Parameters:
        value - a string of up to 8 characters containing the access plan name associated with the work unit to be created.
        Throws:
        ErrnoException

      • setProcedureName

        public void setProcedureName​(java.lang.String value)
                      throws ErrnoException
        Set the DB2 Stored SQL Procedure name associated with the work unit.
        Parameters:
        value - a string of up to 18 characters containing the DB2 Stored SQL Procedure name associated with the work unit to be created.
        Throws:
        ErrnoException

      • setProcessName

        public void setProcessName​(java.lang.String value)
                    throws ErrnoException
        Set the process name associated with the work unit.
        Parameters:
        value - a string of up to 32 characters containing the Process name associated with the work unit to be created.
        Throws:
        ErrnoException

      • setPriority

        public void setPriority​(int value)
                 throws ErrnoException
        Set the priority associated with the work unit to be created.
        Parameters:
        value - an integer value representing the priority of the work unit to be created.
        Throws:
        ErrnoException

      • setSchedulingEnvironment

        public void setSchedulingEnvironment​(java.lang.String value)
                              throws ErrnoException
        Set the scheduling environment information.
        Parameters:
        value - a string of up to 16 characters containing the scheduling environment name associated with the work unit.
        Throws:
        ErrnoException

      • setSourceLU

        public void setSourceLU​(java.lang.String value)
                 throws ErrnoException
        Set the source LU name associated with the requester.
        Parameters:
        value - a string of up to 17 characters containing the source LU name associated with the requester.
        Throws:
        ErrnoException

      • setSubsystemCollectionName

        public void setSubsystemCollectionName​(java.lang.String value)
                                throws ErrnoException
        Set the subsystem collection name.
        Parameters:
        value - a string of up to 8 characters, containing the subsystem collection name associated with the work unit.
        Throws:
        ErrnoException

      • setSubsystemParameter

        public void setSubsystemParameter​(java.lang.String value)
                           throws ErrnoException
        Set the transaction subsystem parameter.
        Parameters:
        value - a string of up to 255 characters containing the subsystem parameter.
        Throws:
        ErrnoException

      • setTransactionClass

        public void setTransactionClass​(java.lang.String value)
                         throws ErrnoException
        Set the transaction class.
        Parameters:
        value - a string of up to 8 characters containing the name of the transaction.
        Throws:
        ErrnoException

      • setTransactionName

        public void setTransactionName​(java.lang.String value)
                        throws ErrnoException
        Set the transaction name.
        Parameters:
        value - a string of up to 8 characters containing the name of the transaction.
        Throws:
        ErrnoException

      • setUserid

        public void setUserid​(java.lang.String value)
               throws ErrnoException
        Set the user ID.
        Parameters:
        value - a string of up to 8 characters containing the name of the user.
        Throws:
        ErrnoException

      • setClassifyString

        public void setClassifyString​(int field,
                              java.lang.String value)
                       throws ErrnoException
        Generic method for setting a server classification string.
        Parameters:
        field - one of the _SERVER_CLASSIFY_XX constants
        value - the string value
        Throws:
        ErrnoException
        java.lang.IllegalArgumentException - if the field is known to be a non-String type

      • setClassifyInt

        public void setClassifyInt​(int field,
                           int value)
                    throws ErrnoException
        Generic method for setting a server classification integer.
        Parameters:
        field - one of the _SERVER_CLASSIFY_XX constants. Field type=17 (_SERVER_CLASSIFY_CONNTKN) is not allowed.
        value - the integer value
        Throws:
        ErrnoException
        java.lang.IllegalArgumentException - if the field is known to be a non-Integer type or is not allowed.