Package org.mycore.common

Interface MCRUserInformation

All Known Implementing Classes:

MCRContainerLoginServlet.ContainerUserInformation, MCRShibbolethUserInformation, MCRSystemUserInformation, MCRTransientUser, MCRUser

public interface MCRUserInformation

Encapsulates informations about the current authenticated user. A instance of this interface is always bound to MCRSession and can be requested via MCRSession.getUserInformation(). An implementer of this interface should bind the instance to the session via MCRSession.setUserInformation(MCRUserInformation).

Author:

Thomas Scheffler (yagee)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATT_EMAIL
static final String	ATT_PRIMARY_GROUP
static final String	ATT_REAL_NAME

Method Summary

Modifier and Type	Method	Description
String	getUserAttribute(String attribute)	Get additional attributes if they are provided by the underlying user system
String	getUserID()	The UserID is the information that is used in user clauses of the ACL System.
boolean	isUserInRole(String role)	The role information is used in group clauses of the ACL System.

Field Details

ATT_PRIMARY_GROUP

static final String ATT_PRIMARY_GROUP

See Also:

• Constant Field Values

ATT_REAL_NAME

static final String ATT_REAL_NAME

See Also:

• Constant Field Values

ATT_EMAIL

static final String ATT_EMAIL

See Also:

• Constant Field Values

Method Details

getUserID

String getUserID()

The UserID is the information that is used in user clauses of the ACL System.

isUserInRole

boolean isUserInRole(String role)

The role information is used in group clauses of the ACL System.

getUserAttribute

String getUserAttribute(String attribute)

Get additional attributes if they are provided by the underlying user system

Parameters:

attribute - user attribute name

Returns:

attribute value as String or null if no value is defined;