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

Interface EntitylessAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Implementing Classes:

EntitylessAttributesModuleAbstract, 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 interface EntitylessAttributesModuleImplApi
extends AttributesModuleImplApi

This interface serves as a template for checking entityless attributes.

Author:

Michal Stava <stavamichal@gmail.com>

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 perunSession, String key, AttributeDefinition attribute)	This method MAY fill an attribute at the specified resource.

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

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Method Details

changedAttributeHook

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

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

Parameters:

session - session

key - the key for entityless attribute

attribute - the attribute

checkAttributeSemantics

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

Checks if value of this entityless attribute has valid semantics.

Parameters:

perunSession - perun session

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

attribute - attribute to check

Throws:

InternalErrorException - if an exception is raised in particular implementation, the exception is wrapped in InternalErrorException

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

WrongAttributeAssignmentException - if attribute does not belong to appropriate entity

checkAttributeSyntax

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

Checks if value of this entityless attribute has valid syntax.

Parameters:

perunSession - perun session

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

attribute - attribute to check

Throws:

InternalErrorException - if an exception is raised in particular implementation, the exception is wrapped in InternalErrorException

WrongAttributeValueException - if the attribute value has wrong/illegal syntax

fillAttribute

Attribute fillAttribute(PerunSessionImpl perunSession,
 String key,
 AttributeDefinition attribute)

This method MAY fill an attribute at the specified resource.

Parameters:

perunSession - perun session

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

attribute - attribute to fill in

Returns: