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

Class FacilityVirtualAttributesModuleAbstract

java.lang.Object

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

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

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

All Implemented Interfaces:

AttributesModuleImplApi, FacilityAttributesModuleImplApi, FacilityVirtualAttributesModuleImplApi, VirtualAttributesModuleImplApi

Direct Known Subclasses:

urn_perun_facility_attribute_def_virt_GIDRanges, urn_perun_facility_attribute_def_virt_maxUID, urn_perun_facility_attribute_def_virt_minUID, urn_perun_facility_attribute_def_virt_UIDRanges, urn_perun_facility_attribute_def_virt_voShortNames

public abstract class FacilityVirtualAttributesModuleAbstract
extends FacilityAttributesModuleAbstract
implements FacilityVirtualAttributesModuleImplApi

Abstract class for Facility 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 <stavamichal@gmail.com>

Constructor Summary

Constructors

Constructor	Description
FacilityVirtualAttributesModuleAbstract()

Method Summary

Modifier and Type	Method	Description
Attribute	getAttributeValue(PerunSessionImpl perunSession, Facility facility, AttributeDefinition attribute)	This method will return computed value.
List<String>	getStrongDependencies()	Get list of attributes which this attribute value is computed from.
void	removeAttributeValue(PerunSessionImpl perunSession, Facility facility, 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, Facility facility, Attribute attribute)	Method sets attributes' values which are dependent on this virtual attribute.

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

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.FacilityAttributesModuleImplApi

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, fillAttribute

Constructor Details

FacilityVirtualAttributesModuleAbstract

public FacilityVirtualAttributesModuleAbstract()

Method Details

getAttributeValue

public Attribute getAttributeValue(PerunSessionImpl perunSession,
 Facility facility,
 AttributeDefinition attribute)

Description copied from interface: FacilityVirtualAttributesModuleImplApi

This method will return computed value.

Specified by:

getAttributeValue in interface FacilityVirtualAttributesModuleImplApi

Parameters:

perunSession - perun session

facility - facility 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 void removeAttributeValue(PerunSessionImpl perunSession,
 Facility facility,
 AttributeDefinition attribute)

Description copied from interface: FacilityVirtualAttributesModuleImplApi

Currently do nothing.

Specified by:

removeAttributeValue in interface FacilityVirtualAttributesModuleImplApi

facility - facility which is needed for computing the value

attribute - attribute to operate on

resolveVirtualAttributeValueChange

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

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

Returns:

list of additional messages for auditer to log it

Throws:

AttributeNotExistsException

WrongAttributeAssignmentException

setAttributeValue

public boolean setAttributeValue(PerunSessionImpl perunSession,
 Facility facility,
 Attribute attribute)
                          throws WrongReferenceAttributeValueException

Description copied from interface: FacilityVirtualAttributesModuleImplApi

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

Specified by:

setAttributeValue in interface FacilityVirtualAttributesModuleImplApi

facility - facility which is needed for computing the value

attribute - attribute to operate on

Returns:

true if attribute was really changed

Throws:

WrongReferenceAttributeValueException