|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AccessManager
The AccessManager
can be queried to determines whether privileges
are granted on a specific item.
Field Summary | |
---|---|
static int |
READ
Deprecated. |
static int |
REMOVE
Deprecated. |
static int |
WRITE
Deprecated. |
Method Summary | |
---|---|
boolean |
canAccess(String workspaceName)
Determines whether the subject of the current context is granted access to the given workspace. |
boolean |
canRead(Path itemPath)
Determines whether the item at the specified absolute path can be read. |
void |
checkPermission(ItemId id,
int permissions)
Deprecated. |
void |
checkPermission(Path absPath,
int permissions)
Determines whether the specified permissions are granted
on the item with the specified id (i.e. the target item). |
void |
close()
Close this access manager. |
void |
init(AMContext context)
Initialize this access manager. |
void |
init(AMContext context,
AccessControlProvider acProvider,
WorkspaceAccessManager wspAccessMgr)
Initialize this access manager. |
boolean |
isGranted(ItemId id,
int permissions)
Deprecated. |
boolean |
isGranted(Path absPath,
int permissions)
Determines whether the specified permissions are granted
on the item with the specified absPath (i.e. the target
item, that may or may not yet exist). |
boolean |
isGranted(Path parentPath,
Name childName,
int permissions)
Determines whether the specified permissions are granted
on an item represented by the combination of the given
parentPath and childName (i.e. the target
item, that may or may not yet exist). |
Field Detail |
---|
static final int READ
static final int WRITE
static final int REMOVE
Method Detail |
---|
void init(AMContext context) throws AccessDeniedException, Exception
AccessDeniedException
will
be thrown if the subject of the given context
is not
granted access to the specified workspace.
context
- access manager context
AccessDeniedException
- if the subject is not granted access
to the specified workspace.
Exception
- if another error occursvoid init(AMContext context, AccessControlProvider acProvider, WorkspaceAccessManager wspAccessMgr) throws AccessDeniedException, Exception
AccessDeniedException
will
be thrown if the subject of the given context
is not
granted access to the specified workspace.
context
- access manager context.acProvider
- The access control provider.wspAccessMgr
- The workspace access manager.
AccessDeniedException
- if the subject is not granted access
to the specified workspace.
Exception
- if another error occursvoid close() throws Exception
Exception
- if an error occursvoid checkPermission(ItemId id, int permissions) throws AccessDeniedException, ItemNotFoundException, RepositoryException
permissions
are granted
on the item with the specified id
(i.e. the target item).
id
- the id of the target itempermissions
- A combination of one or more of the following constants
encoded as a bitmask value:
READ
WRITE
REMOVE
AccessDeniedException
- if permission is denied
ItemNotFoundException
- if the target item does not exist
RepositoryException
- it an error occursvoid checkPermission(Path absPath, int permissions) throws AccessDeniedException, RepositoryException
permissions
are granted
on the item with the specified id
(i.e. the target item).
absPath
- Path to an item.permissions
- A combination of one or more of the
Permission
constants encoded as a bitmask value.
AccessDeniedException
- if permission is denied
RepositoryException
- it another error occursboolean isGranted(ItemId id, int permissions) throws ItemNotFoundException, RepositoryException
permissions
are granted
on the item with the specified id
(i.e. the target item).
id
- the id of the target itempermissions
- A combination of one or more of the following constants
encoded as a bitmask value:
READ
WRITE
REMOVE
true
if permission is granted; otherwise false
ItemNotFoundException
- if the target item does not exist
RepositoryException
- if another error occursboolean isGranted(Path absPath, int permissions) throws RepositoryException
permissions
are granted
on the item with the specified absPath
(i.e. the target
item, that may or may not yet exist).
absPath
- the absolute path to testpermissions
- A combination of one or more of the
Permission
constants encoded as a bitmask value.
true
if the specified permissions are granted;
otherwise false
.
RepositoryException
- if an error occurs.boolean isGranted(Path parentPath, Name childName, int permissions) throws RepositoryException
permissions
are granted
on an item represented by the combination of the given
parentPath
and childName
(i.e. the target
item, that may or may not yet exist).
parentPath
- Path to an existing parent node.childName
- Name of the child item that may or may not exist yet.permissions
- A combination of one or more of the
Permission
constants encoded as a bitmask value.
true
if the specified permissions are granted;
otherwise false
.
RepositoryException
- if an error occurs.boolean canRead(Path itemPath) throws RepositoryException
itemPath
- Path to the item to be tested.s
true
if the item can be read; otherwise false
.
RepositoryException
- if an error occurs.boolean canAccess(String workspaceName) throws RepositoryException
false
, if no such workspace
exists.
workspaceName
- name of workspace
true
if the subject of the current context is
granted access to the given workspace; otherwise false
.
RepositoryException
- if an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |