Package org.mycore.mcr.acl.accesskey

Class MCRAccessKeyManager

java.lang.Object

org.mycore.mcr.acl.accesskey.MCRAccessKeyManager

public final class MCRAccessKeyManager
extends Object

Methods to manage MCRAccessKey.

Constructor Summary

Constructors

Constructor	Description
MCRAccessKeyManager()

Method Summary

Modifier and Type	Method	Description
static void	addAccessKeys(MCRObjectID objectId, List<MCRAccessKey> accessKeys)	Adds MCRAccessKey list for given MCRObjectID.
static void	clearAccessKeys()	Deletes all MCRAccessKey.
static void	clearAccessKeys(MCRObjectID objectId)	Deletes the all MCRAccessKey for given MCRObjectID.
static void	createAccessKey(MCRObjectID objectId, MCRAccessKey accessKey)	Creates a MCRAccessKey for given MCRObjectID.
static MCRAccessKey	getAccessKeyWithSecret(MCRObjectID objectId, String secret)	Return the MCRAccessKey for given MCRObjectID and secret.
static String	hashSecret(String secret, MCRObjectID objectId)	Encrypts secret and uses MCRObjectID as salt.
static boolean	isValidSecret(String secret)	Checks the quality of the secret.
static boolean	isValidType(String type)	Checks the quality of the permission.
static List<MCRAccessKey>	listAccessKeys(MCRObjectID objectId)	Returns all access keys for given MCRObjectID.
static List<MCRAccessKey>	listAccessKeysWithType(MCRObjectID objectId, String type)	Return the access keys for given MCRObjectID and type.
static void	removeAccessKey(MCRObjectID objectId, String secret)	Removes MCRAccessKey for given MCRObjectID and secret.
static void	updateAccessKey(MCRObjectID objectId, String secret, MCRAccessKey updatedAccessKey)	Updates MCRAccessKey

Methods inherited from class java.lang.Object

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

Constructor Details

MCRAccessKeyManager

public MCRAccessKeyManager()

Method Details

listAccessKeys

public static List<MCRAccessKey> listAccessKeys(MCRObjectID objectId)

Returns all access keys for given MCRObjectID.

Parameters:

objectId - the MCRObjectID

Returns:

MCRAccessKey list

isValidType

public static boolean isValidType(String type)

Checks the quality of the permission.

Parameters:

type - permission type

Returns:

true if valid or false

isValidSecret

public static boolean isValidSecret(String secret)

Checks the quality of the secret.

Parameters:

secret - the secret

Returns:

true if valid or false

hashSecret

public static String hashSecret(String secret,
 MCRObjectID objectId)
                         throws MCRException

Encrypts secret and uses MCRObjectID as salt.

Parameters:

secret - the secret

objectId - the MCRObjectID

Returns:

hashed secret

Throws:

MCRException - if encryption fails

createAccessKey

public static void createAccessKey(MCRObjectID objectId,
 MCRAccessKey accessKey)
                            throws MCRException

Creates a MCRAccessKey for given MCRObjectID. Hashed the secret

Parameters:

objectId - the MCRObjectID

accessKey - access key with secret

Throws:

MCRException - key is not valid

addAccessKeys

public static void addAccessKeys(MCRObjectID objectId,
 List<MCRAccessKey> accessKeys)
                          throws MCRAccessKeyException

Adds MCRAccessKey list for given MCRObjectID.

Parameters:

objectId - the MCRObjectID

accessKeys - the MCRAccessKey list

Throws:

MCRAccessKeyException - key is not valid

clearAccessKeys

public static void clearAccessKeys()

Deletes all MCRAccessKey.

clearAccessKeys

public static void clearAccessKeys(MCRObjectID objectId)

Deletes the all MCRAccessKey for given MCRObjectID.

Parameters:

objectId - the MCRObjectID

removeAccessKey

public static void removeAccessKey(MCRObjectID objectId,
 String secret)
                            throws MCRAccessKeyNotFoundException

Removes MCRAccessKey for given MCRObjectID and secret.

Parameters:

objectId - the MCRObjectID

secret - the secret

Throws:

MCRAccessKeyNotFoundException

updateAccessKey

public static void updateAccessKey(MCRObjectID objectId,
 String secret,
 MCRAccessKey updatedAccessKey)
                            throws MCRException

Updates MCRAccessKey

Parameters:

objectId - the MCRObjectID

secret - the access key secret

updatedAccessKey - access key

Throws:

MCRException - if update fails

getAccessKeyWithSecret

public static MCRAccessKey getAccessKeyWithSecret(MCRObjectID objectId,
 String secret)

Return the MCRAccessKey for given MCRObjectID and secret.

Parameters:

objectId - the MCRObjectID

secret - the hashed secret

Returns:

the MCRAccessKey

listAccessKeysWithType

public static List<MCRAccessKey> listAccessKeysWithType(MCRObjectID objectId,
 String type)

Return the access keys for given MCRObjectID and type.

Parameters:

objectId - the MCRObjectID

type - the type

Returns:

MCRAccessKey list