Class GetStatsControl

  • All Implemented Interfaces:
    Control, RequestControl, ResponseControl

    public class GetStatsControl
    extends AbstractControl
    implements RequestControl, ResponseControl
    Request/response control for active directory servers to return statistics along with search results. This implementation supports the format for Windows Server 2008, Windows Server 2008 R2, and Windows Server 2012 DCs. The response control is defined as:
       SEQUENCE {
         threadCountTag        INTEGER
         threadCount           INTEGER
         callTimeTag           INTEGER
         callTime              INTEGER
         entriesReturnedTag    INTEGER
         entriesReturned       INTEGER
         entriesVisitedTag     INTEGER
         entriesVisited        INTEGER
         filterTag             INTEGER
         filter                OCTET STRING
         indexTag              INTEGER
         index                 OCTET STRING
         pagesReferencedTag    INTEGER
         pagesReferenced       INTEGER
         pagesReadTag          INTEGER
         pagesRead             INTEGER
         pagesPrereadTag       INTEGER
         pagesPreread          INTEGER
         pagesDirtiedTag       INTEGER
         pagesDirtied          INTEGER
         pagesRedirtiedTag     INTEGER
         pagesRedirtied        INTEGER
         logRecordCountTag     INTEGER
         logRecordCount        INTEGER
         logRecordBytesTag     INTEGER
         logRecordBytes        INTEGER
       }
     

    See http://msdn.microsoft.com/en-us/library/cc223350.aspx

    • Field Detail

      • HASH_CODE_SEED

        private static final int HASH_CODE_SEED
        hash code seed.
        See Also:
        Constant Field Values
      • THREAD_COUNT_PATH

        private static final DERPath THREAD_COUNT_PATH
        DER path to thread count.
      • CALL_TIME_PATH

        private static final DERPath CALL_TIME_PATH
        DER path to call time.
      • ENTRIES_RETURNED_PATH

        private static final DERPath ENTRIES_RETURNED_PATH
        DER path to entries returned.
      • ENTRIES_VISITED_PATH

        private static final DERPath ENTRIES_VISITED_PATH
        DER path to entries visited.
      • FILTER_PATH

        private static final DERPath FILTER_PATH
        DER path to filter.
      • INDEX_PATH

        private static final DERPath INDEX_PATH
        DER path to index.
      • PAGES_REFERENCED_PATH

        private static final DERPath PAGES_REFERENCED_PATH
        DER path to pages referenced.
      • PAGES_READ_PATH

        private static final DERPath PAGES_READ_PATH
        DER path to pages read.
      • PAGES_PREREAD_PATH

        private static final DERPath PAGES_PREREAD_PATH
        DER path to pages preread.
      • PAGES_DIRTIED_PATH

        private static final DERPath PAGES_DIRTIED_PATH
        DER path to pages dirtied.
      • PAGES_REDIRTIED_PATH

        private static final DERPath PAGES_REDIRTIED_PATH
        DER path to pages redirtied.
      • LOG_RECORD_COUNT_PATH

        private static final DERPath LOG_RECORD_COUNT_PATH
        DER path to log record count.
      • LOG_RECORD_BYTES_PATH

        private static final DERPath LOG_RECORD_BYTES_PATH
        DER path to log record bytes.
    • Constructor Detail

      • GetStatsControl

        public GetStatsControl()
        Default constructor.
      • GetStatsControl

        public GetStatsControl​(boolean critical)
        Creates a new get stats control.
        Parameters:
        critical - whether this control is critical
    • Method Detail

      • hasValue

        public boolean hasValue()
        Description copied from interface: RequestControl
        Returns whether the control has a value associated with it.
        Specified by:
        hasValue in interface RequestControl
        Returns:
        whether the control has a value
      • getStatistics

        public Map<String,​Object> getStatistics()
        Returns the statistics.
        Returns:
        statistics
      • hashCode

        public int hashCode()
        Description copied from class: AbstractControl
        Returns the hash code for this object.
        Specified by:
        hashCode in class AbstractControl
        Returns:
        hash code
      • encode

        public byte[] encode()
        Description copied from interface: RequestControl
        Provides the BER encoding of this control.
        Specified by:
        encode in interface RequestControl
        Returns:
        BER encoded request control
      • decode

        public void decode​(DERBuffer encoded)
        Description copied from interface: ResponseControl
        Initializes this response control with the supplied BER encoded data.
        Specified by:
        decode in interface ResponseControl
        Parameters:
        encoded - BER encoded response control