Package org.mycore.mcr.acl.accesskey

Class MCRAccessKeyUtils

java.lang.Object

org.mycore.mcr.acl.accesskey.MCRAccessKeyUtils

public class MCRAccessKeyUtils
extends Object

Methods for setting and removing MCRAccessKey for users.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_KEY_PREFIX	Prefix for user attribute name for value

Constructor Summary

Constructors

Constructor	Description
MCRAccessKeyUtils()

Method Summary

Modifier and Type	Method	Description
static void	addAccessKeySecret(MCRSession session, MCRObjectID objectId, String value)	Adds the value of MCRAccessKey as an attribute to a MCRSession for MCRObjectID including derivates.
static void	addAccessKeySecret(MCRUser user, MCRObjectID objectId, String value)	Adds the value of a MCRAccessKey as user attribute to a MCRUser for a MCRObjectID including derivates.
static void	addAccessKeySecretForObject(MCRSession session, MCRObjectID objectId, String value)	Adds the value of MCRAccessKey as an attribute to a MCRSession for MCRObjectID.
static void	addAccessKeySecretForObject(MCRUser user, MCRObjectID objectId, String value)	Adds the value of a MCRAccessKey as user attribute to a MCRUser for a MCRObjectID.
static void	addAccessKeySecretToCurrentSession(MCRObjectID objectId, String value)	Adds the value of MCRAccessKey as an attribute to the current MCRSession for MCRObjectID.
static void	addAccessKeySecretToCurrentUser(MCRObjectID objectId, String value)	Adds the value of MCRAccessKey as user attribute to the current MCRUser for MCRObjectID.
static void	cleanUpUserAttributes()	Cleans all access key secret attributes of users if the corresponding key does not exist.
static String	getAccessKeySecret(MCRSession session, MCRObjectID objectId)	Fetches access key value from session attribute for a MCRObjectID.
static String	getAccessKeySecret(MCRUserInformation userInformation, MCRObjectID objectId)	Fetches access key value from user attribute for a MCRObjectID.
static String	getAccessKeySecretFromCurrentSession(MCRObjectID objectId)	Fetches access key value from session attribute for a MCRObjectID.
static String	getAccessKeySecretFromCurrentUser(MCRObjectID objectId)	Fetches access key value from user attribute for a MCRObjectID.
static Set<String>	getAllowedSessionPermissionTypes()
static MCRAccessKey	getLinkedAccessKey(MCRSession session, MCRObjectID objectId)	Retrieves linked access key if exists from session
static MCRAccessKey	getLinkedAccessKey(MCRUserInformation userInformation, MCRObjectID objectId)	Retrieves linked access key if exists from user
static MCRAccessKey	getLinkedAccessKeyFromCurrentSession(MCRObjectID objectId)	Retrieves linked access key if exists from current session
static MCRAccessKey	getLinkedAccessKeyFromCurrentUser(MCRObjectID objectId)	Retrieves linked access key if exists from current user
static boolean	isAccessKeyForObjectTypeAllowed(String type)
static boolean	isAccessKeyForSessionAllowed()
static boolean	isAccessKeyForSessionAllowed(String permission)
static void	removeAccessKeySecret(MCRSession session, MCRObjectID objectId)	Deletes the access key value attribute from given MCRSession for MCRObjectID.
static void	removeAccessKeySecret(MCRUser user, MCRObjectID objectId)	Deletes the access key value user attribute from given MCRUser for MCRObjectID.
static void	removeAccessKeySecretFromCurrentSession(MCRObjectID objectId)	Deletes access key value attribute from current MCRSession for a MCRObjectID.
static void	removeAccessKeySecretFromCurrentUser(MCRObjectID objectId)	Deletes access key value user attribute from current MCRUser for a MCRObjectID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ACCESS_KEY_PREFIX

public static final String ACCESS_KEY_PREFIX

Prefix for user attribute name for value

See Also:

• Constant Field Values

Constructor Details

MCRAccessKeyUtils

public MCRAccessKeyUtils()

Method Details

addAccessKeySecretForObject

public static void addAccessKeySecretForObject(MCRSession session,
 MCRObjectID objectId,
 String value)
                                        throws MCRException

Adds the value of MCRAccessKey as an attribute to a MCRSession for MCRObjectID.

Parameters:

session - the MCRSession

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value or not allowed.

addAccessKeySecret

public static void addAccessKeySecret(MCRSession session,
 MCRObjectID objectId,
 String value)
                               throws MCRException

Adds the value of MCRAccessKey as an attribute to a MCRSession for MCRObjectID including derivates.

Parameters:

session - the MCRSession

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value or not allowed.

addAccessKeySecretForObject

public static void addAccessKeySecretForObject(MCRUser user,
 MCRObjectID objectId,
 String value)
                                        throws MCRException

Adds the value of a MCRAccessKey as user attribute to a MCRUser for a MCRObjectID.

Parameters:

user - the MCRUser the value should assigned

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value.

addAccessKeySecret

public static void addAccessKeySecret(MCRUser user,
 MCRObjectID objectId,
 String value)
                               throws MCRException

Adds the value of a MCRAccessKey as user attribute to a MCRUser for a MCRObjectID including derivates.

Parameters:

user - the MCRUser the value should assigned

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value.

addAccessKeySecretToCurrentSession

public static void addAccessKeySecretToCurrentSession(MCRObjectID objectId,
 String value)
                                               throws MCRException

Adds the value of MCRAccessKey as an attribute to the current MCRSession for MCRObjectID.

Parameters:

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value.

addAccessKeySecretToCurrentUser

public static void addAccessKeySecretToCurrentUser(MCRObjectID objectId,
 String value)
                                            throws MCRException

Adds the value of MCRAccessKey as user attribute to the current MCRUser for MCRObjectID.

Parameters:

objectId - the MCRObjectID

value - the value of a MCRAccessKey

Throws:

MCRException - if there is no matching MCRAccessKey with the same value.

cleanUpUserAttributes

public static void cleanUpUserAttributes()

Cleans all access key secret attributes of users if the corresponding key does not exist.

getAccessKeySecret

public static String getAccessKeySecret(MCRSession session,
 MCRObjectID objectId)

Fetches access key value from session attribute for a MCRObjectID.

Parameters:

session - the MCRSession

objectId - the MCRObjectID

Returns:

secret or null

getAccessKeySecret

public static String getAccessKeySecret(MCRUserInformation userInformation,
 MCRObjectID objectId)

Fetches access key value from user attribute for a MCRObjectID.

Parameters:

userInformation - the MCRUserInformation

objectId - the MCRObjectID

Returns:

secret or null

getAccessKeySecretFromCurrentSession

public static String getAccessKeySecretFromCurrentSession(MCRObjectID objectId)

Fetches access key value from session attribute for a MCRObjectID.

Parameters:

objectId - the MCRObjectID

Returns:

secret or null

getAccessKeySecretFromCurrentUser

public static String getAccessKeySecretFromCurrentUser(MCRObjectID objectId)

Fetches access key value from user attribute for a MCRObjectID.

Parameters:

objectId - the MCRObjectID

Returns:

secret or null

getLinkedAccessKey

public static MCRAccessKey getLinkedAccessKey(MCRSession session,
 MCRObjectID objectId)

Retrieves linked access key if exists from session

Parameters:

session - the MCRSession

objectId - of a MCRObjectID

Returns:

access key

getLinkedAccessKey

public static MCRAccessKey getLinkedAccessKey(MCRUserInformation userInformation,
 MCRObjectID objectId)

Retrieves linked access key if exists from user

Parameters:

userInformation - the MCRUserInformation

objectId - of a MCRObjectID

Returns:

access key

getLinkedAccessKeyFromCurrentSession

public static MCRAccessKey getLinkedAccessKeyFromCurrentSession(MCRObjectID objectId)

Retrieves linked access key if exists from current session

Parameters:

objectId - of a MCRObjectID

Returns:

access key

getLinkedAccessKeyFromCurrentUser

public static MCRAccessKey getLinkedAccessKeyFromCurrentUser(MCRObjectID objectId)

Retrieves linked access key if exists from current user

Parameters:

objectId - of a MCRObjectID

Returns:

access key

removeAccessKeySecret

public static void removeAccessKeySecret(MCRSession session,
 MCRObjectID objectId)

Deletes the access key value attribute from given MCRSession for MCRObjectID.

Parameters:

session - the MCRSession

objectId - the MCRObjectID

removeAccessKeySecret

public static void removeAccessKeySecret(MCRUser user,
 MCRObjectID objectId)

Deletes the access key value user attribute from given MCRUser for MCRObjectID.

Parameters:

user - the MCRUser

objectId - the MCRObjectID

removeAccessKeySecretFromCurrentSession

public static void removeAccessKeySecretFromCurrentSession(MCRObjectID objectId)

Deletes access key value attribute from current MCRSession for a MCRObjectID.

Parameters:

objectId - the MCRObjectID

removeAccessKeySecretFromCurrentUser

public static void removeAccessKeySecretFromCurrentUser(MCRObjectID objectId)

Deletes access key value user attribute from current MCRUser for a MCRObjectID.

Parameters:

objectId - the MCRObjectID

isAccessKeyForSessionAllowed

public static boolean isAccessKeyForSessionAllowed()

isAccessKeyForSessionAllowed

public static boolean isAccessKeyForSessionAllowed(String permission)

isAccessKeyForObjectTypeAllowed

public static boolean isAccessKeyForObjectTypeAllowed(String type)

getAllowedSessionPermissionTypes

public static Set<String> getAllowedSessionPermissionTypes()