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

Interface FacilityAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Subinterfaces:

FacilityVirtualAttributesModuleImplApi

All Known Implementing Classes:

FacilityAttributesModuleAbstract, FacilityVirtualAttributesModuleAbstract, urn_perun_facility_attribute_def_def_accountExpirationTime, urn_perun_facility_attribute_def_def_capabilities, urn_perun_facility_attribute_def_def_fsScratchDirs, urn_perun_facility_attribute_def_def_googleGroupsDomain, urn_perun_facility_attribute_def_def_homeDirUmask, urn_perun_facility_attribute_def_def_homeMountPoints, urn_perun_facility_attribute_def_def_ldapBaseDN, urn_perun_facility_attribute_def_def_login_namespace, urn_perun_facility_attribute_def_def_m365AllowedLicensesPriorities, urn_perun_facility_attribute_def_def_passwdScpDestinationFile, urn_perun_facility_attribute_def_def_pbsServer, urn_perun_facility_attribute_def_def_quotaEnabled, urn_perun_facility_attribute_def_def_reqAups, urn_perun_facility_attribute_def_def_rpEnvironment, urn_perun_facility_attribute_def_def_rpProtocol, urn_perun_facility_attribute_def_def_rtOutputFileName, urn_perun_facility_attribute_def_def_scratchDirPermissions, urn_perun_facility_attribute_def_def_scratchLocalDirPermissions, urn_perun_facility_attribute_def_def_shell_passwd_scp, urn_perun_facility_attribute_def_def_shells, urn_perun_facility_attribute_def_def_uid_namespace, urn_perun_facility_attribute_def_def_unixGID_namespace, urn_perun_facility_attribute_def_def_unixGroupName_namespace, 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 interface FacilityAttributesModuleImplApi
extends AttributesModuleImplApi

This interface serves as a template for checking facilities attributes.

Author:

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

Method Summary

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

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

Parameters:

session - session

facility - the facility

attribute - the attribute

checkAttributeSemantics

void checkAttributeSemantics(PerunSessionImpl perunSession,
 Facility facility,
 Attribute attribute)
                      throws WrongReferenceAttributeValueException,
WrongAttributeAssignmentException

Checks if value of this facility attribute has valid semantics.

Parameters:

perunSession - perun session

facility - facility 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

checkAttributeSyntax

void checkAttributeSyntax(PerunSessionImpl perunSession,
 Facility facility,
 Attribute attribute)
                   throws WrongAttributeValueException

Checks if value of this facility attribute has valid syntax.

Parameters:

perunSession - perun session

facility - 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,
 Facility facility,
 AttributeDefinition attribute)

This method MAY fill an attribute at the specified resource.

Parameters:

perunSession - perun session

facility - facility for which you want to check validity of attribute

attribute - attribute to fill in

Returns: