de.fraunhofer.iese.ind2uce.api.policy

Class Event

java.lang.Object

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

de.fraunhofer.iese.ind2uce.api.policy.Event

All Implemented Interfaces:

ParameterListProvider, Serializable

public class Event
extends Ind2uceEntity
implements ParameterListProvider

An event that occured in the system under observation, intercepted or monitored by a PolicyEnforcementPoint.

Author:

Fraunhofer IESE

See Also:

Serialized Form

Field Summary

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

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
Event(ActionId actionId, boolean isTry, long time, Parameter<?>... params) Instantiates a new event.
Event(ActionId actionId, boolean isTry, long time, ParameterList params) Instantiates a new event.
Event(ActionId actionId, boolean isTry, Parameter<?>... params) Instantiates a new event.
Event(ActionId actionId, Parameter<?>... params) Instantiates a new event.

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter<?> param) Adds a parameter.
<T> void	addParameter(String name, T value) Adds a parameter.
void	clearParameters() Clear parameters.
ActionId	getActionId() Gets the id of the system action that occurred.
String	getActionIdString() Gets the action id string.
Parameter<?>	getParameterForName(String name) Gets a parameter.
ParameterList	getParameters() Gets the list of all parameters.
<T> T	getParameterValue(String name, Class<T> clazz) Gets a parameter value.
Object	getTag() *.
long	getTimestamp() Gets the time at which the action occurred / was intercepted by the PEP.
Object	getValueForName(String name) Gets the object which is added as parameter for given name.
void	removeParameter(String name) Adds a parameter.
void	setActionId(ActionId actionId) Sets the id of the system action that occurred.
void	setActionId(String actionId) Sets the id of the system action that occurred.
void	setParameters(ParameterList params) Replaces all parameters with the parameters of the provided list.
void	setTag(Object tag) *.
void	setTimestamp(long timestamp) Sets the time at which the action occurred / was intercepted by the PEP.

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

fromJson, getGson, getVersion, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(ActionId actionId,
             boolean isTry,
             long time,
             Parameter<?>... params)

Instantiates a new event.

Parameters:

actionId - the action id

isTry - the is try

time - the time

params - the params

Event

public Event(ActionId actionId,
             boolean isTry,
             long time,
             ParameterList params)

Instantiates a new event.

Parameters:

actionId - the action id

isTry - the is try

time - the time

params - the params

Event

public Event(ActionId actionId,
             boolean isTry,
             Parameter<?>... params)

Instantiates a new event.

Parameters:

actionId - the action id

isTry - the is try

params - the params

Event

public Event(ActionId actionId,
             Parameter<?>... params)

Instantiates a new event.

Parameters:

actionId - the action id

params - the params

Method Detail

addParameter

public void addParameter(Parameter<?> param)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

addParameter in interface ParameterListProvider

Parameters:

param - the parameter to add

addParameter

public <T> void addParameter(String name,
                             T value)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

addParameter in interface ParameterListProvider

Type Parameters:

T - the generic type

Parameters:

name - the name of the parameter

value - the value of the parameter

clearParameters

public void clearParameters()

Clear parameters.

Specified by:

clearParameters in interface ParameterListProvider

getActionId

public ActionId getActionId()

Gets the id of the system action that occurred.

Returns:

the ID of the event

getActionIdString

public String getActionIdString()

Gets the action id string.

Returns:

the action id string

getParameterForName

public Parameter<?> getParameterForName(String name)

Description copied from interface: ParameterListProvider

Gets a parameter.

Specified by:

getParameterForName in interface ParameterListProvider

Parameters:

name - the name of the parameter

Returns:

the parameter with the given name, or null if it does not exist

getParameters

public ParameterList getParameters()

Description copied from interface: ParameterListProvider

Gets the list of all parameters.

Specified by:

getParameters in interface ParameterListProvider

Returns:

the list of all parameters

getParameterValue

public <T> T getParameterValue(String name,
                               Class<T> clazz)

Description copied from interface: ParameterListProvider

Gets a parameter value.

Specified by:

getParameterValue in interface ParameterListProvider

Type Parameters:

T - the generic type

Parameters:

name - the name of the parameter

clazz - the value of the parameter

Returns:

the value of the parameter, or null if it does not exist

getTag

public Object getTag()

*.

Returns:

the * Will be used by solution developer to identify event uniquely

getTimestamp

public long getTimestamp()

Gets the time at which the action occurred / was intercepted by the PEP.

Returns:

the timestamp

getValueForName

public Object getValueForName(String name)

Gets the object which is added as parameter for given name.

Parameters:

name - the name

Returns:

the object

removeParameter

public void removeParameter(String name)

Description copied from interface: ParameterListProvider

Adds a parameter.

Specified by:

removeParameter in interface ParameterListProvider

Parameters:

name - the name of the parameter to be deleted

setActionId

public void setActionId(ActionId actionId)

Sets the id of the system action that occurred.

Parameters:

actionId - the new id of the system action that occurred

setActionId

public void setActionId(String actionId)

Sets the id of the system action that occurred.

Parameters:

actionId - the new id of the system action that occurred

setParameters

public void setParameters(ParameterList params)

Description copied from interface: ParameterListProvider

Replaces all parameters with the parameters of the provided list.

Specified by:

setParameters in interface ParameterListProvider

Parameters:

params - list of parameters

setTag

public void setTag(Object tag)

*.

Parameters:

tag - the new * Will be used by solution developer to identify event uniquely

setTimestamp

public void setTimestamp(long timestamp)

Sets the time at which the action occurred / was intercepted by the PEP.

Parameters:

timestamp - the timestamp to set