net.bluemind.role.api

Class RoleDescriptor

java.lang.Object

net.bluemind.role.api.RoleDescriptor

public class RoleDescriptor
extends java.lang.Object

Declaration of a role.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	categoryId Associated RoleCategory.
java.util.Set<java.lang.String>	childsRole Child roles.
java.util.Set<java.lang.String>	containerRoles Role applies to containers.
boolean	delegable Role can be delegated.
java.lang.String	description Role description.
BaseDirEntry.Kind	dirEntryKind Role applies to specific directory entry kind.
boolean	dirEntryPromote Role applies to associated directory entry.
java.lang.String	id Unique identifier.
java.lang.String	label Label.
java.lang.String	parentRoleId Parent role, this role inherits all permissions of the parent role.
int	priority Role priority //FIXME unused
boolean	selfPromote Role applies to own roles only.
java.lang.String	siblingRole Sibling role //FIXME explain
boolean	visible Visible in administration.

Constructor Summary

Constructors

Constructor and Description
RoleDescriptor()

Method Summary

Modifier and Type	Method and Description
static RoleDescriptor	create(java.lang.String id, java.lang.String categoryId, java.lang.String label, java.lang.String description)
RoleDescriptor	delegable() Make this role delegable.
RoleDescriptor	forDirEntry(BaseDirEntry.Kind kind)
RoleDescriptor	forDirEntry(BaseDirEntry.Kind kind, java.lang.String siblingRole, java.lang.String parentId)
RoleDescriptor	giveRoles(java.lang.String... roles) Assign child roles.
RoleDescriptor	notVisible() Hide this role.
RoleDescriptor	priotity(int priority) Assign a priority.
RoleDescriptor	withContainerRoles(java.lang.String... roles) Assign container roles.
RoleDescriptor	withParent(java.lang.String parentRoleId) Assign a parent role.
RoleDescriptor	withSelfPromote(java.lang.String parentRoleId) Assign permission to own a role in the context of the specific owner of this role.

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

Unique identifier.

parentRoleId

public java.lang.String parentRoleId

Parent role, this role inherits all permissions of the parent role.

categoryId

public java.lang.String categoryId

Associated RoleCategory.

label

public java.lang.String label

Label.

description

public java.lang.String description

Role description.

selfPromote

public boolean selfPromote

Role applies to own roles only.

dirEntryPromote

public boolean dirEntryPromote

Role applies to associated directory entry.

dirEntryKind

public BaseDirEntry.Kind dirEntryKind

Role applies to specific directory entry kind.

siblingRole

public java.lang.String siblingRole

Sibling role //FIXME explain

childsRole

public java.util.Set<java.lang.String> childsRole

Child roles.

visible

public boolean visible

Visible in administration.

delegable

public boolean delegable

Role can be delegated.

containerRoles

public java.util.Set<java.lang.String> containerRoles

Role applies to containers.

priority

public int priority

Role priority //FIXME unused

Constructor Detail

RoleDescriptor

public RoleDescriptor()

Method Detail

create

public static RoleDescriptor create(java.lang.String id,
                                    java.lang.String categoryId,
                                    java.lang.String label,
                                    java.lang.String description)

giveRoles

public RoleDescriptor giveRoles(java.lang.String... roles)

Assign child roles.

Parameters:

roles - Array of roles.

Returns:

A reference to the current instance (this).

withParent

public RoleDescriptor withParent(java.lang.String parentRoleId)

Assign a parent role.

Parameters:

parentRoleId - Parent role id.

Returns:

A reference to the current instance (this).

withSelfPromote

public RoleDescriptor withSelfPromote(java.lang.String parentRoleId)

Assign permission to own a role in the context of the specific owner of this role. A user owning this role will hava permission "parentRoleId" on the entities he owns.

Parameters:

parentRoleId - Role identifier.

Returns:

A reference to the current instance (this).

withContainerRoles

public RoleDescriptor withContainerRoles(java.lang.String... roles)

Assign container roles.

Parameters:

roles - Array of roles.

Returns:

A reference to the current instance (this).

notVisible

public RoleDescriptor notVisible()

Hide this role.

Returns:

A reference to the current instance (this).

delegable

public RoleDescriptor delegable()

Make this role delegable.

Returns:

A reference to the current instance (this).

priotity

public RoleDescriptor priotity(int priority)

Assign a priority.

Parameters:

priority -

Returns:

A reference to the current instance (this).

forDirEntry

public RoleDescriptor forDirEntry(BaseDirEntry.Kind kind,
                                  java.lang.String siblingRole,
                                  java.lang.String parentId)

forDirEntry

public RoleDescriptor forDirEntry(BaseDirEntry.Kind kind)