org.globus.wsrf.utils.log4j
Class LogObject

java.lang.Object
  org.globus.wsrf.utils.log4j.LogObject

public class LogObject
extends java.lang.Object

Class to print logging information in a specified format. The constructor allows for values of standard information and setters are provided for arbitrary name value pairs. In addition, setters are provided for commonly used meta-data like service name, DN and operation providers. Some static convenience methods help in construction of most common logging objects. Since most of the information is immutable, the constructor creates the string representation and stores it in a buffer. When the toString() method is invoked at logging time, a minimal set of data is appended to the buffer and returned.

Field Summary

private java.lang.StringBuffer	buffer
static java.lang.String	CID_NAME
protected java.lang.String	dn
static java.lang.String	DN_NAME
static java.lang.String	EVENT_NAME
static java.lang.String	GID_NAME
static java.lang.String	MSG_NAME
protected java.util.Vector	nameValue
static java.lang.String	OPERATION_NAME
protected java.lang.String	opName
static java.lang.String	PID_NAME
static java.lang.String	PROGRAM_NAME
static java.lang.String	SERVICE_NAME
protected java.lang.String	serviceName
static java.lang.String	STATUS_NAME

Constructor Summary

LogObject(java.lang.String event)

LogObject(java.lang.String event, java.lang.String status)

LogObject(java.lang.String event, java.lang.String status, java.util.Collection nameVal)

LogObject(java.lang.String event, java.lang.String status, java.lang.String message)
Constructor with event value,

LogObject(java.lang.String event, java.lang.String status, java.lang.String message, java.util.Collection nameVal)

LogObject(java.lang.String event_, java.lang.String status_, java.lang.String message_, java.util.Collection nameValue_, java.lang.String gid_, java.lang.String pid_, java.lang.String cid_, java.lang.String program_)
Constructor.

Method Summary

void	addNameValue(java.util.Collection nameVal) Adds a collection of name/value pairs.
void	addNameValue(java.lang.String nameValue) Adds the string as a name/value pair.
static LogObject	getEndObject(java.lang.String event, java.lang.String servicePath)
static LogObject	getEndObject(java.lang.String event, java.lang.String servicePath, java.lang.String operationName) Used to construct log objects to log end of events, with status 0.
static LogObject	getErrorObject(java.lang.String event, java.lang.String servicePath)
static LogObject	getErrorObject(java.lang.String event, java.lang.String servicePath, java.lang.String msg)
static LogObject	getErrorObject(java.lang.String event, java.lang.String servicePath, java.lang.String msg, java.lang.String operationName) Used to construct log object to log errors, with status -1
static LogObject	getStartObject(java.lang.String event, java.lang.String servicePath)
static LogObject	getStartObject(java.lang.String event, java.lang.String servicePath, java.lang.String operationName) Used to construct log object to log start events
static java.lang.String	removeNewLines(java.lang.String value)
void	setDN(java.lang.String dn_) Sets the value for DN_NAME
void	setOperationName(java.lang.String opName_) Sets the value for OPERATION_NAME
void	setServiceName(java.lang.String serviceName_) Sets the value for SERVICE_NAME
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_NAME

public static final java.lang.String EVENT_NAME

See Also:

Constant Field Values

STATUS_NAME

public static final java.lang.String STATUS_NAME

See Also:

Constant Field Values

GID_NAME

public static final java.lang.String GID_NAME

See Also:

Constant Field Values

PID_NAME

public static final java.lang.String PID_NAME

See Also:

Constant Field Values

CID_NAME

public static final java.lang.String CID_NAME

See Also:

Constant Field Values

PROGRAM_NAME

public static final java.lang.String PROGRAM_NAME

See Also:

Constant Field Values

MSG_NAME

public static final java.lang.String MSG_NAME

See Also:

Constant Field Values

DN_NAME

public static final java.lang.String DN_NAME

See Also:

Constant Field Values

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:

Constant Field Values

buffer

private java.lang.StringBuffer buffer

dn

protected java.lang.String dn

serviceName

protected java.lang.String serviceName

opName

protected java.lang.String opName

nameValue

protected java.util.Vector nameValue

Constructor Detail

LogObject

public LogObject(java.lang.String event)

LogObject

public LogObject(java.lang.String event,
                 java.lang.String status)

LogObject

public LogObject(java.lang.String event,
                 java.lang.String status,
                 java.lang.String message)

Constructor with event value,

Parameters:

event -

status -

message -

LogObject

public LogObject(java.lang.String event,
                 java.lang.String status,
                 java.util.Collection nameVal)

LogObject

public LogObject(java.lang.String event,
                 java.lang.String status,
                 java.lang.String message,
                 java.util.Collection nameVal)

LogObject

public LogObject(java.lang.String event_,
                 java.lang.String status_,
                 java.lang.String message_,
                 java.util.Collection nameValue_,
                 java.lang.String gid_,
                 java.lang.String pid_,
                 java.lang.String cid_,
                 java.lang.String program_)

Constructor. The string representation of all values, other than the name/value pairs is initialized in the constructor itself since these values are immutable.

Parameters:

event_ - value for EVENT_NAME

status_ - value for STATUS_NAME

message_ - value for MSG_NAME

nameValue_ - A collection of strings, where each string is a name/value pair

gid_ - value for GID_NAME

pid_ - value for PID_NAME

cid_ - value for CID_NAME

program_ - value for PROGRAM_NAME

Method Detail

addNameValue

public void addNameValue(java.util.Collection nameVal)

Adds a collection of name/value pairs. Strings in the format "name=value".

Parameters:

nameVal -

addNameValue

public void addNameValue(java.lang.String nameValue)

Adds the string as a name/value pair.

Parameters:

nameValue -

setDN

public void setDN(java.lang.String dn_)

Sets the value for DN_NAME

Parameters:

dn_ -

setServiceName

public void setServiceName(java.lang.String serviceName_)

Sets the value for SERVICE_NAME

Parameters:

serviceName_ -

setOperationName

public void setOperationName(java.lang.String opName_)

Sets the value for OPERATION_NAME

Parameters:

opName_ -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getErrorObject

public static LogObject getErrorObject(java.lang.String event,
                                       java.lang.String servicePath)

getErrorObject

public static LogObject getErrorObject(java.lang.String event,
                                       java.lang.String servicePath,
                                       java.lang.String msg)

getErrorObject

public static LogObject getErrorObject(java.lang.String event,
                                       java.lang.String servicePath,
                                       java.lang.String msg,
                                       java.lang.String operationName)

Used to construct log object to log errors, with status -1

Parameters:

event - typically an end event, can be any string

servicePath - service name (value of SERVICE_NAME)

msg - message (value of MSG_NAME)

operationName - operation name (value of OPERATION_NAME)

Returns:

getStartObject

public static LogObject getStartObject(java.lang.String event,
                                       java.lang.String servicePath)

getStartObject

public static LogObject getStartObject(java.lang.String event,
                                       java.lang.String servicePath,
                                       java.lang.String operationName)

Used to construct log object to log start events

Parameters:

event - typically start event, can be any string

servicePath - service name (value of SERVICE_NAME)

operationName - operation name (value of OPERATION_NAME)

Returns:

getEndObject

public static LogObject getEndObject(java.lang.String event,
                                     java.lang.String servicePath)

getEndObject

public static LogObject getEndObject(java.lang.String event,
                                     java.lang.String servicePath,
                                     java.lang.String operationName)

Used to construct log objects to log end of events, with status 0.

Parameters:

event - typically start event, can be any string

servicePath - service name (value of SERVICE_NAME)

operationName - operation name (value of OPERATION_NAME)

Returns:

removeNewLines

public static java.lang.String removeNewLines(java.lang.String value)