Package edm.edom3

Interface EDMAccessManager

All Superinterfaces:

EDMContextDependent

public interface EDMAccessManager
extends EDMContextDependent

This interface wraps access management for an object.

Author:

aet

Method Summary

Modifier and Type	Method	Description
void	addAdministrator(EDMUserOrGroup admin)	Add an administrator
EDMAccess	getAccessFor(EDMUserOrGroup userOrGroup)	Retrieve dedicated access for a user
EDMAccess[]	getAllAccessFor()	Get all dedicated access
EDMAccess	getEffectiveAccess(EDMUserOrGroup userOrGroup)	Retrieve effective access for a user (superuser only?)
EDMGroup	getGroupOwner()	Gets the owner group.
EDMInstance	getInstance()	Get the object governed by this access manager
EDMAccess	getMyAccess()	Retrieve effective access
EDMUser	getObjectOwner()	Gets the owner.
EDMAccess	getRoleAccess(long accessRole)	Retrieve access for PUBLIC, OWNER or GROUP
long	getRoleAccessRights(long accessRole)	Retrieve access rights bitmask for PUBLIC, OWNER or GROUP
void	removeAccessFor(EDMUserOrGroup userOrGroup)	Remove a dedicated access
void	removeAdministrator(EDMUserOrGroup admin)	Remove an administrator
EDMAccess	setAccessFor(EDMUserOrGroup userOrGroup, long rights)	Set a dedicated access
void	setGroupOwner(EDMGroup owner)	Change access group owner
void	setObjectOwner(EDMUser owner)	Change access owner
void	setRoleAccessRights(long accessRole, long rights)	set access for PUBLIC, OWNER or GROUP

Methods inherited from interface edm.edom3.EDMContextDependent

getContext

Method Detail

getInstance

EDMInstance getInstance()
                 throws EdmiException

Get the object governed by this access manager

Returns:

the object

Throws:

EdmiException - If the method fails

getObjectOwner

EDMUser getObjectOwner()
                throws EdmiException

Gets the owner. The owner has privilegies to modify the access on the object the access apply to

Returns:

The owner of this access object

Throws:

EdmiException - if the method fails

setObjectOwner

void setObjectOwner(EDMUser owner)
             throws EdmiException

Change access owner

Parameters:

owner - New owner

Throws:

EdmiException - if the method fails

getGroupOwner

EDMGroup getGroupOwner()
                throws EdmiException

Gets the owner group. The group owner has privilegies to modify the access on the object the access apply to

Returns:

The grousp owner of this access object

Throws:

EdmiException - if the method fails

setGroupOwner

void setGroupOwner(EDMGroup owner)
            throws EdmiException

Change access group owner

Parameters:

owner - New owner

Throws:

EdmiException - if the method fails

addAdministrator

void addAdministrator(EDMUserOrGroup admin)
               throws EdmiException

Add an administrator

Parameters:

admin - New administrator

Throws:

EdmiException - if the method fails

removeAdministrator

void removeAdministrator(EDMUserOrGroup admin)
                  throws EdmiException

Remove an administrator

Parameters:

admin - New administrator

Throws:

EdmiException - if the method fails

getAllAccessFor

EDMAccess[] getAllAccessFor()
                     throws EdmiException

Get all dedicated access

Returns:

a list of accesses for users/groups, null if none assigned

Throws:

EdmiException - if the method fails

getAccessFor

EDMAccess getAccessFor(EDMUserOrGroup userOrGroup)
                throws EdmiException

Retrieve dedicated access for a user

Parameters:

userOrGroup - user or group to check dedicated access for

Returns:

access object for the given user, null if none set

Throws:

EdmiException - if the method fails

setAccessFor

EDMAccess setAccessFor(EDMUserOrGroup userOrGroup,
                       long rights)
                throws EdmiException

Set a dedicated access

Parameters:

userOrGroup - the user or group to grant special access to

rights - access rights to grant

Returns:

the created or modified access

Throws:

EdmiException - if the method fails

removeAccessFor

void removeAccessFor(EDMUserOrGroup userOrGroup)
              throws EdmiException

Remove a dedicated access

Parameters:

userOrGroup - the user or group to remove special access from

Throws:

EdmiException - if the method fails

getRoleAccess

EDMAccess getRoleAccess(long accessRole)
                 throws EdmiException

Retrieve access for PUBLIC, OWNER or GROUP

Parameters:

accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USER

Returns:

access object for the given role

Throws:

EdmiException - if the method fails

getRoleAccessRights

long getRoleAccessRights(long accessRole)
                  throws EdmiException

Retrieve access rights bitmask for PUBLIC, OWNER or GROUP

Parameters:

accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USER

Returns:

access rights for the given role

Throws:

EdmiException - if the method fails

setRoleAccessRights

void setRoleAccessRights(long accessRole,
                         long rights)
                  throws EdmiException

set access for PUBLIC, OWNER or GROUP

Parameters:

accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USER

rights - access rights to grant

Throws:

EdmiException - if the method fails

getEffectiveAccess

EDMAccess getEffectiveAccess(EDMUserOrGroup userOrGroup)
                      throws EdmiException

Retrieve effective access for a user (superuser only?)

Parameters:

userOrGroup - user or group to check access for, null = myself

Returns:

access object for the given role

Throws:

EdmiException - if the method fails

getMyAccess

EDMAccess getMyAccess()
               throws EdmiException

Retrieve effective access

Returns:

access object for the calling context

Throws:

EdmiException - if the method fails