com.hcl.domino.keep.admin

Class AclFunctions

java.lang.Object

com.hcl.domino.keep.admin.AclFunctions

public class AclFunctions
extends java.lang.Object

Helper functions to deal with ACL needs

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addRoleToACL(com.hcl.domino.security.Acl acl, java.lang.String roleToAdd) Add a role to the ACL
static void	checkRoleNotExists(java.util.List<java.lang.String> existingRoles, java.lang.String roleToCheck) Validate that a role doesn’t already exist in the ACL
static io.vertx.core.json.JsonObject	convertAclEntry(com.hcl.domino.security.AclEntry aclEntry) Converts an ACL Entry into the relevant JSON object
static java.lang.String	getBracketRoleName(java.lang.String raw) Role name with brackets
static java.lang.String	getCleanRoleName(java.lang.String raw) Returns a proper role name, with no square brackets inside but around and limited to Maximum Role lenght
static java.lang.String	renameRoleInACL(com.hcl.domino.security.Acl acl, java.lang.String oldName, java.lang.String newName) Rename a role in the ACL

Methods inherited from class java.lang.Object

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

Method Detail

addRoleToACL

public static java.lang.String addRoleToACL(com.hcl.domino.security.Acl acl,
                                            java.lang.String roleToAdd)

Add a role to the ACL

Parameters:

acl - to update

roleToAdd - to ACL

Returns:

role name as it appears in the ACL, e.g. “[Admin]”

checkRoleNotExists

public static void checkRoleNotExists(java.util.List<java.lang.String> existingRoles,
                                      java.lang.String roleToCheck)
                               throws KeepException

Validate that a role doesn’t already exist in the ACL

Parameters:

existingRoles - roles in the ACL

roleToCheck - role name without “[“ and ”]”, e.g. “Admin”

Throws:

KeepException - error if it already exists

convertAclEntry

public static io.vertx.core.json.JsonObject convertAclEntry(com.hcl.domino.security.AclEntry aclEntry)

Converts an ACL Entry into the relevant JSON object

Parameters:

aclEntry - ACL Entry to convert

Returns:

JsonObject containing the ACL serialized

getBracketRoleName

public static java.lang.String getBracketRoleName(java.lang.String raw)

Role name with brackets

Parameters:

raw - Role name with or without brackets

Returns:

properly bracketed role name e.g. [Admin]

getCleanRoleName

public static java.lang.String getCleanRoleName(java.lang.String raw)

Returns a proper role name, with no square brackets inside but around and limited to Maximum Role lenght

Parameters:

raw -

• incoming role, might or might not have [ ]

Returns:

• role that does not have [ ], lenght limited

renameRoleInACL

public static java.lang.String renameRoleInACL(com.hcl.domino.security.Acl acl,
                                               java.lang.String oldName,
                                               java.lang.String newName)
                                        throws KeepExceptionMissingParameters

Rename a role in the ACL

Parameters:

acl - to update

oldName - to rename

newName - to rename to

Returns:

role name as it appears in the ACL, e.g. “[Admin]”

Throws:

KeepExceptionMissingParameters