org.gcube.common.homelibrary.jcr.workspace.accessmanager

Class JCRPrivilegesInfo

java.lang.Object

org.gcube.common.homelibrary.jcr.workspace.accessmanager.JCRPrivilegesInfo

public class JCRPrivilegesInfo
extends Object

Helper class to assist in the usage of access control from scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JCRPrivilegesInfo.AccessRights Wrapper class that holds the set of Privileges that are granted and/or denied for a specific principal.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OWNER
static String	PORTAL_LOGIN

Constructor Summary

Constructors

Constructor and Description
JCRPrivilegesInfo()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canAddChildren(String owner, String currentUser, String absPath) Checks whether the current user has been granted privileges to add children to the specified path.
static boolean	canDelete(String owner, String currentUser, String absPath, boolean root) Checks whether the current user has been granted privileges to delete the specified path.
static boolean	canDeleteChildren(String user, String absPath) Checks whether the current user has been granted privileges to delete children of the specified path.
static boolean	canModifyProperties(String owner, String currentUser, String absPath, boolean root) Checks whether the current user has been granted privileges to modify properties of the specified path.
static boolean	canReadNode(String owner, String currentUser, String absPath)
static org.gcube.common.homelibrary.home.workspace.accessmanager.ACLType	getACLByUser(String user, String absPath) Get ACL by username
Map<Principal,JCRPrivilegesInfo.AccessRights>	getDeclaredAccessRights(javax.jcr.Node node) Returns the mapping of declared access rights that have been set for the resource at the given path.
Map<Principal,JCRPrivilegesInfo.AccessRights>	getDeclaredAccessRights(javax.jcr.Session session, String absPath) Returns the mapping of declared access rights that have been set for the resource at the given path.
JCRPrivilegesInfo.AccessRights	getDeclaredAccessRightsForPrincipal(javax.jcr.Node node, String principalId) Returns the declared access rights for the specified Node for the given principalId.
JCRPrivilegesInfo.AccessRights	getDeclaredAccessRightsForPrincipal(javax.jcr.Session session, String absPath, String principalId) Returns the declared access rights for the resource at the specified path for the given principalId.
Map<Principal,JCRPrivilegesInfo.AccessRights>	getEffectiveAccessRights(javax.jcr.Node node) Returns the mapping of effective access rights that have been set for the resource at the given path.
Map<Principal,JCRPrivilegesInfo.AccessRights>	getEffectiveAccessRights(javax.jcr.Session session, String absPath) Returns the mapping of effective access rights that have been set for the resource at the given path.
JCRPrivilegesInfo.AccessRights	getEffectiveAccessRightsForPrincipal(javax.jcr.Node node, String principalId) Returns the effective access rights for the specified Node for the given principalId.
JCRPrivilegesInfo.AccessRights	getEffectiveAccessRightsForPrincipal(javax.jcr.Session session, String absPath, String principalId) Returns the effective access rights for the resource at the specified path for the given principalId.
javax.jcr.security.Privilege[]	getSupportedPrivileges(javax.jcr.Node node) Return the supported Privileges for the specified node.
javax.jcr.security.Privilege[]	getSupportedPrivileges(javax.jcr.Session session, String absPath) Returns the supported privileges for the specified path.

Methods inherited from class java.lang.Object

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

Field Detail

OWNER

public static final String OWNER

See Also:

Constant Field Values

PORTAL_LOGIN

public static final String PORTAL_LOGIN

See Also:

Constant Field Values

Constructor Detail

JCRPrivilegesInfo

public JCRPrivilegesInfo()

Method Detail

getSupportedPrivileges

public javax.jcr.security.Privilege[] getSupportedPrivileges(javax.jcr.Node node)
                                                      throws javax.jcr.RepositoryException

Return the supported Privileges for the specified node.

Parameters:

node - the node to check

Returns:

array of Privileges

Throws:

javax.jcr.RepositoryException

getSupportedPrivileges

public javax.jcr.security.Privilege[] getSupportedPrivileges(javax.jcr.Session session,
                                                    String absPath)
                                                      throws javax.jcr.RepositoryException

Returns the supported privileges for the specified path.

Parameters:

session - the session for the current user

absPath - the path to get the privileges for

Returns:

array of Privileges

Throws:

javax.jcr.RepositoryException

getDeclaredAccessRights

public Map<Principal,JCRPrivilegesInfo.AccessRights> getDeclaredAccessRights(javax.jcr.Node node)
                                                                      throws javax.jcr.RepositoryException

Returns the mapping of declared access rights that have been set for the resource at the given path.

Parameters:

node - the node to get the access rights for

Returns:

map of access rights. Key is the user/group principal, value contains the granted/denied privileges

Throws:

javax.jcr.RepositoryException

getDeclaredAccessRights

public Map<Principal,JCRPrivilegesInfo.AccessRights> getDeclaredAccessRights(javax.jcr.Session session,
                                                                    String absPath)
                                                                      throws javax.jcr.RepositoryException

Returns the mapping of declared access rights that have been set for the resource at the given path.

Parameters:

session - the current user session.

absPath - the path of the resource to get the access rights for

Returns:

map of access rights. Key is the user/group principal, value contains the granted/denied privileges

Throws:

javax.jcr.RepositoryException

getDeclaredAccessRightsForPrincipal

public JCRPrivilegesInfo.AccessRights getDeclaredAccessRightsForPrincipal(javax.jcr.Node node,
                                                                 String principalId)
                                                                   throws javax.jcr.RepositoryException

Returns the declared access rights for the specified Node for the given principalId.

Parameters:

node - the JCR node to retrieve the access rights for

principalId - the principalId to get the access rights for

Returns:

access rights for the specified principal

Throws:

javax.jcr.RepositoryException

getDeclaredAccessRightsForPrincipal

public JCRPrivilegesInfo.AccessRights getDeclaredAccessRightsForPrincipal(javax.jcr.Session session,
                                                                 String absPath,
                                                                 String principalId)
                                                                   throws javax.jcr.RepositoryException

Returns the declared access rights for the resource at the specified path for the given principalId.

Parameters:

session - the current JCR session

absPath - the path of the resource to retrieve the rights for

principalId - the principalId to get the access rights for

Returns:

access rights for the specified principal

Throws:

javax.jcr.RepositoryException

getEffectiveAccessRights

public Map<Principal,JCRPrivilegesInfo.AccessRights> getEffectiveAccessRights(javax.jcr.Node node)
                                                                       throws javax.jcr.RepositoryException

Returns the mapping of effective access rights that have been set for the resource at the given path.

Parameters:

node - the node to get the access rights for

Returns:

map of access rights. Key is the user/group principal, value contains the granted/denied privileges

Throws:

javax.jcr.RepositoryException

getEffectiveAccessRights

public Map<Principal,JCRPrivilegesInfo.AccessRights> getEffectiveAccessRights(javax.jcr.Session session,
                                                                     String absPath)
                                                                       throws javax.jcr.RepositoryException

Returns the mapping of effective access rights that have been set for the resource at the given path.

Parameters:

session - the current user session.

absPath - the path of the resource to get the access rights for

Returns:

map of access rights. Key is the user/group principal, value contains the granted/denied privileges

Throws:

javax.jcr.RepositoryException

getEffectiveAccessRightsForPrincipal

public JCRPrivilegesInfo.AccessRights getEffectiveAccessRightsForPrincipal(javax.jcr.Node node,
                                                                  String principalId)
                                                                    throws javax.jcr.RepositoryException

Returns the effective access rights for the specified Node for the given principalId.

Parameters:

node - the JCR node to retrieve the access rights for

principalId - the principalId to get the access rights for

Returns:

access rights for the specified principal

Throws:

javax.jcr.RepositoryException

getEffectiveAccessRightsForPrincipal

public JCRPrivilegesInfo.AccessRights getEffectiveAccessRightsForPrincipal(javax.jcr.Session session,
                                                                  String absPath,
                                                                  String principalId)
                                                                    throws javax.jcr.RepositoryException

Returns the effective access rights for the resource at the specified path for the given principalId.

Parameters:

session - the current JCR session

absPath - the path of the resource to retrieve the rights for

principalId - the principalId to get the access rights for

Returns:

access rights for the specified principal

Throws:

javax.jcr.RepositoryException

canAddChildren

public static boolean canAddChildren(String owner,
                     String currentUser,
                     String absPath)
                              throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Checks whether the current user has been granted privileges to add children to the specified path.

Parameters:

owner -

currentUser -

absPath -

Returns:

true if the current user has the privileges, false otherwise

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException

canDeleteChildren

public static boolean canDeleteChildren(String user,
                        String absPath)
                                 throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Checks whether the current user has been granted privileges to delete children of the specified path.

Parameters:

user -

absPath -

Returns:

true if the user can delete children

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException

canDelete

public static boolean canDelete(String owner,
                String currentUser,
                String absPath,
                boolean root)
                         throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Checks whether the current user has been granted privileges to delete the specified path.

Parameters:

owner -

currentUser -

absPath -

root -

Returns:

true if the current user can delete the node specified by the absPath

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException

canModifyProperties

public static boolean canModifyProperties(String owner,
                          String currentUser,
                          String absPath,
                          boolean root)
                                   throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Checks whether the current user has been granted privileges to modify properties of the specified path.

Parameters:

owner -

currentUser -

absPath -

root -

Returns:

true if the current user can modify properties of node specified by absPath

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException

getACLByUser

public static org.gcube.common.homelibrary.home.workspace.accessmanager.ACLType getACLByUser(String user,
                                                                             String absPath)
                                                                                      throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Get ACL by username

Parameters:

user -

absPath -

Returns:

an ACLType privilege

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException

canReadNode

public static boolean canReadNode(String owner,
                  String currentUser,
                  String absPath)
                           throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException

Throws:

org.gcube.common.homelibrary.home.exceptions.InternalErrorException