@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class PassThroughAuthenticationResult extends java.lang.Object
Constructor and Description |
---|
PassThroughAuthenticationResult(PassThroughAuthenticationResultCode resultCode)
Creates a new pass-through authentication result with the provided
result code.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.Object> |
getCustomLogElements()
Retrieves a map containing name-value pairs for custom elements that should
be included in the bind result access log message.
|
java.lang.String |
getDiagnosticMessageForClient()
Retrieves a diagnostic message that should be included in the response to
the client.
|
java.lang.String |
getRemoteUserIdentifier()
Retrieves an identifier for the user's account in the external service.
|
PassThroughAuthenticationResultCode |
getResultCode()
Retrieves a result code that provides a general classification for the
result of the pass-through authentication attempt.
|
void |
setCustomLogElement(java.lang.String name,
java.lang.Object value)
Sets a custom name-value pair that should be included in the bind result
access log message.
|
void |
setDiagnosticMessageForClient(java.lang.String diagnosticMessageForClient)
Sets a diagnostic message that should be included in the response to the
client.
|
void |
setRemoteUserIdentifier(java.lang.String remoteUserIdentifier)
Sets an identifier for the user's account in the external service.
|
java.lang.String |
toString()
Retrieves a string representation of this pass-through authentication
result.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this pass-through authentication result
to the provided buffer.
|
public PassThroughAuthenticationResult(@NotNull PassThroughAuthenticationResultCode resultCode)
resultCode
- A result code that provides a general classification
for the result of the pass-through authentication
attempt. It must not be null
.@NotNull public PassThroughAuthenticationResultCode getResultCode()
@Nullable public java.lang.String getRemoteUserIdentifier()
null
if the user could not be identified or no identifier
is available.public void setRemoteUserIdentifier(@Nullable java.lang.String remoteUserIdentifier)
remoteUserIdentifier
- An identifier for the user's account in the
external service. It may be null
if
the user could not be identified or if no
identifier is available.@Nullable public java.lang.String getDiagnosticMessageForClient()
null
if there should be no client-side
diagnostic message.public void setDiagnosticMessageForClient(@Nullable java.lang.String diagnosticMessageForClient)
diagnosticMessageForClient
- A diagnostic message that should be
included in the response to the client.
It may be null
if no client
diagnostic message should be used.@NotNull public java.util.Map<java.lang.String,java.lang.Object> getCustomLogElements()
null
but may be empty.public void setCustomLogElement(@NotNull java.lang.String name, @Nullable java.lang.Object value)
name
- The name for the log element. It must not be null
.value
- The value for the log element. It may be null
if
any existing log element with the provided name should be
removed.@NotNull public java.lang.String toString()
toString
in class java.lang.Object