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

Interface CurrentUser

public interface CurrentUser

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Get the name of the current user
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

Method Detail

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