Class Log

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Collection collection
      Collection where the event occurred
      protected java.util.Date date
      Date of the event
      protected Profile profile
      Profile where the event occurred
      static java.lang.String REQUEST_ID_NOTHING
      String to use when there's no request id
      protected java.lang.String requestId
      Request identifier, could be an IP, a hash, or null
      static java.lang.String USER_ID_NOTHING
      String to use when there's no user id
      protected java.lang.String userId
      User identifier, may be null if sessions were not enabled on the search service
      static org.apache.commons.lang3.time.FastDateFormat XML_DATE_FORMAT
      Date format used in the XML logs
    • Constructor Summary

      Constructors 
      Constructor Description
      Log​(java.util.Date date, Collection collection, Profile profile, java.lang.String requestId, java.lang.String userId)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Collection getCollection()
      Collection where the event occurred
      java.util.Date getDate()
      Date of the event
      Profile getProfile()
      Profile where the event occurred
      java.lang.String getRequestId()
      Request identifier, could be an IP, a hash, or null
      java.lang.String getUserId()
      User identifier, may be null if sessions were not enabled on the search service
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • XML_DATE_FORMAT

        public static final org.apache.commons.lang3.time.FastDateFormat XML_DATE_FORMAT
        Date format used in the XML logs
      • REQUEST_ID_NOTHING

        public static final java.lang.String REQUEST_ID_NOTHING
        String to use when there's no request id
        See Also:
        Constant Field Values
      • USER_ID_NOTHING

        public static final java.lang.String USER_ID_NOTHING
        String to use when there's no user id
        See Also:
        Constant Field Values
      • date

        protected final java.util.Date date
        Date of the event
      • collection

        protected final Collection collection
        Collection where the event occurred
      • profile

        protected final Profile profile
        Profile where the event occurred
      • requestId

        protected final java.lang.String requestId
        Request identifier, could be an IP, a hash, or null
      • userId

        protected final java.lang.String userId
        User identifier, may be null if sessions were not enabled on the search service
    • Constructor Detail

      • Log

        public Log​(java.util.Date date,
                   Collection collection,
                   Profile profile,
                   java.lang.String requestId,
                   java.lang.String userId)
    • Method Detail

      • getDate

        public java.util.Date getDate()
        Date of the event
      • getCollection

        public Collection getCollection()
        Collection where the event occurred
      • getProfile

        public Profile getProfile()
        Profile where the event occurred
      • getRequestId

        public java.lang.String getRequestId()
        Request identifier, could be an IP, a hash, or null
      • getUserId

        public java.lang.String getUserId()
        User identifier, may be null if sessions were not enabled on the search service