org.mycore.common.MCRUserInformation Maven / Gradle / Ivy
/*
* This file is part of *** M y C o R e ***
* See http://www.mycore.de/ for details.
*
* MyCoRe is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* MyCoRe is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MyCoRe. If not, see .
*/
package org.mycore.common;
/**
* Encapsulates informations about the current authenticated user.
*
* A instance of this interface is always bound to {@link MCRSession}
* and can be requested via {@link MCRSession#getUserInformation()}.
* An implementer of this interface should bind the instance to the session via
* {@link MCRSession#setUserInformation(MCRUserInformation)}.
* @author Thomas Scheffler (yagee)
*
*/
public interface MCRUserInformation {
String ATT_PRIMARY_GROUP = "primaryGroup";
String ATT_REAL_NAME = "realName";
String ATT_EMAIL = "eMail";
/**
* The UserID is the information that is used in user clauses of the ACL System.
*/
String getUserID();
/**
* The role information is used in group clauses of the ACL System.
*/
boolean isUserInRole(String role);
/**
* Get additional attributes if they are provided by the underlying user system
* @param attribute user attribute name
* @return attribute value as String or null if no value is defined;
*/
String getUserAttribute(String attribute);
}