de.innovationgate.webgate.api

Class WGACL

java.lang.Object

de.innovationgate.webgate.api.WGACL

public class WGACL
extends java.lang.Object

Represents the access control list of a database, that decides, which user has which rights.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VALID_ROLENAME_CHARS String containing all characters a role name may consist of

Method Summary

Methods

Modifier and Type	Method and Description
WGACLEntry	createEntry(java.lang.String name, int type, int accessLevel) Creates a new ACL entry, that defines the access right for a user, group or role.
WGACLEntry	createRoleEntry(java.lang.String name) Creates a new role entry in the ACL
WGACLEntry	createUserEntry(java.lang.String name, int accessLevel) Creates a new ACL entry, that defines the access right for a user or group.
java.util.List	getAllEntries() Returns all ACL entries in this ACL.
WGACLEntry	getEntry(java.lang.String name) Returns the entry for a given name
java.util.List	getOwnersOfRole(WGACLEntry roleEntry) Gets all the acl entries that are members of a specific role.
java.util.Map	getRoles() Returns all roles in this ACL.
java.util.Map	getUsers() Returns all user/group entries of this ACL.
static boolean	isValidRoleName(java.lang.String name) Determines if a name is a valid role name.
WGACLEntryFlags	parseFlags(WGACLEntry entry) Parses the given flags and returns a WGACLEntryFlags containing the parsed flag information
void	remove(WGACLEntry entry) Removes the given ACL entry from the ACL.
void	save(WGACLEntry entry) Saves the given ACL entry.

Methods inherited from class java.lang.Object

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

Field Detail

VALID_ROLENAME_CHARS

public static final java.lang.String VALID_ROLENAME_CHARS

String containing all characters a role name may consist of

See Also:

Constant Field Values

Method Detail

getUsers

public java.util.Map getUsers()
                       throws WGAPIException

Returns all user/group entries of this ACL.

Throws:

WGAPIException

getRoles

public java.util.Map getRoles()
                       throws WGAPIException

Returns all roles in this ACL.

Throws:

WGAPIException

getAllEntries

public java.util.List getAllEntries()
                             throws WGAPIException

Returns all ACL entries in this ACL.

Throws:

WGAPIException

getEntry

public WGACLEntry getEntry(java.lang.String name)
                    throws WGAPIException

Returns the entry for a given name

Parameters:

name - Name of user or group

Returns:

The ACL enty for this user or group, null if there is none of that name

Throws:

WGAPIException

createEntry

public WGACLEntry createEntry(java.lang.String name,
                     int type,
                     int accessLevel)
                       throws WGAPIException,
                              WGAuthorisationException,
                              WGBackendException

Creates a new ACL entry, that defines the access right for a user, group or role. The new entry is immediately saved when it is returned.

Parameters:

name - Name of the user, group or role.

type - Type of entry. User constants WGACLEntry.TYPE_.... Not used yet since there are no roles till now.

accessLevel - The Access level for the user. Use constants WGDatabase.ACCESSLEVEL_....

Returns:

The newly created ACL entry

Throws:

WGCreationException - If something went wrong in the background creation process.

WGAuthorisationException - If you are not authorized to create entries.

WGAPIException

WGBackendException

createRoleEntry

public WGACLEntry createRoleEntry(java.lang.String name)
                           throws WGAuthorisationException,
                                  WGBackendException,
                                  WGAPIException

Creates a new role entry in the ACL

Parameters:

name - Name of the role. See isValidRoleName(java.lang.String) for valid role names

Returns:

The newly created role entry

Throws:

WGAuthorisationException

WGAPIException

WGAPIException

WGBackendException

createUserEntry

public WGACLEntry createUserEntry(java.lang.String name,
                         int accessLevel)
                           throws WGAPIException

Creates a new ACL entry, that defines the access right for a user or group.

Parameters:

name - Name of user or group

accessLevel - The Access level for the user. Use constants WGDatabase.ACCESSLEVEL_....

Returns:

The newly created ACL entry

Throws:

WGCreationException - If something went wrong in the background creation process.

WGAuthorisationException - If you are not authorized to create entries.

WGAPIException

remove

public void remove(WGACLEntry entry)
            throws WGAPIException

Removes the given ACL entry from the ACL.

Parameters:

entry - The entry to remove

Throws:

WGAuthorisationException - If you are not authorized to do this

WGAPIException

save

public void save(WGACLEntry entry)
          throws WGAPIException

Saves the given ACL entry.

Parameters:

entry - The entry to save.

Throws:

WGAuthorisationException - If you are not authorized to do this

WGAPIException

parseFlags

public WGACLEntryFlags parseFlags(WGACLEntry entry)
                           throws WGIllegalDataException

Parses the given flags and returns a WGACLEntryFlags containing the parsed flag information

Parameters:

entry - The entry whose flags are parsed

Throws:

WGIllegalDataException

isValidRoleName

public static boolean isValidRoleName(java.lang.String name)

Determines if a name is a valid role name. Valid role names contain only these characters: a-z,A-Z,0-9,$,#,[,]

Parameters:

name - The role name candidate

Returns:

true, if the role name is valid, false if not

getOwnersOfRole

public java.util.List getOwnersOfRole(WGACLEntry roleEntry)
                               throws WGAPIException

Gets all the acl entries that are members of a specific role.

Parameters:

roleEntry - The entry of the role whose members are searched

Returns:

WGACLEntry objects of members of the role

Throws:

WGAPIException