Class DraftChuLDAPLogSchema00SearchEntry

    • Constructor Detail

      • DraftChuLDAPLogSchema00SearchEntry

        public DraftChuLDAPLogSchema00SearchEntry​(@NotNull
                                                  Entry entry)
                                           throws LDAPException
        Creates a new instance of this search access log entry from the provided entry.
        Parameters:
        entry - The entry used to create this search access log entry.
        Throws:
        LDAPException - If the provided entry cannot be decoded as a valid search access log entry as per the specification contained in draft-chu-ldap-logschema-00.
    • Method Detail

      • getScope

        @NotNull
        public SearchScope getScope()
        Retrieves the scope for the search request described by this search access log entry.
        Returns:
        The scope for the search request described by this search access log entry.
      • getDereferencePolicy

        @NotNull
        public DereferencePolicy getDereferencePolicy()
        Retrieves the alias dereference policy for the search request described by this search access log entry.
        Returns:
        The alias dereference policy for the search request described by this search access log entry.
      • typesOnly

        public boolean typesOnly()
        Retrieves the value of the typesOnly flag for the search request described by this search access log entry.
        Returns:
        The value of the typesOnly flag for the search request described by this search access log entry.
      • getFilter

        @Nullable
        public Filter getFilter()
        Retrieves the filter for the search request described by this search access log entry, if available.
        Returns:
        The filter for the search request described by this search access log entry, or null if no filter was included in the access log entry.
      • getRequestedSizeLimit

        @Nullable
        public java.lang.Integer getRequestedSizeLimit()
        Retrieves the requested size limit for the search request described by this search access log entry, if available.
        Returns:
        The requested size limit for the search request described by this search access log entry, or null if no size limit was included in the access log entry.
      • getRequestedTimeLimitSeconds

        @Nullable
        public java.lang.Integer getRequestedTimeLimitSeconds()
        Retrieves the requested time limit (in seconds) for the search request described by this search access log entry, if available.
        Returns:
        The requested time limit (in seconds) for the search request described by this search access log entry, or null if no time limit was included in the access log entry.
      • getRequestedAttributes

        @NotNull
        public java.util.List<java.lang.String> getRequestedAttributes()
        Retrieves the requested attributes for the search request described by this search access log entry, if available.
        Returns:
        The requested attributes for the search request described by this search access log entry, or an empty list if no requested attributes were included in the access log entry.
      • getEntriesReturned

        @Nullable
        public java.lang.Integer getEntriesReturned()
        Retrieves the number of entries returned to the client in response to the search request described by this search access log entry, if available.
        Returns:
        The number of entries returned to the client in response to the search request described by this search access log entry, or null if the number of entries returned was not included in the access log entry.
      • toSearchRequest

        @NotNull
        public SearchRequest toSearchRequest()
        Retrieves a SearchRequest created from this search access log entry. If the size limit or time limit was not present in the entry, a default of zero will be used. If the filter was not present in the entry, a default of "(objectClass=*)" will be used.
        Returns:
        The SearchRequest created from this search access log entry.