Class AccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
ClientCertificateAccessLogMessage
,ConnectAccessLogMessage
,DisconnectAccessLogMessage
,EntryRebalancingRequestAccessLogMessage
,OperationAccessLogMessage
,SecurityNegotiationAccessLogMessage
@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public abstract class AccessLogMessage extends LogMessage
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log.
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AccessLogMessage(LogMessage m)
Creates a new access log message from the provided log message.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Long
getConnectionID()
Retrieves the connection ID for the connection with which this access log message is associated.java.lang.String
getInstanceName()
Retrieves the Directory Server instance name for this access log message.abstract AccessLogMessageType
getMessageType()
Retrieves the message type for this access log message.java.lang.String
getProductName()
Retrieves the server product name for this access log message.java.lang.String
getStartupID()
Retrieves the Directory Server startup ID for this access log message.static AccessLogMessage
parse(java.lang.String s)
Parses the provided string as an access log message.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
-
-
-
-
Constructor Detail
-
AccessLogMessage
protected AccessLogMessage(LogMessage m)
Creates a new access log message from the provided log message.- Parameters:
m
- The log message to be parsed as an access log message.
-
-
Method Detail
-
parse
public static AccessLogMessage parse(java.lang.String s) throws LogException
Parses the provided string as an access log message.- Parameters:
s
- The string to parse as an access log message.- Returns:
- The parsed access log message.
- Throws:
LogException
- If an error occurs while trying to parse the log message.
-
getProductName
public final java.lang.String getProductName()
Retrieves the server product name for this access log message.- Returns:
- The server product name for this access log message, or
null
if it is not included in the log message.
-
getInstanceName
public final java.lang.String getInstanceName()
Retrieves the Directory Server instance name for this access log message.- Returns:
- The Directory Server instance name for this access log message, or
null
if it is not included in the log message.
-
getStartupID
public final java.lang.String getStartupID()
Retrieves the Directory Server startup ID for this access log message.- Returns:
- The Directory Server startup ID for this access log message, or
null
if it is not included in the log message.
-
getConnectionID
public final java.lang.Long getConnectionID()
Retrieves the connection ID for the connection with which this access log message is associated.- Returns:
- The connection ID for the connection with which this access log
message is associated, or
null
if it is not included in the log message.
-
getMessageType
public abstract AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Returns:
- The message type for this access log message.
-
-