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

Class EntitylessAttributesModuleAbstract

java.lang.Object

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

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

All Implemented Interfaces:

AttributesModuleImplApi, EntitylessAttributesModuleImplApi

Direct Known Subclasses:

urn_perun_entityless_attribute_def_def_allowedMailDomains_mu, urn_perun_entityless_attribute_def_def_dnsStateMapping, urn_perun_entityless_attribute_def_def_eduPersonORCIDConfig, urn_perun_entityless_attribute_def_def_identityAlertsTemplates, urn_perun_entityless_attribute_def_def_namespace_GIDRanges, urn_perun_entityless_attribute_def_def_namespace_maxUID, urn_perun_entityless_attribute_def_def_namespace_minUID, urn_perun_entityless_attribute_def_def_namespace_uid_policy, urn_perun_entityless_attribute_def_def_namespace_UIDRanges, urn_perun_entityless_attribute_def_def_nonAuthzAccActivationMailTemplate_namespace, urn_perun_entityless_attribute_def_def_nonAuthzPwdResetMailTemplate_namespace, urn_perun_entityless_attribute_def_def_orgAups, urn_perun_entityless_attribute_def_def_usedGids

public abstract class EntitylessAttributesModuleAbstract
extends AttributesModuleAbstract
implements EntitylessAttributesModuleImplApi

Abstract class for Entityless 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
EntitylessAttributesModuleAbstract()

Method Summary

Modifier and Type	Method	Description
void	changedAttributeHook(PerunSessionImpl session, String key, Attribute attribute)	If you need to do some further work with other modules, this method do that
void	checkAttributeSemantics(PerunSessionImpl perunSession, String key, Attribute attribute)	Checks if value of this entityless attribute has valid semantics.
void	checkAttributeSyntax(PerunSessionImpl perunSession, String key, Attribute attribute)	Checks if value of this entityless attribute has valid syntax.
Attribute	fillAttribute(PerunSessionImpl session, String key, AttributeDefinition attribute)	This method MAY fill an attribute at the specified resource.

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

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

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, resolveVirtualAttributeValueChange

Constructor Details

EntitylessAttributesModuleAbstract

public EntitylessAttributesModuleAbstract()

Method Details

changedAttributeHook

public void changedAttributeHook(PerunSessionImpl session,
 String key,
 Attribute attribute)

Description copied from interface: EntitylessAttributesModuleImplApi

If you need to do some further work with other modules, this method do that

Specified by:

changedAttributeHook in interface EntitylessAttributesModuleImplApi

Parameters:

session - session

key - the key for entityless attribute

attribute - the attribute

checkAttributeSemantics

public void checkAttributeSemantics(PerunSessionImpl perunSession,
 String key,
 Attribute attribute)
                             throws WrongAttributeAssignmentException,
WrongReferenceAttributeValueException

Description copied from interface: EntitylessAttributesModuleImplApi

Checks if value of this entityless attribute has valid semantics.

Specified by:

checkAttributeSemantics in interface EntitylessAttributesModuleImplApi

Parameters:

perunSession - perun session

key - string for which you want to check validity of attribute

attribute - attribute to check

Throws:

WrongAttributeAssignmentException - if attribute does not belong to appropriate entity

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

checkAttributeSyntax

public void checkAttributeSyntax(PerunSessionImpl perunSession,
 String key,
 Attribute attribute)
                          throws WrongAttributeValueException

Description copied from interface: EntitylessAttributesModuleImplApi

Checks if value of this entityless attribute has valid syntax.

Specified by:

checkAttributeSyntax in interface EntitylessAttributesModuleImplApi

Parameters:

perunSession - perun session

key - string for which you want to check validity of attribute

attribute - attribute to check

Throws:

WrongAttributeValueException - if the attribute value has wrong/illegal syntax

fillAttribute

public Attribute fillAttribute(PerunSessionImpl session,
 String key,
 AttributeDefinition attribute)

Description copied from interface: EntitylessAttributesModuleImplApi

This method MAY fill an attribute at the specified resource.

Specified by:

fillAttribute in interface EntitylessAttributesModuleImplApi

Parameters:

session - perun session

key - string for which you want to check validity of attribute

attribute - attribute to fill in

Returns: