edg.workload.userinterface.jclient
Class Event

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--edg.workload.userinterface.jclient.InfoLB
                    |
                    +--edg.workload.userinterface.jclient.Event
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class Event
extends InfoLB

LB Event Class Wrapped.

During its life-cycle, the job logs several events to the logging server. Each of them is represented by a series of couple attribute name, attribute value. This class is used in order to represent a single event

See Also:
Serialized Form

Field Summary
static java.lang.String[] attrNames
          This array contains the name of all the possible events attributes
static int CLASSAD
          Event attribute - Chkpt: checkpoint value
static java.lang.String[] code
          This array contains the possible Event names
static int CODE_ABORT
          Possible value returned by code() method.
static int CODE_ACCEPTED
          Possible value returned by code() method.
static int CODE_CANCEL
          Possible value returned by code() method.
static int CODE_CHKPT
          Possible value returned by code() method.
static int CODE_CLEAR
          Possible value returned by code() method.
static int CODE_CURDESCR
          Possible value returned by code() method.
static int CODE_DEQUEUED
          Possible value returned by code() method.
static int CODE_DONE
          Possible value returned by code() method.
static int CODE_ENQUEUED
          Possible value returned by code() method.
static int CODE_HELPERCALL
          Possible value returned by code() method.
static int CODE_HELPERRETURN
          Possible value returned by code() method.
static int CODE_LISTENER
          Possible value returned by code() method.
static int CODE_MATCH
          Possible value returned by code() method.
static int CODE_PENDING
          Possible value returned by code() method.
static int CODE_PURGE
          Possible value returned by code() method.
static int CODE_REFUSED
          Possible value returned by code() method.
static int CODE_REGJOB
          Possible value returned by code() method.
static int CODE_RESUBMISSION
          Possible value returned by code() method.
static int CODE_RUNNING
          Possible value returned by code() method.
static int CODE_TRANSFER
          Possible value returned by code() method.
static int CODE_TYPE_MAX
           
static int CODE_UNDEF
          Possible value returned by code() method.
static int CODE_USERTAG
          Possible value returned by code() method.
static int DESCR
          Event attribute - CurDescr: description of current job transformation (output of helper)
static int DEST_HOST
          Event attribute - Transfer: destination hostname
static int DEST_ID
          Event attribute - Match: Id of the destination CE/queue
static int DEST_INSTANCE
          Event attribute - Transfer: destination instance
static int DEST_JOBID
          Event attribute - Transfer: destination internal jobid
static int DESTINATION
          Event attribute - Transfer: destination where the job is being transfered to
static int EVENT
          The Event string name attribute
static int EVENT_CODE
          The Event code integer attribute
static int EXIT_CODE
          Event attribute - Done: process exit code
static int FROM
          Event attribute Accepted: where was the job received from Refused: where was the job received from
static int FROM_HOST
          Event attribute Accepted: sending component hostname Refused: sending component hostname
static int FROM_INSTANCE
          Event attribute Accepted: sending component instance Refused: sending component instance
static int HELPER_NAME
          Event attribute HelperCall: name of the called component HelperReturn: name of the called component
static int HELPER_PARAMS
          Event attribute - HelperCall: parameters of the call
static int HOST
          Event attribute - common: hostname of the machine where the event was generated
static int JDL
          Event attribute - RegJob: job description
static int JOB
          Event attribute EnQueued: job description in receiver language Transfer: job description in receiver language
static int JOBID
          Event attribute - common: DataGrid job id of the source job
static int JOTYPE
          Event attribute - common: DataGrid job id of the source job
static int LEVEL
          Event attribute - common: logging level (system, debug, ...)
static int LOCAL_JOBID
          Event attribute Accepted: new jobId (Condor, Globus ...) assigned by the receiving component.
static int NAME
          Event attribute - UserTag: tag name
static int NODE
          Event attribute - Running: worker node where the executable is run
static int NS
          Event attribute - RegJob: NetworkServer handling the job
static int NSUBJOBS
          Event attribute - RegJob: number of subjobs
static int OPERATION
          ChangeACL: operation requested to perform with ACL (add, remove)
static int PARENT
          Event attribute - RegJob: jobid of parent job
static int PERMISSION
          ChangeACL: ACL permission to change (currently only READ)
static int PERMISSION_TYPE
          ChangeACL: type of permission requested ('allow', 'deny')
static int PRIORITY
          Event attribute - common: message priority (yet 0 for asynchronous and 1 for synchronous transfers)
static int QUEUE
          Event attribute - DeQueued: queue name * EnQueued: destination queue
static int REASON
          Event attribute - Abort: reason of abort Cancel: detailed description Clear: why the job was cleared Done: reason for the change EnQueued: detailed description of transfer, especially reason of failure Pending: why matching CE cannot be found Refused: reason of refusal Resubmission: reason for the decision Transfer: detailed description of transfer, especially reason of failure
static int RESULT
          Event attribute - EnQueued: result of the attempt Resubmission: result code Transfer: result of the attempt
static int RETVAL
          Event attribute - HelperReturn: returned data
static int SEED
          Event attribute - RegJob: seed for subjob id generation
static int SEQCODE
          Event attribute - common: sequence code assigned to the event
static int SOURCE
          Event attribute - common: source (WMS component) which generated this event
static int SRC_INSTANCE
          Event attribute - common: instance of WMS component (e.g. service communication endpoint)
static int SRC_ROLE
          Event attribute HelperCall: whether the logging component is called or calling one HelperReturn: whether the logging component is called or calling one
static int STATUS_CODE
          Event attribute - Cancel: classification of the cancel * Done: way of termination
static int SVC_HOST
          Event attribute - Listener: hostname
static int SVC_NAME
          Event attribute - Listener: port instance name
static int SVC_PORT
          Event attribute - Listener: port number
static int TAG
          Event attribute Chkpt: checkpoint tag Resubmission: value of the attribute on which the decision is based
static int TIMESTAMP
          Event attribute - common: timestamp of event generation
static int USER
          Event attribute - common: identity (cert. subj.) of the generator
static int USER_ID
          ChangeACL: DN or VOMS parameter (in format VO:group)
static int USER_ID_TYPE
          ChangeACL: type of information given in user_id (DN or VOMS)
static int VALUE
          Event attribute - UserTag: tag value
 
Fields inherited from class edg.workload.userinterface.jclient.InfoLB
DEFAULT_LOG_LEVEL, HIGH_LOG_LEVEL, NORMAL_LOG_LEVEL
 
Constructor Summary
Event()
           
 
Method Summary
 int code()
          Retreive the EVENT_CODE field
 java.lang.String name()
          Retrieve the EVENT field
 java.lang.String toString()
          Retrieve the string representation of the Event.
 java.lang.String toString(int level)
          Return a String representation of the Event
 
Methods inherited from class edg.workload.userinterface.jclient.InfoLB
get, getValInt, getValString
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

code

public static final java.lang.String[] code
This array contains the possible Event names


attrNames

public static final java.lang.String[] attrNames
This array contains the name of all the possible events attributes


CODE_UNDEF

public static final int CODE_UNDEF
Possible value returned by code() method. Undefined code. Should never happen

See Also:
Constant Field Values

CODE_TRANSFER

public static final int CODE_TRANSFER
Possible value returned by code() method. Start, success, or failure of job transfer to another component

See Also:
Constant Field Values

CODE_ACCEPTED

public static final int CODE_ACCEPTED
Possible value returned by code() method. Accepting job (successful couterpart to Transfer)

See Also:
Constant Field Values

CODE_REFUSED

public static final int CODE_REFUSED
Possible value returned by code() method. Refusing job (unsuccessful couterpart to Transfer)

See Also:
Constant Field Values

CODE_ENQUEUED

public static final int CODE_ENQUEUED
Possible value returned by code() method. The job has been enqueued in an inter-component queue

See Also:
Constant Field Values

CODE_DEQUEUED

public static final int CODE_DEQUEUED
Possible value returned by code() method. The job has been dequeued from an inter-component queue

See Also:
Constant Field Values

CODE_HELPERCALL

public static final int CODE_HELPERCALL
Possible value returned by code() method. Helper component is called

See Also:
Constant Field Values

CODE_HELPERRETURN

public static final int CODE_HELPERRETURN
Possible value returned by code() method. Helper component is returning the control

See Also:
Constant Field Values

CODE_RUNNING

public static final int CODE_RUNNING
Possible value returned by code() method. Executable started

See Also:
Constant Field Values

CODE_RESUBMISSION

public static final int CODE_RESUBMISSION
Possible value returned by code() method. Result of resubmission decision

See Also:
Constant Field Values

CODE_DONE

public static final int CODE_DONE
Possible value returned by code() method. Execution terminated (normally or abnormally)

See Also:
Constant Field Values

CODE_CANCEL

public static final int CODE_CANCEL
Possible value returned by code() method. Cancel operation has been attempted on the job

See Also:
Constant Field Values

CODE_ABORT

public static final int CODE_ABORT
Possible value returned by code() method. Job aborted by system

See Also:
Constant Field Values

CODE_CLEAR

public static final int CODE_CLEAR
Possible value returned by code() method. Job cleared, output sandbox removed

See Also:
Constant Field Values

CODE_PURGE

public static final int CODE_PURGE
Possible value returned by code() method. Job is purged from bookkepping server

See Also:
Constant Field Values

CODE_MATCH

public static final int CODE_MATCH
Possible value returned by code() method. Matching CE found

See Also:
Constant Field Values

CODE_PENDING

public static final int CODE_PENDING
Possible value returned by code() method. No match found yet

See Also:
Constant Field Values

CODE_REGJOB

public static final int CODE_REGJOB
Possible value returned by code() method. New job registration

See Also:
Constant Field Values

CODE_CHKPT

public static final int CODE_CHKPT
Possible value returned by code() method. Application-specific checkpoint record

See Also:
Constant Field Values

CODE_LISTENER

public static final int CODE_LISTENER
Possible value returned by code() method. Listening network port for interactive control

See Also:
Constant Field Values

CODE_CURDESCR

public static final int CODE_CURDESCR
Possible value returned by code() method. current state of job processing (optional event)

See Also:
Constant Field Values

CODE_USERTAG

public static final int CODE_USERTAG
Possible value returned by code() method. user tag -- arbitrary name=value pair

See Also:
Constant Field Values

CODE_TYPE_MAX

public static final int CODE_TYPE_MAX
See Also:
Constant Field Values

CLASSAD

public static final int CLASSAD
Event attribute - Chkpt: checkpoint value

See Also:
Constant Field Values

DESCR

public static final int DESCR
Event attribute - CurDescr: description of current job transformation (output of helper)

See Also:
Constant Field Values

DEST_HOST

public static final int DEST_HOST
Event attribute - Transfer: destination hostname

See Also:
Constant Field Values

DEST_ID

public static final int DEST_ID
Event attribute - Match: Id of the destination CE/queue

See Also:
Constant Field Values

DEST_INSTANCE

public static final int DEST_INSTANCE
Event attribute - Transfer: destination instance

See Also:
Constant Field Values

DEST_JOBID

public static final int DEST_JOBID
Event attribute - Transfer: destination internal jobid

See Also:
Constant Field Values

DESTINATION

public static final int DESTINATION
Event attribute - Transfer: destination where the job is being transfered to

See Also:
Constant Field Values

EXIT_CODE

public static final int EXIT_CODE
Event attribute - Done: process exit code

See Also:
Constant Field Values

FROM

public static final int FROM
Event attribute

Accepted: where was the job received from

Refused: where was the job received from

See Also:
Constant Field Values

FROM_HOST

public static final int FROM_HOST
Event attribute

Accepted: sending component hostname

Refused: sending component hostname

See Also:
Constant Field Values

FROM_INSTANCE

public static final int FROM_INSTANCE
Event attribute

Accepted: sending component instance

Refused: sending component instance

See Also:
Constant Field Values

HELPER_NAME

public static final int HELPER_NAME
Event attribute

HelperCall: name of the called component

HelperReturn: name of the called component

See Also:
Constant Field Values

HELPER_PARAMS

public static final int HELPER_PARAMS
Event attribute - HelperCall: parameters of the call

See Also:
Constant Field Values

HOST

public static final int HOST
Event attribute - common: hostname of the machine where the event was generated

See Also:
Constant Field Values

JDL

public static final int JDL
Event attribute - RegJob: job description

See Also:
Constant Field Values

JOB

public static final int JOB
Event attribute

EnQueued: job description in receiver language

Transfer: job description in receiver language

See Also:
Constant Field Values

JOBID

public static final int JOBID
Event attribute - common: DataGrid job id of the source job

See Also:
Constant Field Values

JOTYPE

public static final int JOTYPE
Event attribute - common: DataGrid job id of the source job

See Also:
Constant Field Values

LEVEL

public static final int LEVEL
Event attribute - common: logging level (system, debug, ...)

See Also:
Constant Field Values

LOCAL_JOBID

public static final int LOCAL_JOBID
Event attribute

Accepted: new jobId (Condor, Globus ...) assigned by the receiving component.

DeQueued: new jobId assigned by the receiving component.

See Also:
Constant Field Values

NAME

public static final int NAME
Event attribute - UserTag: tag name

See Also:
Constant Field Values

NODE

public static final int NODE
Event attribute - Running: worker node where the executable is run

See Also:
Constant Field Values

NS

public static final int NS
Event attribute - RegJob: NetworkServer handling the job

See Also:
Constant Field Values

NSUBJOBS

public static final int NSUBJOBS
Event attribute - RegJob: number of subjobs

See Also:
Constant Field Values

OPERATION

public static final int OPERATION
ChangeACL: operation requested to perform with ACL (add, remove)

See Also:
Constant Field Values

PARENT

public static final int PARENT
Event attribute - RegJob: jobid of parent job

See Also:
Constant Field Values

PERMISSION

public static final int PERMISSION
ChangeACL: ACL permission to change (currently only READ)

See Also:
Constant Field Values

PERMISSION_TYPE

public static final int PERMISSION_TYPE
ChangeACL: type of permission requested ('allow', 'deny')

See Also:
Constant Field Values

PRIORITY

public static final int PRIORITY
Event attribute - common: message priority (yet 0 for asynchronous and 1 for synchronous transfers)

See Also:
Constant Field Values

QUEUE

public static final int QUEUE
Event attribute - DeQueued: queue name * EnQueued: destination queue

See Also:
Constant Field Values

REASON

public static final int REASON
Event attribute - Abort: reason of abort

Cancel: detailed description

Clear: why the job was cleared

Done: reason for the change

EnQueued: detailed description of transfer, especially reason of failure

Pending: why matching CE cannot be found

Refused: reason of refusal

Resubmission: reason for the decision

Transfer: detailed description of transfer, especially reason of failure

See Also:
Constant Field Values

RESULT

public static final int RESULT
Event attribute -

EnQueued: result of the attempt

Resubmission: result code

Transfer: result of the attempt

See Also:
Constant Field Values

RETVAL

public static final int RETVAL
Event attribute - HelperReturn: returned data

See Also:
Constant Field Values

SEED

public static final int SEED
Event attribute - RegJob: seed for subjob id generation

See Also:
Constant Field Values

SEQCODE

public static final int SEQCODE
Event attribute - common: sequence code assigned to the event

See Also:
Constant Field Values

SOURCE

public static final int SOURCE
Event attribute - common: source (WMS component) which generated this event

See Also:
Constant Field Values

SRC_INSTANCE

public static final int SRC_INSTANCE
Event attribute - common: instance of WMS component (e.g. service communication endpoint)

See Also:
Constant Field Values

SRC_ROLE

public static final int SRC_ROLE
Event attribute

HelperCall: whether the logging component is called or calling one

HelperReturn: whether the logging component is called or calling one

See Also:
Constant Field Values

STATUS_CODE

public static final int STATUS_CODE
Event attribute - Cancel: classification of the cancel * Done: way of termination

See Also:
Constant Field Values

SVC_HOST

public static final int SVC_HOST
Event attribute - Listener: hostname

See Also:
Constant Field Values

SVC_NAME

public static final int SVC_NAME
Event attribute - Listener: port instance name

See Also:
Constant Field Values

SVC_PORT

public static final int SVC_PORT
Event attribute - Listener: port number

See Also:
Constant Field Values

TAG

public static final int TAG
Event attribute

Chkpt: checkpoint tag

Resubmission: value of the attribute on which the decision is based

See Also:
Constant Field Values

TIMESTAMP

public static final int TIMESTAMP
Event attribute - common: timestamp of event generation

See Also:
Constant Field Values

USER

public static final int USER
Event attribute - common: identity (cert. subj.) of the generator

See Also:
Constant Field Values

USER_ID

public static final int USER_ID
ChangeACL: DN or VOMS parameter (in format VO:group)

See Also:
Constant Field Values

USER_ID_TYPE

public static final int USER_ID_TYPE
ChangeACL: type of information given in user_id (DN or VOMS)

See Also:
Constant Field Values

VALUE

public static final int VALUE
Event attribute - UserTag: tag value

See Also:
Constant Field Values

EVENT

public static final int EVENT
The Event string name attribute

See Also:
Constant Field Values

EVENT_CODE

public static final int EVENT_CODE
The Event code integer attribute

See Also:
Constant Field Values
Constructor Detail

Event

public Event()
Method Detail

name

public java.lang.String name()
Retrieve the EVENT field

Returns:
the string representation of the event
See Also:
code, the attribute code to be retrieved

code

public int code()
Retreive the EVENT_CODE field

Returns:
the integer representation of the Event code
See Also:
the attribute to be retrieved, a possible returned value, a possible returned value, a possible returned value, a possible returned value, a possible returned value etc...

toString

public java.lang.String toString()
Retrieve the string representation of the Event. It is identical to toString(0)

Overrides:
toString in class InfoLB
Returns:
The string representation of the basic event attributes
See Also:
toString(int)

toString

public java.lang.String toString(int level)
Return a String representation of the Event

Parameters:
level - the verbosity level of toString representation as described in InfoLB class
Returns:
The string representation of the event attributes. The number of the events taken into account depends of the value of the level parameter
See Also:
basical information retrieved, normal information retrieved, full-complete information retrieved