Interface IAuthIdentification
-
- All Superinterfaces:
com.helger.commons.state.ISuccessIndicator
- All Known Implementing Classes:
AuthIdentification
public interface IAuthIdentification extends com.helger.commons.state.ISuccessIndicatorThe interface representing the authentication result of anIAuthSubject(e.g. user) at a given date and time.- Author:
- Philip Helger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description IAuthSubjectgetAuthSubject()LocalDateTimegetIdentificationDateTime()Method to retrieve the time stamp of when this object was created.default booleanhasAuthSubject(IAuthSubject aSubject)default booleanisSuccess()
-
-
-
Method Detail
-
getAuthSubject
@Nullable IAuthSubject getAuthSubject()
- Returns:
- The identified subject. May be
nullif no subject matched the credentials.
-
isSuccess
default boolean isSuccess()
- Specified by:
isSuccessin interfacecom.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.
-
-