de.fraunhofer.iese.ind2uce.api.policy

Class AuthorizationDecision

java.lang.Object

de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

de.fraunhofer.iese.ind2uce.api.policy.AuthorizationDecision

All Implemented Interfaces:

Serializable

public class AuthorizationDecision
extends Ind2uceEntity

Information about the permissiveness of the event. The decision may include instructions for modification or delaying the event.Decisions are provided by the PDP and enforced by a PEP.

Author:

Fraunhofer IESE

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AuthorizationDecision	DECISION_ALLOW The default decision for a plain allow.
static AuthorizationDecision	DECISION_INHIBIT The default decision for a plain inhibit.

Fields inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
AuthorizationDecision() Instantiates a new authorization decision.
AuthorizationDecision(AuthorizationDecision prototype) Constructor that takes the id and eventAllowed from Prototype.
AuthorizationDecision(DecisionId id, boolean eventAllowed, long delay, List<String> authorizationActionNames, Modifier... modifiers) Instantiates a new authorization decision.
AuthorizationDecision(DecisionId id, boolean eventAllowed, long delay, List<String> authorizationActionNames, ModifierList modifiers) Instantiates a new authorization decision.

Method Summary

Modifier and Type	Method and Description
void	addModifier(Modifier param) Adds the modifier.
void	clearParameters() Clear modifiers.
boolean	equals(Object o)
List<String>	getAuthorizationActionNames() Gets the name(s) of the corresponding AutorizationAction(s) that led to the decision.
static AuthorizationDecision	getDecisionAllow() Get a clone of DECISION_ALLOW.
static AuthorizationDecision	getDecisionInhibit() Get a clone of DECISION_INHIBIT.
long	getDelay() Returns how much the event should be delayed.
DecisionId	getId() Gets the id.
Modifier	getModifierForName(String name) Gets the modifier for name.
ModifierList	getModifiers() Gets the modifiers.
int	hashCode()
boolean	isEventAllowed() Indicates whether an event should be allowed or blocked.
void	removeParameter(String name) Removes the modifier.
void	setAuthorizationActionNames(List<String> authorizationActionNames) Sets the authorization action names.
void	setDelay(long delay) Sets how much the event should be delayed.
void	setEventAllowed(boolean eventAllowed) Sets whether an event should be allowed or blocked.
void	setId(DecisionId id) Sets the id.
void	setModifiers(ModifierList modifiers) Sets modifiers for the event.

Methods inherited from class de.fraunhofer.iese.ind2uce.api.common.Ind2uceEntity

fromJson, getGson, getVersion, toJson, toString

Methods inherited from class java.lang.Object

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

Field Detail

DECISION_ALLOW

public static final AuthorizationDecision DECISION_ALLOW

The default decision for a plain allow.

DECISION_INHIBIT

public static final AuthorizationDecision DECISION_INHIBIT

The default decision for a plain inhibit.

Constructor Detail

AuthorizationDecision

public AuthorizationDecision()

Instantiates a new authorization decision.

AuthorizationDecision

public AuthorizationDecision(AuthorizationDecision prototype)

Constructor that takes the id and eventAllowed from Prototype.

Parameters:

prototype - Prototype to create a new instance.

AuthorizationDecision

public AuthorizationDecision(DecisionId id,
                             boolean eventAllowed,
                             long delay,
                             List<String> authorizationActionNames,
                             Modifier... modifiers)

Instantiates a new authorization decision.

Parameters:

id - the id

eventAllowed - the event allowed

delay - the delay unit

authorizationActionNames - the authorization action names

modifiers - the modifiers

AuthorizationDecision

public AuthorizationDecision(DecisionId id,
                             boolean eventAllowed,
                             long delay,
                             List<String> authorizationActionNames,
                             ModifierList modifiers)

Instantiates a new authorization decision.

Parameters:

id - the id

eventAllowed - the event allowed

delay - the delay unit

authorizationActionNames - the authorization action names

modifiers - the modifiers

Method Detail

getDecisionAllow

public static final AuthorizationDecision getDecisionAllow()

Get a clone of DECISION_ALLOW.

Returns:

a clone of DECISION_ALLOW.

getDecisionInhibit

public static final AuthorizationDecision getDecisionInhibit()

Get a clone of DECISION_INHIBIT.

Returns:

DECISION_INHIBIT

addModifier

public void addModifier(Modifier param)

Adds the modifier.

Parameters:

param - the param

clearParameters

public void clearParameters()

Clear modifiers.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAuthorizationActionNames

public List<String> getAuthorizationActionNames()

Gets the name(s) of the corresponding AutorizationAction(s) that led to the decision.

Returns:

the name(s) of the corresponding AutorizationAction(s) that led to the decision

getDelay

public long getDelay()

Returns how much the event should be delayed.

Returns:

the delay in microseconds

getId

public DecisionId getId()

Gets the id.

Returns:

the id

getModifierForName

public Modifier getModifierForName(String name)

Gets the modifier for name.

Parameters:

name - the name

Returns:

the modifier for name

getModifiers

public ModifierList getModifiers()

Gets the modifiers. Parameters in this list can be of type Modifier .

Returns:

modifiers the list of modifications that need to be enforced for an event.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEventAllowed

public boolean isEventAllowed()

Indicates whether an event should be allowed or blocked.

Returns:

true, if the event should be allowed, false otherwise

removeParameter

public void removeParameter(String name)

Removes the modifier.

Parameters:

name - the name

setAuthorizationActionNames

public void setAuthorizationActionNames(List<String> authorizationActionNames)

Sets the authorization action names.

Parameters:

authorizationActionNames - the names of the authorizationActions that led to the decision.

setDelay

public void setDelay(long delay)

Sets how much the event should be delayed.

Parameters:

delay - the delay in microseconds

setEventAllowed

public void setEventAllowed(boolean eventAllowed)

Sets whether an event should be allowed or blocked.

Parameters:

eventAllowed - true, if the event should be allowed, false otherwise

setId

public void setId(DecisionId id)

Sets the id.

Parameters:

id - the new id

setModifiers

public void setModifiers(ModifierList modifiers)

Sets modifiers for the event. Note that modifiers are possible if the event is allowed.

Parameters:

modifiers - the new modifiers