com.helger.security.authentication.result

Interface IAuthIdentification

All Superinterfaces:

com.helger.commons.state.ISuccessIndicator, Serializable

All Known Implementing Classes:

AuthIdentification

public interface IAuthIdentification
extends com.helger.commons.state.ISuccessIndicator, Serializable

The interface representing the authentication result of an IAuthSubject (e.g. user) at a given date and time.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
IAuthSubject	getAuthSubject()
LocalDateTime	getIdentificationDateTime() Method to retrieve the time stamp of when this object was created.
default boolean	hasAuthSubject(IAuthSubject aSubject)
default boolean	isSuccess()

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, isFailure, or

Method Detail

getAuthSubject

@Nullable
IAuthSubject getAuthSubject()

Returns:

The identified subject. May be null if no subject matched the credentials.

isSuccess

default boolean isSuccess()

Specified by:

isSuccess in interface com.helger.commons.state.ISuccessIndicator

hasAuthSubject

default boolean hasAuthSubject(@Nullable
                               IAuthSubject aSubject)

getIdentificationDateTime

@Nonnull
LocalDateTime getIdentificationDateTime()

Method to retrieve the time stamp of when this object was created.

Returns:

The date and time the identification occurred. Never null.