com.peterphi.std.guice.common.auth.iface

Interface CurrentUser

public interface CurrentUser

Field Summary

Fields

Modifier and Type	Field and Description
static org.joda.time.format.DateTimeFormatter	DEFAULT_DATE_FORMAT

Method Summary

Modifier and Type	Method and Description
default String	format(Date date) Return a string version of the provided timestamp in the user's preferred timezone and time format
default String	format(org.joda.time.DateTime date) Return a string version of the provided timestamp in the user's preferred timezone and time format
default String	format(Instant date) Return a string version of the provided timestamp in the user's preferred timezone and time format
AccessRefuser	getAccessRefuser()
String	getAuthType() Return the type of authentication used
Map<String,Object>	getClaims() Get all the (verified) claims for this user.
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)
String	getName() Get the name of the current user
default String	getSimpleClaim(String name) Get a simple text/numeric claim as a String.
default List<String>	getSimpleListClaim(String name) Get a List of simple text/numeric claims.
default Set<String>	getSimpleSetClaim(String name) Get a Set of simple text/numeric claims.
String	getUsername() Get the username of the current user
boolean	hasRole(String role) Return whether the user has the named role
boolean	isAnonymous() Return true if the user is not authenticated

Field Detail

DEFAULT_DATE_FORMAT

static final org.joda.time.format.DateTimeFormatter DEFAULT_DATE_FORMAT

Method Detail

getAuthType

String getAuthType()

Return the type of authentication used

Returns:

isAnonymous

boolean isAnonymous()

Return true if the user is not authenticated

Returns:

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

getName

String getName()

Get the name of the current user

Returns:

the name if known, otherwise null

getUsername

String getUsername()

Get the username of the current user

Returns:

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

hasRole

boolean hasRole(String role)

Return whether the user has the named role

Parameters:

role - the role name to test

Returns:

true if the user has that role, otherwise false

getExpires

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)

Returns:

getClaims

Map<String,Object> getClaims()

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

Returns:

getSimpleClaim

default String getSimpleClaim(String name)

Get a simple text/numeric claim as a String. Returns null if no such claim was made.

Parameters:

name -

Returns:

getSimpleListClaim

default List<String> getSimpleListClaim(String name)

Get a List of simple text/numeric claims. Returns null if no such claim was made.

Parameters:

name -

Returns:

getSimpleSetClaim

default Set<String> getSimpleSetClaim(String name)

Get a Set of simple text/numeric claims. Returns null if no such claim was made.

Parameters:

name -

Returns:

format

default String format(org.joda.time.DateTime date)

Return a string version of the provided timestamp in the user's preferred timezone and time format

Parameters:

date -

Returns:

null if the input is null

format

default String format(Instant date)

Return a string version of the provided timestamp in the user's preferred timezone and time format

Parameters:

date -

Returns:

null if the input is null

format

default String format(Date date)

Return a string version of the provided timestamp in the user's preferred timezone and time format

Parameters:

date -

Returns:

null if the input is null

getAccessRefuser

AccessRefuser getAccessRefuser()