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

Interface GroupAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Subinterfaces:

GroupVirtualAttributesModuleImplApi

All Known Implementing Classes:

GroupVirtualAttributesModuleAbstract, urn_perun_group_attribute_def_def_adGroupName, urn_perun_group_attribute_def_def_adName_o365mu, urn_perun_group_attribute_def_def_applicationAffiliationRegex, urn_perun_group_attribute_def_def_applicationAutoRejectMessages, urn_perun_group_attribute_def_def_applicationExpirationRules, urn_perun_group_attribute_def_def_applicationViewPreferences, urn_perun_group_attribute_def_def_authoritativeGroup, urn_perun_group_attribute_def_def_autoApproveByGroupMembership, urn_perun_group_attribute_def_def_collectionID, urn_perun_group_attribute_def_def_flatGroupStructureEnabled, urn_perun_group_attribute_def_def_fromEmail, urn_perun_group_attribute_def_def_googleGroupName_namespace, urn_perun_group_attribute_def_def_groupExtSource, urn_perun_group_attribute_def_def_groupMembershipExpirationRules, urn_perun_group_attribute_def_def_groupStructureResources, urn_perun_group_attribute_def_def_groupStructureSynchronizationEnabled, urn_perun_group_attribute_def_def_groupStructureSynchronizationInterval, urn_perun_group_attribute_def_def_groupStructureSynchronizationTimes, urn_perun_group_attribute_def_def_groupSynchronizationFilename, urn_perun_group_attribute_def_def_groupSynchronizationInterval, urn_perun_group_attribute_def_def_groupSynchronizationTimes, urn_perun_group_attribute_def_def_htmlMailFooter, urn_perun_group_attribute_def_def_lastSynchronizationState, urn_perun_group_attribute_def_def_lastSynchronizationTimestamp, urn_perun_group_attribute_def_def_o365EmailAddresses_o365mu, urn_perun_group_attribute_def_def_o365SendAsGroups, urn_perun_group_attribute_def_def_o365SendOnBehalfGroups, urn_perun_group_attribute_def_def_synchronizationEnabled, urn_perun_group_attribute_def_def_uniqueID, urn_perun_group_attribute_def_def_unixGID_namespace, urn_perun_group_attribute_def_def_unixGroupName_namespace, urn_perun_group_attribute_def_virt_adDisplayName_o365mu, urn_perun_group_attribute_def_virt_adGroupName, urn_perun_group_attribute_def_virt_autoRegistrationEnabled, urn_perun_group_attribute_def_virt_denbiProjectMembers, urn_perun_group_attribute_def_virt_voShortName

public interface GroupAttributesModuleImplApi
extends AttributesModuleImplApi

This interface serves as a template for checking facilities attributes.

Author:

Milan Halenar <mhalenar@gmail.com>

Method Summary

Modifier and Type	Method	Description
void	changedAttributeHook(PerunSessionImpl session, Group group, Attribute attribute)	If you need to do some further work with other modules, this method do that
void	checkAttributeSemantics(PerunSessionImpl perunSession, Group group, Attribute attribute)	Checks if value of this group attribute has valid semantics.
void	checkAttributeSyntax(PerunSessionImpl perunSession, Group group, Attribute attribute)	Checks if value of this group attribute has valid syntax.
Attribute	fillAttribute(PerunSessionImpl perunSession, Group group, 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,
 Group group,
 Attribute attribute)
                   throws WrongReferenceAttributeValueException

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

Parameters:

session - session

group - the group

attribute - the attribute

Throws:

WrongReferenceAttributeValueException

checkAttributeSemantics

void checkAttributeSemantics(PerunSessionImpl perunSession,
 Group group,
 Attribute attribute)
                      throws WrongAttributeAssignmentException,
WrongReferenceAttributeValueException

Checks if value of this group attribute has valid semantics.

Parameters:

perunSession - perun session

group - group

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,
 Group group,
 Attribute attribute)
                   throws WrongAttributeValueException

Checks if value of this group attribute has valid syntax.

Parameters:

perunSession - perun session

group - 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,
 Group group,
 AttributeDefinition attribute)
                 throws WrongAttributeAssignmentException

This method MAY fill an attribute at the specified resource.

Parameters:

perunSession - perun session

group - group

attribute - attribute to fill in

Returns:

Throws:

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

WrongAttributeAssignmentException