Package com.priint.pubserver.tracing

Class TracerMessage

  • All Implemented Interfaces:
    java.io.Serializable
    public class TracerMessage
extends java.lang.Object
implements java.io.Serializable
    Message Class which contains a trace message
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TracerMessage.MessageType
      Enumeration of Message types

    • Constructor Summary

      Constructors 
      Constructor Description
      TracerMessage​(java.lang.String sessionId, java.lang.String type, java.lang.String user, java.lang.String message, java.lang.String hint, java.lang.String source, java.util.Date timestamp)  
      TracerMessage​(java.lang.String sessionId, java.lang.String type, java.lang.String user, java.lang.String message, java.lang.String hint, java.lang.String source, java.util.Date timestamp, java.lang.String documentId, java.lang.String publicationId)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDocumentId()  
      java.lang.String getHint()  
      int getId()
      Get unique trace message id (created on insert by the database).
      java.lang.String getMessage()
      Get message of the trace message
      java.lang.String getPublicationId()  
      java.lang.String getSessionId()
      Get sessionId of the trace message
      java.lang.String getSource()  
      java.util.Date getTimestamp()  
      java.lang.String getType()
      Get type of the trace message
      java.lang.String getUser()
      Get user of the session.
      void setDocumentId​(java.lang.String documentId)
      Set documentId
      void setHint​(java.lang.String hint)  
      void setId​(int id)
      Set unique trace message id (usually created on insert by the database)
      void setMessage​(java.lang.String message)  
      void setPublicationId​(java.lang.String publicationId)
      Set publicationId
      void setSessionId​(java.lang.String sessionId)
      Set session id of the trace message
      void setSource​(java.lang.String source)  
      void setTimestamp​(java.util.Date timestamp)
      Set creation date and time of the message.
      void setType​(java.lang.String type)
      Set type of the trace message.
      void setUser​(java.lang.String user)  
      java.lang.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 Detail

      • TracerMessage

        public TracerMessage​(java.lang.String sessionId,
                     java.lang.String type,
                     java.lang.String user,
                     java.lang.String message,
                     java.lang.String hint,
                     java.lang.String source,
                     java.util.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​(java.lang.String sessionId,
                     java.lang.String type,
                     java.lang.String user,
                     java.lang.String message,
                     java.lang.String hint,
                     java.lang.String source,
                     java.util.Date timestamp,
                     java.lang.String documentId,
                     java.lang.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 Detail

      • 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 java.lang.String getSessionId()
        Get sessionId of the trace message
        Returns:
        sessionId

      • setSessionId

        public void setSessionId​(java.lang.String sessionId)
        Set session id of the trace message
        Parameters:
        sessionId -

      • getType

        public java.lang.String getType()
        Get type of the trace message
        Returns:
        type as string
        See Also:
        TracerMessage.MessageType

      • setType

        public void setType​(java.lang.String type)
        Set type of the trace message.
        Parameters:
        type - as string
        See Also:
        TracerMessage.MessageType

      • getUser

        public java.lang.String getUser()
        Get user of the session.
        Returns:
        user name

      • setUser

        public void setUser​(java.lang.String user)
        Parameters:
        user - name

      • getMessage

        public java.lang.String getMessage()
        Get message of the trace message
        Returns:
        message text

      • setMessage

        public void setMessage​(java.lang.String message)
        Parameters:
        message - text

      • getHint

        public java.lang.String getHint()
        Returns:
        hint

      • setHint

        public void setHint​(java.lang.String hint)
        Parameters:
        hint -

      • getSource

        public java.lang.String getSource()
        Returns:
        source

      • setSource

        public void setSource​(java.lang.String source)
        Parameters:
        source -

      • getTimestamp

        public java.util.Date getTimestamp()
        Returns:
        creation date and time of the message

      • setTimestamp

        public void setTimestamp​(java.util.Date timestamp)
        Set creation date and time of the message.
        Parameters:
        timestamp -

      • getDocumentId

        public java.lang.String getDocumentId()
        Returns:
        Document id

      • setDocumentId

        public void setDocumentId​(java.lang.String documentId)
        Set documentId
        Parameters:
        documentId - text

      • getPublicationId

        public java.lang.String getPublicationId()
        Returns:
        Publication id

      • setPublicationId

        public void setPublicationId​(java.lang.String publicationId)
        Set publicationId
        Parameters:
        publicationId - text

      • toString

        public java.lang.String toString()
        returns trace message with: type, source, message, hint
        Overrides:
        toString in class java.lang.Object