Package com.foreach.across.modules.spring.security.actions

Class AllowableAction

java.lang.Object

com.foreach.across.modules.spring.security.actions.AllowableAction

All Implemented Interfaces:

Comparable<AllowableAction>

public class AllowableAction
extends Object
implements Comparable<AllowableAction>

An abstraction of a single action that can be performed on an item. Because an action is in essence a simple unique string, the system can easily be extended.

Author:

Arne Vandamme

See Also:

• AllowableActions

Field Summary

Fields

Modifier and Type	Field	Description
static final AllowableAction	ADMINISTER
static final AllowableAction	CREATE
static final AllowableAction	DELETE
static final AllowableAction	READ	Default actions mapped to common ACL permissions.
static final AllowableAction	UPDATE

Constructor Summary

Constructors

Constructor	Description
AllowableAction(@NonNull String id)

Method Summary

Modifier and Type	Method	Description
int	compareTo(AllowableAction other)
boolean	equals(Object o)
static AllowableAction	from(String id)	Convert a String into an AllowableAction instance.
String	getId()
int	hashCode()
static Collection<AllowableAction>	toAllowableActions(String... ids)

Methods inherited from class java.lang.Object

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

Field Details

READ

public static final AllowableAction READ

Default actions mapped to common ACL permissions.

UPDATE

public static final AllowableAction UPDATE

CREATE

public static final AllowableAction CREATE

DELETE

public static final AllowableAction DELETE

ADMINISTER

public static final AllowableAction ADMINISTER

Constructor Details

AllowableAction

public AllowableAction(@NonNull
 @NonNull String id)

Method Details

getId

public String getId()

Returns:

Unique id of the action.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(AllowableAction other)

Specified by:

compareTo in interface Comparable<AllowableAction>

from

public static AllowableAction from(String id)

Convert a String into an AllowableAction instance.

Parameters:

id - of the action

Returns:

instance

toAllowableActions

public static Collection<AllowableAction> toAllowableActions(String... ids)