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

    Author:
    Middleware Services
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String OID
      OID of this control.
    • Constructor Summary

      Constructors 
      Constructor Description
      GetStatsControl()
      Default constructor.
      GetStatsControl​(boolean critical)
      Creates a new get stats control.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void decode​(DERBuffer encoded)
      Initializes this response control with the supplied BER encoded data.
      byte[] encode()
      Provides the BER encoding of this control.
      boolean equals​(java.lang.Object o)  
      java.util.Map<java.lang.String,​java.lang.Object> getStatistics()
      Returns the statistics.
      int hashCode()
      Returns the hash code for this object.
      boolean hasValue()
      Returns whether the control has a value associated with it.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • 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 java.util.Map<java.lang.String,​java.lang.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