Package com.priint.pubserver.tracing

Class TracerMessage

java.lang.Object

com.priint.pubserver.tracing.TracerMessage

All Implemented Interfaces:

Serializable

public class TracerMessage
extends Object
implements Serializable

Message Class which contains a trace message

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TracerMessage.MessageType	Enumeration of Message types

Constructor Summary

Constructors

Constructor	Description
TracerMessage(String sessionId, String type, String user, String message, String hint, String source, Date timestamp)
TracerMessage(String sessionId, String type, String user, String message, String hint, String source, Date timestamp, String documentId, String publicationId)

Method Summary

Modifier and Type	Method	Description
String	getDocumentId()
String	getHint()
int	getId()	Get unique trace message id (created on insert by the database).
String	getMessage()	Get message of the trace message
String	getPublicationId()
String	getSessionId()	Get sessionId of the trace message
String	getSource()
Date	getTimestamp()
String	getType()	Get type of the trace message
String	getUser()	Get user of the session.
void	setDocumentId(String documentId)	Set documentId
void	setHint(String hint)
void	setId(int id)	Set unique trace message id (usually created on insert by the database)
void	setMessage(String message)
void	setPublicationId(String publicationId)	Set publicationId
void	setSessionId(String sessionId)	Set session id of the trace message
void	setSource(String source)
void	setTimestamp(Date timestamp)	Set creation date and time of the message.
void	setType(String type)	Set type of the trace message.
void	setUser(String user)
String	toString()	returns trace message with: type, source, message, hint

Methods inherited from class java.lang.Object

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

Constructor Details

TracerMessage

public TracerMessage(String sessionId,
 String type,
 String user,
 String message,
 String hint,
 String source,
 Date timestamp)

Parameters:

sessionId - id of the publishing server session

type - Message type (info, error, warning). Use MessageType.toString() method for getting the correct label.

user - name of the logged in user

message - textual message describing the event

hint - optional text describing measures to be taken, when this event occurs

source - code source generating this event

timestamp - date time when this event occurred

TracerMessage

public TracerMessage(String sessionId,
 String type,
 String user,
 String message,
 String hint,
 String source,
 Date timestamp,
 String documentId,
 String publicationId)

Parameters:

sessionId - id of the publishing server session

type - Message type (info, error, warning). Use MessageType.toString() method for getting the correct label.

user - user name of the logged in user

message - textual message describing the event

hint - optional text describing measures to be taken, when this event occurs

source - code source generating this event

timestamp - date time when this event occurred

documentId - identifier of the document

publicationId - identifier of the publication

Method Details

getId

public int getId()

Get unique trace message id (created on insert by the database).

Returns:

id

setId

public void setId(int id)

Set unique trace message id (usually created on insert by the database)

Parameters:

id -

getSessionId

public String getSessionId()

Get sessionId of the trace message

Returns:

sessionId

setSessionId

public void setSessionId(String sessionId)

Set session id of the trace message

Parameters:

sessionId -

getType

public String getType()

Get type of the trace message

Returns:

type as string

See Also:

• TracerMessage.MessageType

setType

public void setType(String type)

Set type of the trace message.

Parameters:

type - as string

See Also:

• TracerMessage.MessageType

getUser

public String getUser()

Get user of the session.

Returns:

user name

setUser

public void setUser(String user)

Parameters:

user - name

getMessage

public String getMessage()

Get message of the trace message

Returns:

message text

setMessage

public void setMessage(String message)

Parameters:

message - text

getHint

public String getHint()

Returns:

hint

setHint

public void setHint(String hint)

Parameters:

hint -

getSource

public String getSource()

Returns:

source

setSource

public void setSource(String source)

Parameters:

source -

getTimestamp

public Date getTimestamp()

Returns:

creation date and time of the message

setTimestamp

public void setTimestamp(Date timestamp)

Set creation date and time of the message.

Parameters:

timestamp -

getDocumentId

public String getDocumentId()

Returns:

Document id

setDocumentId

public void setDocumentId(String documentId)

Set documentId

Parameters:

documentId - text

getPublicationId

public String getPublicationId()

Returns:

Publication id

setPublicationId

public void setPublicationId(String publicationId)

Set publicationId

Parameters:

publicationId - text

toString

public String toString()

returns trace message with: type, source, message, hint

Overrides:

toString in class Object