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

Interface ResourceAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Subinterfaces:

ResourceVirtualAttributesModuleImplApi

All Known Implementing Classes:

ResourceAttributesModuleAbstract, ResourceVirtualAttributesModuleAbstract, urn_perun_resource_attribute_def_def_accountExpirationTime, urn_perun_resource_attribute_def_def_apacheAuthzFile, urn_perun_resource_attribute_def_def_capabilities, urn_perun_resource_attribute_def_def_defaultDataQuotas, urn_perun_resource_attribute_def_def_defaultFileQuotas, urn_perun_resource_attribute_def_def_defaultHomeMountPoint, urn_perun_resource_attribute_def_def_defaultShell, urn_perun_resource_attribute_def_def_fairshareGroupName, urn_perun_resource_attribute_def_def_homeMountPoints, urn_perun_resource_attribute_def_def_k4GroupCode, urn_perun_resource_attribute_def_def_k4GroupName, urn_perun_resource_attribute_def_def_k4GroupPriority, urn_perun_resource_attribute_def_def_k5loginTargetUser, urn_perun_resource_attribute_def_def_kerberosPrincipalsFileSuffix, urn_perun_resource_attribute_def_def_m365LicenseGroup, urn_perun_resource_attribute_def_def_mailaliasesTargetUser, urn_perun_resource_attribute_def_def_mailingListManagerEmail, urn_perun_resource_attribute_def_def_maxUserDataQuotas, urn_perun_resource_attribute_def_def_maxUserFileQuotas, urn_perun_resource_attribute_def_def_projectsBasePath, urn_perun_resource_attribute_def_def_replicaDestination, urn_perun_resource_attribute_def_def_replicaDestinationPath, urn_perun_resource_attribute_def_def_rootMailAliases, urn_perun_resource_attribute_def_def_shells, urn_perun_resource_attribute_def_def_sshkeysTargetUser, urn_perun_resource_attribute_def_def_unixGID_namespace, urn_perun_resource_attribute_def_def_unixGroupName_namespace, urn_perun_resource_attribute_def_def_userSettingsDescription, urn_perun_resource_attribute_def_def_userSettingsName, urn_perun_resource_attribute_def_def_vomsRoles, 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 interface ResourceAttributesModuleImplApi
extends AttributesModuleImplApi

This interface serves as a template for checking and filling in resource's attributes.

Author:

Lukáš Pravda <luky.pravda@gmail.com>

Method Summary

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

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

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Method Details

changedAttributeHook

void changedAttributeHook(PerunSessionImpl session,
 Resource resource,
 Attribute attribute)
                   throws WrongReferenceAttributeValueException

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

Parameters:

session - session

resource - resource

attribute - the attribute

Throws:

WrongReferenceAttributeValueException

checkAttributeSemantics

void checkAttributeSemantics(PerunSessionImpl perunSession,
 Resource resource,
 Attribute attribute)
                      throws WrongReferenceAttributeValueException,
WrongAttributeAssignmentException

Checks if value of this resource attribute has valid semantics.

Parameters:

perunSession - perun session

resource - resource 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 an referenced attribute against the parameter one is to be compared is not available

WrongAttributeAssignmentException

checkAttributeSyntax

void checkAttributeSyntax(PerunSessionImpl perunSession,
 Resource resource,
 Attribute attribute)
                   throws WrongAttributeValueException

Checks if value of this resource attribute has valid syntax.

Parameters:

perunSession - perun session

resource - resource 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,
 Resource resource,
 AttributeDefinition attribute)
                 throws WrongAttributeAssignmentException

This method tries to fill a value of the resource attribute. Value may be copied from some facility attribute.

Parameters:

perunSession - perun session

resource - resource, attribute of which you want to fill

attribute - attribute to fill. If attributes already have set value, this value won't be overwriten. This means the attribute value must be empty otherwise this method won't fill it.

Returns:

attribute which MAY have filled value

Throws:

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

WrongAttributeAssignmentException