com.hcl.domino.security

Interface Acl

public interface Acl

Access Control List of a database including functions to query access

Author:

t.b.d

Method Summary

Modifier and Type	Method and Description
void	addEntry(String name, AclLevel accessLevel, List<String> roles, Collection<AclFlag> accessFlags) This function adds an entry to an access control list.
void	addRole(String role) Adds a role to the ACL.
String	getAdminServer() Reads the name of the administration server for the access control list.
List<AclEntry>	getEntries() Returns all ACL entries
Optional<AclEntry>	getEntry(String name) Convenience method that call getEntries() and returns a single value for the specified name
List<String>	getRoles() Returns all roles declared in the ACL
boolean	isUniformAccess() Check if "Enforce consistent ACL" is set
AclAccess	lookupAccess(String userName) Looks up the access level for a user and his groups
AclAccess	lookupAccess(UserNamesList namesList) Looks up the access level for a UserNamesList
void	removeEntry(String name) This function deletes an entry from an access control list.
void	removeRole(String role) Removes a role from the ACL
void	renameRole(String oldName, String newName) Changes the name of a role
void	save() This function persists the access control list in the parent database.
void	setAdminServer(String server) Change the name of the administration server for the access control list.
void	setUniformAccess(boolean uniformAccess) Changes the value for "Enforce consistent ACL"
void	updateEntry(String name, String newName, AclLevel newAccessLevel, List<String> newRoles, Collection<AclFlag> newFlags) This function updates an entry in an access control list. Unless the user's name is specified to be modified, the information that is not specified to be modified remains intact. If the user's name is specified to be modified, the user entry is deleted and a new entry is created. Unless the other access control information is specified to be modified as well, the other access control information will be cleared and the user will have No Access to the database.

Method Detail

lookupAccess

AclAccess lookupAccess(String userName)

Looks up the access level for a user and his groups

Parameters:

userName - username, either canonical or abbreviated

Returns:

acl access info, with access level, flags and roles

lookupAccess

AclAccess lookupAccess(UserNamesList namesList)

Looks up the access level for a UserNamesList

Parameters:

namesList - names list for a user

Returns:

acl access info, with access level, flags and roles

getRoles

List<String> getRoles()

Returns all roles declared in the ACL

Returns:

roles

getEntries

List<AclEntry> getEntries()

Returns all ACL entries

Returns:

ACL entries hashed by their username in the order they got returned from the C API

getEntry

Optional<AclEntry> getEntry(String name)

Convenience method that call getEntries() and returns a single value for the specified name

Parameters:

name - name

Returns:

an Optional describing the ACL entry, or an empty one if not found

addEntry

void addEntry(String name,
              AclLevel accessLevel,
              List<String> roles,
              Collection<AclFlag> accessFlags)

This function adds an entry to an access control list.

Parameters:

name - user or group to be added, either in abbreviated or canonical format

accessLevel - Access level (AclLevel), of the entry to be added

roles - roles to be set for this user

accessFlags - Access level modifier flags (AclFlag), e.g.: unable to delete documents, unable to create documents, of the entry to be added

removeEntry

void removeEntry(String name)

This function deletes an entry from an access control list.

Parameters:

name - user or group to be deleted, in abbreviated or canonical format

updateEntry

void updateEntry(String name,
                 String newName,
                 AclLevel newAccessLevel,
                 List<String> newRoles,
                 Collection<AclFlag> newFlags)

This function updates an entry in an access control list.

Unless the user's name is specified to be modified, the information that is not specified to be modified remains intact.

If the user's name is specified to be modified, the user entry is deleted and a new entry is created.
Unless the other access control information is specified to be modified as well, the other access control information will be cleared and the user will have No Access to the database.

Parameters:

name - name of the entry to change

newName - optional new entry name or null

newAccessLevel - optional new entry access level or null

newRoles - optional new entry roles or null

newFlags - optional new acl flags or null

addRole

void addRole(String role)

Adds a role to the ACL. If the role is already in the ACL, the method does nothing.

Parameters:

role - role to add

removeRole

void removeRole(String role)

Removes a role from the ACL

Parameters:

role - role to remove

renameRole

void renameRole(String oldName,
                String newName)

Changes the name of a role

Parameters:

oldName - old role name, either enclosed with [] or not

newName - new role name, either enclosed with [] or not

Throws:

DominoException - if role could not be found

setAdminServer

void setAdminServer(String server)

Change the name of the administration server for the access control list.

Parameters:

server - server, either in abbreviated or canonical format

getAdminServer

String getAdminServer()

Reads the name of the administration server for the access control list.

Returns:

the server-name

isUniformAccess

boolean isUniformAccess()

Check if "Enforce consistent ACL" is set

Returns:

true if set

setUniformAccess

void setUniformAccess(boolean uniformAccess)

Changes the value for "Enforce consistent ACL"

Parameters:

uniformAccess - true to set "Enforce consistent ACL" flag

save

void save()

This function persists the access control list in the parent database.