Class TextFormattedSearchEntryAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedSearchRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedSearchEntryAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,SearchEntryAccessLogMessage
,SearchRequestAccessLogMessage
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TextFormattedSearchEntryAccessLogMessage extends TextFormattedSearchRequestAccessLogMessage implements SearchEntryAccessLogMessage
This class provides a data structure that holds information about a text-formatted search entry access log message.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
NO_FIELD_NAME
-
-
Constructor Summary
Constructors Constructor Description TextFormattedSearchEntryAccessLogMessage(java.lang.String logMessageString)
Creates a new text-formatted search result access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<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.Set<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.v2.text.TextFormattedSearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getOperationType, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly
-
-
-
-
Constructor Detail
-
TextFormattedSearchEntryAccessLogMessage
public TextFormattedSearchEntryAccessLogMessage(@NotNull java.lang.String logMessageString) throws LogException
Creates a new text-formatted search result access log message from the provided message string.- Parameters:
logMessageString
- The string representation of this log message. It must not benull
.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
-
Method Detail
-
getMessageType
@NotNull public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Specified by:
getMessageType
in interfaceAccessLogMessage
- Overrides:
getMessageType
in classTextFormattedRequestAccessLogMessage
- Returns:
- The message type for this access log message.
-
getDN
@Nullable public java.lang.String getDN()
Retrieves the DN of the entry returned to the client.- Specified by:
getDN
in interfaceSearchEntryAccessLogMessage
- Returns:
- The DN of the entry returned to the client, or
null
if it is not included in the log message.
-
getAttributesReturned
@NotNull public java.util.Set<java.lang.String> getAttributesReturned()
Retrieves the names of the attributes included in the entry that was returned.- Specified by:
getAttributesReturned
in interfaceSearchEntryAccessLogMessage
- 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
@NotNull public java.util.Set<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.- Specified by:
getResponseControlOIDs
in interfaceSearchEntryAccessLogMessage
- 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.
-
-