org.beangle.security.core.userdetail

Interface Account

All Superinterfaces:

Principal, Serializable

All Known Implementing Classes:

DefaultAccount

public interface Account
extends Serializable, Principal

Provides core user information.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
Map<String,Object>	getDetails() Returns the authorities granted to the user.
String	getName()
String	getRemoteToken()
boolean	isAccountExpired() Indicates whether the user's account has expired.
boolean	isAccountLocked() Indicates whether the user is locked or unlocked.
boolean	isCredentialExpired() Indicates whether the user's credentials (password) has expired.
boolean	isEnabled() Indicates whether the user is enabled or disabled.

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Method Detail

getName

String getName()

Specified by:

getName in interface Principal

getRemoteToken

String getRemoteToken()

getDescription

String getDescription()

getDetails

Map<String,Object> getDetails()

Returns the authorities granted to the user. Cannot return null.

Returns:

the authorities, sorted by natural key (never null)

isAccountExpired

boolean isAccountExpired()

Indicates whether the user's account has expired. An expired account cannot be authenticated.

Returns:

true if the user's account is valid (ie non-expired), false if no longer valid (ie expired)

isAccountLocked

boolean isAccountLocked()

Indicates whether the user is locked or unlocked. A locked user cannot be authenticated.

Returns:

true if the user is not locked, false otherwise

isCredentialExpired

boolean isCredentialExpired()

Indicates whether the user's credentials (password) has expired. Expired credentials prevent authentication.

Returns:

true if the user's credentials are valid (ie non-expired), false if no longer valid (ie expired)

isEnabled

boolean isEnabled()

Indicates whether the user is enabled or disabled. A disabled user cannot be authenticated.

Returns:

true if the user is enabled, false otherwise