Package cz.metacentrum.perun.core.implApi.modules.attributes

Class ResourceVirtualAttributesModuleAbstract

java.lang.Object

cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleAbstract

cz.metacentrum.perun.core.implApi.modules.attributes.ResourceAttributesModuleAbstract

cz.metacentrum.perun.core.implApi.modules.attributes.ResourceVirtualAttributesModuleAbstract

All Implemented Interfaces:

AttributesModuleImplApi, ResourceAttributesModuleImplApi, ResourceVirtualAttributesModuleImplApi, VirtualAttributesModuleImplApi

Direct Known Subclasses:

urn_perun_resource_attribute_def_virt_assignedGroups, urn_perun_resource_attribute_def_virt_unixGID, urn_perun_resource_attribute_def_virt_unixGroupName, urn_perun_resource_attribute_def_virt_voShortName

public abstract class ResourceVirtualAttributesModuleAbstract
extends ResourceAttributesModuleAbstract
implements ResourceVirtualAttributesModuleImplApi

Abstract class for Resource Virtual Attributes modules. Implements methods for modules to perform default function. In the function that the method in the module does nothing, it is not necessary to implement it, simply extend this abstract class.

Author:

Michal Stava invalid input: '<'stavamichal@gmail.com>

Constructor Summary

Constructors

Constructor	Description
ResourceVirtualAttributesModuleAbstract()

Method Summary

Modifier and Type	Method	Description
Attribute	getAttributeValue(PerunSessionImpl perunSession, Resource resource, AttributeDefinition attribute)	This method will return computed value.
List<String>	getStrongDependencies()	Get list of attributes which this attribute value is computed from.
boolean	removeAttributeValue(PerunSessionImpl perunSession, Resource resource, AttributeDefinition attribute)	Currently do nothing.
List<AuditEvent>	resolveVirtualAttributeValueChange(PerunSessionImpl perunSession, AuditEvent message)	Gets message from auditer and resolves if it is needed to add another messages to DB about virtualAttribute changes.
boolean	setAttributeValue(PerunSessionImpl perunSession, Resource resource, Attribute attribute)	Method sets attributes' values which are dependent on this virtual attribute.

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.ResourceAttributesModuleAbstract

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, fillAttribute

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleAbstract

getAttributeDefinition, getAuthorizedRoles, getDependencies

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleImplApi

getAttributeDefinition, getAuthorizedRoles, getDependencies

Methods inherited from interface cz.metacentrum.perun.core.implApi.modules.attributes.ResourceAttributesModuleImplApi

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, fillAttribute

Constructor Details

ResourceVirtualAttributesModuleAbstract

public ResourceVirtualAttributesModuleAbstract()

Method Details

getAttributeValue

public Attribute getAttributeValue(PerunSessionImpl perunSession,
 Resource resource,
 AttributeDefinition attribute)

Description copied from interface: ResourceVirtualAttributesModuleImplApi

This method will return computed value.

Specified by:

getAttributeValue in interface ResourceVirtualAttributesModuleImplApi

Parameters:

perunSession - PerunSession

resource - resource which is needed for computing the value

attribute - attribute to operate on

Returns:

getStrongDependencies

public List<String> getStrongDependencies()

Description copied from interface: VirtualAttributesModuleImplApi

Get list of attributes which this attribute value is computed from. In other words attributes whose values change can also directly affect value of this attribute.

An attribute should strongly depend on all attributes which values are used in method "getAttributeValue" defined in attribute module for virtual attributes.

Specified by:

getStrongDependencies in interface VirtualAttributesModuleImplApi

Returns:

list of attributes this attribute strongly depends on

See Also:

• AttributesManagerBl.checkAttributeDependencies(PerunSession, RichAttribute)

removeAttributeValue

public boolean removeAttributeValue(PerunSessionImpl perunSession,
 Resource resource,
 AttributeDefinition attribute)
                             throws WrongAttributeValueException,
WrongReferenceAttributeValueException

Description copied from interface: ResourceVirtualAttributesModuleImplApi

Currently do nothing.

Specified by:

removeAttributeValue in interface ResourceVirtualAttributesModuleImplApi

Parameters:

perunSession - PerunSession

resource - resource which is needed for computing the value

attribute - attribute to operate on

Returns:

true if attribute was changed (deleted) or false if attribute was not present in a first place

Throws:

WrongAttributeValueException

WrongReferenceAttributeValueException

resolveVirtualAttributeValueChange

public List<AuditEvent> resolveVirtualAttributeValueChange(PerunSessionImpl perunSession,
 AuditEvent message)

Description copied from interface: AttributesModuleImplApi

Gets message from auditer and resolves if it is needed to add another messages to DB about virtualAttribute changes.

Specified by:

resolveVirtualAttributeValueChange in interface AttributesModuleImplApi

Overrides:

resolveVirtualAttributeValueChange in class AttributesModuleAbstract

Parameters:

perunSession -

message -

Returns:

list of additional messages for auditer to log it

setAttributeValue

public boolean setAttributeValue(PerunSessionImpl perunSession,
 Resource resource,
 Attribute attribute)
                          throws WrongReferenceAttributeValueException

Description copied from interface: ResourceVirtualAttributesModuleImplApi

Method sets attributes' values which are dependent on this virtual attribute.

Specified by:

setAttributeValue in interface ResourceVirtualAttributesModuleImplApi

Parameters:

perunSession - PerunSession

resource - resource which is needed for computing the value

attribute - attribute to operate on

Returns:

true if attribute was really changed

Throws:

WrongReferenceAttributeValueException