com.unboundid.ldap.sdk.unboundidds.logs
Class SearchEntryAccessLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by com.unboundid.ldap.sdk.unboundidds.logs.SearchRequestAccessLogMessage
                      extended by com.unboundid.ldap.sdk.unboundidds.logs.SearchEntryAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SearchEntryAccessLogMessage
extends SearchRequestAccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search result entry returned to a client.

See Also:
Serialized Form

Constructor Summary
SearchEntryAccessLogMessage(LogMessage m)
          Creates a new search result entry access log message from the provided log message.
SearchEntryAccessLogMessage(java.lang.String s)
          Creates a new search result entry access log message from the provided message string.
 
Method Summary
 java.util.List<java.lang.String> getAttributesReturned()
          Retrieves the names of the attributes included in the entry that was returned.
 java.lang.String getDN()
          Retrieves the DN of the entry returned to the client.
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 java.util.List<java.lang.String> getResponseControlOIDs()
          Retrieves the OIDs of any response controls contained in the log message.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.SearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getOperationType, getParsedFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimit, typesOnly
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchEntryAccessLogMessage

public SearchEntryAccessLogMessage(java.lang.String s)
                            throws LogException
Creates a new search result entry access log message from the provided message string.

Parameters:
s - The string to be parsed as a search result entry access log message.
Throws:
LogException - If the provided string cannot be parsed as a valid log message.

SearchEntryAccessLogMessage

public SearchEntryAccessLogMessage(LogMessage m)
Creates a new search result entry access log message from the provided log message.

Parameters:
m - The log message to be parsed as a search entry access log message.
Method Detail

getDN

public java.lang.String getDN()
Retrieves the DN of the entry returned to the client.

Returns:
The DN of the entry returned to the client, or null if it is not included in the log message.

getAttributesReturned

public java.util.List<java.lang.String> getAttributesReturned()
Retrieves the names of the attributes included in the entry that was returned.

Returns:
The names of the attributes included in the entry that was returned, or null if it is not included in the log message.

getResponseControlOIDs

public java.util.List<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.

Returns:
The OIDs of any response controls contained in the log message, or an empty list if it is not included in the log message.

getMessageType

public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.

Overrides:
getMessageType in class OperationRequestAccessLogMessage
Returns:
The message type for this access log message.