Interface SearchEntryAccessLogMessage
-
- All Superinterfaces:
AccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,SearchRequestAccessLogMessage
,java.io.Serializable
- All Known Implementing Classes:
JSONSearchEntryAccessLogMessage
,TextFormattedSearchEntryAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface SearchEntryAccessLogMessage extends SearchRequestAccessLogMessage
This class provides a data structure that holds information about a 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.
-
-
Method Summary
All Methods Instance Methods Abstract 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.java.util.Set<java.lang.String>
getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getMessageType, 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
-
-
-
-
Method Detail
-
getDN
@Nullable 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
@NotNull java.util.Set<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
@NotNull java.util.Set<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.
-
-