de.fraunhofer.iese.ind2uce.api.component.description

Class PepInterfaceDescription

java.lang.Object

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

de.fraunhofer.iese.ind2uce.api.component.description.PepInterfaceDescription

All Implemented Interfaces:

Serializable

@Entity
public class PepInterfaceDescription
extends Ind2uceEntity

Describes the capabilities of Policy Enforcement Points in terms of intercepted events and enforceable methods.

Author:

Fraunhofer IESE

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description A description of the method.
protected Long	id The id.

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

GSON_DEFAULT, GSON_PLAIN, GSON_PRETTY, version

Constructor Summary

Constructors

Constructor and Description
PepInterfaceDescription() Default Constructor, at least required by JPA.s
PepInterfaceDescription(ActionId event, boolean isPreventive, String description) Instantiates a new pep interface description.
PepInterfaceDescription(ActionId event, boolean isPreventive, String description, List<InputParameterDescription> eventInputParameters) Instantiates a new pep interface description.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Gets the description.
ActionId	getEvent() Gets the event that is intercepted or monitored.
List<InputParameterDescription>	getEventParameterDescription() Gets the event parameter description.
Long	getId() Gets the id.
int	hashCode()
boolean	isPreventive() Checks if is a flag that indicated whether the event can be modified or blocked.
void	setDescription(String description) Sets the description.
void	setEvent(ActionId event) Sets the event that is intercepted or monitored.
void	setEventParameterDescription(List<InputParameterDescription> eventParameterDescription) Sets the event parameter description.
void	setId(Long id) Sets the id.
void	setPreventive(boolean preventive) Sets the a flag that indicated whether the event can be modified or blocked.

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

id

protected Long id

The id.

description

protected String description

A description of the method.

Constructor Detail

PepInterfaceDescription

public PepInterfaceDescription()

Default Constructor, at least required by JPA.s

PepInterfaceDescription

public PepInterfaceDescription(ActionId event,
                               boolean isPreventive,
                               String description)

Instantiates a new pep interface description.

Parameters:

event - the event that the PEP intercepts or monitors

isPreventive - a flag that indicated whether the event can be modified or blocked

description - the description

PepInterfaceDescription

public PepInterfaceDescription(ActionId event,
                               boolean isPreventive,
                               String description,
                               List<InputParameterDescription> eventInputParameters)

Instantiates a new pep interface description.

Parameters:

event - the event that the PEP intercepts or monitors

isPreventive - a flag that indicated whether the event can be modified or blocked

description - the description

eventInputParameters - the eventInputParameters

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getDescription

public String getDescription()

Gets the description.

Returns:

the description

getEvent

public ActionId getEvent()

Gets the event that is intercepted or monitored.

Returns:

the event that is intercepted or monitored

getEventParameterDescription

public List<InputParameterDescription> getEventParameterDescription()

Gets the event parameter description.

Returns:

the event parameter description

getId

public Long getId()

Gets the id.

Returns:

the id

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isPreventive

public boolean isPreventive()

Checks if is a flag that indicated whether the event can be modified or blocked.

Returns:

the a flag that indicated whether the event can be modified or blocked

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - the new description

setEvent

public void setEvent(ActionId event)

Sets the event that is intercepted or monitored.

Parameters:

event - the new event that is intercepted or monitored

setEventParameterDescription

public void setEventParameterDescription(List<InputParameterDescription> eventParameterDescription)

Sets the event parameter description.

Parameters:

eventParameterDescription - the new event parameter description

setId

public void setId(Long id)

Sets the id.

Parameters:

id - the new id

setPreventive

public void setPreventive(boolean preventive)

Sets the a flag that indicated whether the event can be modified or blocked.

Parameters:

preventive - the new a flag that indicated whether the event can be modified or blocked