Package com.peterphi.usermanager.guice.authentication

Interface UserLogin

All Superinterfaces:

CurrentUser

public interface UserLogin
extends CurrentUser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE_ADMIN	Administrator of the user-manager database
static final String	ROLE_LOGGED_IN	The special role name used for logged in users.
static final String	SESSION_RECONNECT_COOKIE

Fields inherited from interface com.peterphi.std.guice.common.auth.iface.CurrentUser

DEFAULT_DATE_FORMAT, DEFAULT_DATE_FORMAT_STRING, DEFAULT_TIMEZONE, ISO_DATE_FORMAT_STRING, ROLE_AUTHENTICATED, ROLE_DELEGATED, ROLE_SERVICE_CALL

Method Summary

Modifier and Type	Method	Description
void	clear()	Reset the login, making the user anonymous
default AccessRefuser	getAccessRefuser()
default String	getAuthType()	Return the type of authentication used
default Map<String,Object>	getClaims()	Get all the (verified) claims for this user.
String	getEmail()
default org.joda.time.DateTime	getExpires()	Get the instant when the login must expire (or null if it will never expire or has not come through an authentication system that uses expiration)
Integer	getId()
String	getName()	Get the name of the current user
default String	getUsername()	Get the username of the current user
default boolean	isAdmin()
default boolean	isAnonymous()	Return true if the user is not authenticated
boolean	isLocal()
default boolean	isLoggedIn()
void	reload(UserEntity account)	Change to represent the named user

Methods inherited from interface com.peterphi.std.guice.common.auth.iface.CurrentUser

format, format, format, getDateFormatter, getRoles, getSimpleClaim, getSimpleListClaim, getSimpleSetClaim, getTimeZone, hasRole, isDelegated, isService

Field Details

SESSION_RECONNECT_COOKIE

static final String SESSION_RECONNECT_COOKIE

See Also:

• Constant Field Values

ROLE_LOGGED_IN

static final String ROLE_LOGGED_IN

The special role name used for logged in users. The empty string is also permitted

See Also:

• Constant Field Values

ROLE_ADMIN

static final String ROLE_ADMIN

Administrator of the user-manager database

See Also:

• Constant Field Values

Method Details

clear

void clear()

Reset the login, making the user anonymous

reload

void reload(UserEntity account)

Change to represent the named user

Parameters:

account -

isAdmin

default boolean isAdmin()

isLocal

boolean isLocal()

getName

String getName()

Description copied from interface: CurrentUser

Get the name of the current user

Specified by:

getName in interface CurrentUser

Returns:

the name if known, otherwise null

getId

Integer getId()

getEmail

String getEmail()

getExpires

default org.joda.time.DateTime getExpires()

Description copied from interface: CurrentUser

Get the instant when the login must expire (or null if it will never expire or has not come through an authentication system that uses expiration)

Specified by:

getExpires in interface CurrentUser

Returns:

getAuthType

default String getAuthType()

Description copied from interface: CurrentUser

Return the type of authentication used

Specified by:

getAuthType in interface CurrentUser

Returns:

isLoggedIn

default boolean isLoggedIn()

isAnonymous

default boolean isAnonymous()

Description copied from interface: CurrentUser

Return true if the user is not authenticated

Specified by:

isAnonymous in interface CurrentUser

Returns:

true if the user is not authenticated, false if the user is authenticated

getUsername

default String getUsername()

Description copied from interface: CurrentUser

Get the username of the current user

Specified by:

getUsername in interface CurrentUser

Returns:

the username if known, otherwise null if not logged in (i.e. anonymous)

getClaims

default Map<String,Object> getClaims()

Description copied from interface: CurrentUser

Get all the (verified) claims for this user. The returned collection MUST NOT be modified. Returns an empty collection if no claims were made

Specified by:

getClaims in interface CurrentUser

Returns:

getAccessRefuser

default AccessRefuser getAccessRefuser()

Specified by:

getAccessRefuser in interface CurrentUser