de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation

Class PermissionProviderImplementation

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.file.implementation.PermissionProviderImplementation

All Implemented Interfaces:

PermissionProvider, java.io.Serializable

public class PermissionProviderImplementation
extends java.lang.Object
implements java.io.Serializable, PermissionProvider

Implementation of PermissionProvider interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PermissionProviderImplementation()

Method Summary

Modifier and Type	Method and Description
java.util.List<EdalPermission>	findPermissions(java.util.Set<java.security.Principal> principalList) Provides all granted EdalPermission object for a Set of Principal objects.
javax.mail.internet.InternetAddress	getCurrentRootUser() Load the email address of the existing root user.
java.util.List<java.lang.Class<? extends java.security.Principal>>	getSupportedPrincipals() Getter all supported Principals of the current eDAL system.
static java.lang.InheritableThreadLocal<java.lang.String>	getThreadlocalentityid() Getter for the field THREAD_LOCAL_ENTITY_ID.
void	grantPermission(java.lang.String principalType, java.lang.String principalName, EdalPermission edalPermission) Grant one EdalPermission for one Principal.
void	grantPermission(java.lang.String principalType, java.lang.String principalName, PrimaryDataEntity entity) Grant all EdalPermissions for one Principal.
boolean	isRoot(java.security.Principal principal) Check if the Principal is a root user.
boolean	isRootValidated(javax.mail.internet.InternetAddress address) Check if the root user is already validated
void	revokePermission(java.lang.String principalType, java.lang.String principalName, EdalPermission edalPermission) Revoke one EdalPermission for one Principal.
void	revokePermission(java.lang.String principalType, java.lang.String principalName, PrimaryDataEntity entity) Revoke all EdalPermissions for one Principal.
void	setPermissionObjectID(java.lang.String id) Set the id of the current PrimaryDataEntity object.
void	storeRootUser(javax.security.auth.Subject subject, javax.mail.internet.InternetAddress address, java.util.UUID uuid) Store a new root user to the back-end
boolean	validateRootUser(javax.mail.internet.InternetAddress address, java.util.UUID uuid) Validate the root user with the given email address and UUID

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionProviderImplementation

public PermissionProviderImplementation()

Method Detail

getThreadlocalentityid

public static java.lang.InheritableThreadLocal<java.lang.String> getThreadlocalentityid()

Getter for the field THREAD_LOCAL_ENTITY_ID.

Returns:

the THREAD_LOCAL_ENTITY_ID

findPermissions

public java.util.List<EdalPermission> findPermissions(java.util.Set<java.security.Principal> principalList)

Provides all granted EdalPermission object for a Set of Principal objects. A Set of Principal represent a Subject.

Specified by:

findPermissions in interface PermissionProvider

Parameters:

principalList - a Set of Principal objects.

Returns:

a List of all granted EdalPermission objects.

grantPermission

public void grantPermission(java.lang.String principalType,
                            java.lang.String principalName,
                            EdalPermission edalPermission)
                     throws PrimaryDataEntityException

Grant one EdalPermission for one Principal.

grantPermission(Principal,Method)

Check if the Principal or the EdalPermission exists before grant new permission.

Specified by:

grantPermission in interface PermissionProvider

Parameters:

principalType - the type of the Principal object.

principalName - the name of the Principal object.

edalPermission - the EdalPermission to grant.

Throws:

PrimaryDataEntityException - if unable to grant EdalPermission.

grantPermission

public void grantPermission(java.lang.String principalType,
                            java.lang.String principalName,
                            PrimaryDataEntity entity)
                     throws PrimaryDataEntityException

Grant all EdalPermissions for one Principal.

grantPermission(Principal,ALL)

Specified by:

grantPermission in interface PermissionProvider

Parameters:

principalType - the type of the Principal object.

principalName - the name of the Principal object.

entity - the PrimaryDataEntity to grant.

Throws:

PrimaryDataEntityException - if unable to grant EdalPermission.

isRoot

public boolean isRoot(java.security.Principal principal)

Check if the Principal is a root user.

Specified by:

isRoot in interface PermissionProvider

Parameters:

principal - the Principal to check.

Returns:

true when the Principal is a root user; false otherwise.

revokePermission

public void revokePermission(java.lang.String principalType,
                             java.lang.String principalName,
                             EdalPermission edalPermission)
                      throws PrimaryDataEntityException

Revoke one EdalPermission for one Principal.

Specified by:

revokePermission in interface PermissionProvider

Parameters:

principalType - the type of the Principal object.

principalName - the name of the Principal object.

edalPermission - the EdalPermission to revoke.

Throws:

PrimaryDataEntityException - if unable to revoke EdalPermission.

revokePermission

public void revokePermission(java.lang.String principalType,
                             java.lang.String principalName,
                             PrimaryDataEntity entity)
                      throws PrimaryDataEntityException

Revoke all EdalPermissions for one Principal.

revokePermission(Principal,ALL)

Specified by:

revokePermission in interface PermissionProvider

Parameters:

principalType - the type of the Principal object.

principalName - the name of the Principal object.

entity - the PrimaryDataEntity to revoke.

Throws:

PrimaryDataEntityException - if unable to revoke EdalPermission.

setPermissionObjectID

public void setPermissionObjectID(java.lang.String id)

Set the id of the current PrimaryDataEntity object.

Specified by:

setPermissionObjectID in interface PermissionProvider

Parameters:

id - the id to set.

storeRootUser

public void storeRootUser(javax.security.auth.Subject subject,
                          javax.mail.internet.InternetAddress address,
                          java.util.UUID uuid)
                   throws EdalException

Store a new root user to the back-end

Specified by:

storeRootUser in interface PermissionProvider

Parameters:

subject - the Subject of the root user

address - the email address of the root user

uuid - the UUID of the root user

Throws:

EdalException - if unable to store

validateRootUser

public boolean validateRootUser(javax.mail.internet.InternetAddress address,
                                java.util.UUID uuid)

Validate the root user with the given email address and UUID

Specified by:

validateRootUser in interface PermissionProvider

Parameters:

address - the email address of the root user

uuid - the UUID of the root user

Returns:

true if the user is valid, otherwise false

getCurrentRootUser

public javax.mail.internet.InternetAddress getCurrentRootUser()
                                                       throws EdalException

Load the email address of the existing root user.

Specified by:

getCurrentRootUser in interface PermissionProvider

Returns:

the email address.

Throws:

EdalException - If unable to load existing root user.

isRootValidated

public boolean isRootValidated(javax.mail.internet.InternetAddress address)

Check if the root user is already validated

Specified by:

isRootValidated in interface PermissionProvider

Parameters:

address - the email address of the root user

Returns:

yes if the root user is already validated; no if not

getSupportedPrincipals

public java.util.List<java.lang.Class<? extends java.security.Principal>> getSupportedPrincipals()
                                                                                          throws EdalException

Description copied from interface: PermissionProvider

Getter all supported Principals of the current eDAL system.

Specified by:

getSupportedPrincipals in interface PermissionProvider

Returns:

the list of supported Principals

Throws:

EdalException - if unable to load Principals.