org.uberfire.security.impl.authz

Class DefaultPermissionCollection

java.lang.Object

org.uberfire.security.impl.authz.DefaultPermissionCollection

All Implemented Interfaces:

PermissionCollection

@Portable
public class DefaultPermissionCollection
extends Object
implements PermissionCollection

A collection where the permissions are ordered by name.

Constructor Summary

Constructors

Constructor and Description
DefaultPermissionCollection()

Method Summary

Modifier and Type	Method and Description
PermissionCollection	add(Permission... permissions) Adds a permission object to the current collection of permission objects.
DefaultPermissionCollection	clone() Creates an exact copy of this instance.
Collection<Permission>	collection() Returns all the Permission objects in the collection.
protected boolean	equalsName(String s1, String s2)
Permission	get(String name) Gets a permission object matching the specified name.
boolean	implies(Permission permission) Checks to see if the specified permission is implied by the collection of Permission objects held in this PermissionCollection.
boolean	impliesName(Permission permission) It returns true provided this collection already contains a permission which implies by name (See Permission.impliesName(Permission)) the permission passed as a parameter.
PermissionCollection	invert(Permission target)
PermissionCollection	merge(PermissionCollection other, int priority) Get all the permissions from this collection and the given one and puts them into a brand new collection instance.
PermissionCollection	remove(Permission... permissions) Removes a permission object from the current collection of permission objects.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPermissionCollection

public DefaultPermissionCollection()

Method Detail

collection

public Collection<Permission> collection()

Description copied from interface: PermissionCollection

Returns all the Permission objects in the collection.

Specified by:

collection in interface PermissionCollection

Returns:

A collection of all the Permissions.

add

public PermissionCollection add(Permission... permissions)

Description copied from interface: PermissionCollection

Adds a permission object to the current collection of permission objects.

Specified by:

add in interface PermissionCollection

Parameters:

permissions - the Permission objects to add.

remove

public PermissionCollection remove(Permission... permissions)

Description copied from interface: PermissionCollection

Removes a permission object from the current collection of permission objects.

Specified by:

remove in interface PermissionCollection

Parameters:

permissions - the Permission objects to remove.

get

public Permission get(String name)

Description copied from interface: PermissionCollection

Gets a permission object matching the specified name.

Specified by:

get in interface PermissionCollection

Parameters:

name - The fully qualified name of the permission.

Returns:

A Permission instance or null if not found.

equalsName

protected boolean equalsName(String s1,
                             String s2)

implies

public boolean implies(Permission permission)

Description copied from interface: PermissionCollection

Checks to see if the specified permission is implied by the collection of Permission objects held in this PermissionCollection.

Specified by:

implies in interface PermissionCollection

Parameters:

permission - the Permission object to compare.

Returns:

true if "permission" is implied by the permissions in the collection, false if not.

impliesName

public boolean impliesName(Permission permission)

Description copied from interface: PermissionCollection

It returns true provided this collection already contains a permission which implies by name (See Permission.impliesName(Permission)) the permission passed as a parameter.

Specified by:

impliesName in interface PermissionCollection

Parameters:

permission - the permission to check

Returns:

true if the permission name is implied by this collection, false otherwise.

merge

public PermissionCollection merge(PermissionCollection other,
                                  int priority)

Description copied from interface: PermissionCollection

Get all the permissions from this collection and the given one and puts them into a brand new collection instance. Any "redundant" permission instance ("implied" by other permissions in the collection) are left out from the outcome. Notice also, the priority parameter is taken into account in case the same permission is present in both collections.

Specified by:

merge in interface PermissionCollection

Parameters:

other - the collection to merge.

priority - integer indicating what to do if the same permission is found in both collections:

• 0 = same priority (GRANTED permissions win by default)
• negative integer = this collection wins
• positive integer = the other collection wins

Returns:

A collection containing the merge result.

clone

public DefaultPermissionCollection clone()

Description copied from interface: PermissionCollection

Creates an exact copy of this instance.

Specified by:

clone in interface PermissionCollection

Overrides:

clone in class Object

Returns:

A brand new Permission instance

invert

public PermissionCollection invert(Permission target)

toString

public String toString()

Overrides:

toString in class Object