Package com.unboundid.directory.sdk.common.types

Interface AuthInfo

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface AuthInfo

This interface defines a set of methods that may be used to obtain information about the authentication and/or authorization identity of a client connection.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAuthenticationDN()	Retrieves the DN of the user that has authenticated, if applicable.
Entry	getAuthenticationEntry()	Retrieves the entry for the user that has authenticated, if applicable.
java.lang.String	getAuthorizationDN()	Retrieves the DN of the authorization identity for the client connection, if applicable.
Entry	getAuthorizationEntry()	Retrieves the entry for the authorization identity, if applicable.
AuthType	getAuthType()	Retrieves the type of authentication performed by the client.
java.lang.String	getSASLMechanismName()	Retrieves the name of the SASL mechanism used to authenticate, if applicable.
boolean	isAuthenticated()	Indicates whether the associated client has authenticated to the server.

Method Detail

isAuthenticated

boolean isAuthenticated()

Indicates whether the associated client has authenticated to the server.

Returns:

true if the associated client has authenticated to the server, or false if not.

getAuthType

AuthType getAuthType()

Retrieves the type of authentication performed by the client.

Returns:

The type of authentication performed by the client.

getAuthenticationDN

java.lang.String getAuthenticationDN()

Retrieves the DN of the user that has authenticated, if applicable.

Returns:

The DN of the user that has authenticated, or null if the client has not authenticated.

getAuthenticationEntry

Entry getAuthenticationEntry()

Retrieves the entry for the user that has authenticated, if applicable.

Returns:

The entry for the user that has authenticated, or null if the client has not yet authenticated.

getAuthorizationDN

java.lang.String getAuthorizationDN()

Retrieves the DN of the authorization identity for the client connection, if applicable. The authorization identity is usually the same as the authentication identity, but an alternate authorization identity may be specified when authenticating with some SASL mechanisms.

Returns:

The DN of the authorization identity for the connection, or null if the client has not yet authenticated or if the authorization identity is the anonymous user.

getAuthorizationEntry

Entry getAuthorizationEntry()

Retrieves the entry for the authorization identity, if applicable. The authorization identity is usually the same as the authentication identity, but an alternate authorization identity may be specified when authenticating with some SASL mechanisms.

Returns:

The entry for the authorization identity, or null if the client has not yet authenticated or if the authorization identity is the anonymous user.

getSASLMechanismName

java.lang.String getSASLMechanismName()

Retrieves the name of the SASL mechanism used to authenticate, if applicable.

Returns:

The name of the SASL mechanism used to authenticate, or null if the client has not used SASL authentication.