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

Class FacilityAttributesModuleAbstract

java.lang.Object

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

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

All Implemented Interfaces:

AttributesModuleImplApi, FacilityAttributesModuleImplApi

Direct Known Subclasses:

FacilityVirtualAttributesModuleAbstract, urn_perun_facility_attribute_def_def_accountExpirationTime, urn_perun_facility_attribute_def_def_capabilities, 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

public abstract class FacilityAttributesModuleAbstract
extends AttributesModuleAbstract
implements FacilityAttributesModuleImplApi

Abstract class for Facility 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
FacilityAttributesModuleAbstract()

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 session, Facility facility, 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

FacilityAttributesModuleAbstract

public FacilityAttributesModuleAbstract()

Method Details

changedAttributeHook

public void changedAttributeHook(PerunSessionImpl session,
 Facility facility,
 Attribute attribute)

Description copied from interface: FacilityAttributesModuleImplApi

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

Specified by:

changedAttributeHook in interface FacilityAttributesModuleImplApi

Parameters:

session - session

facility - the facility

attribute - the attribute

checkAttributeSemantics

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

Description copied from interface: FacilityAttributesModuleImplApi

Checks if value of this facility attribute has valid semantics.

Specified by:

checkAttributeSemantics in interface FacilityAttributesModuleImplApi

Parameters:

perunSession - perun session

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

attribute - attribute to check

Throws:

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

WrongAttributeAssignmentException

checkAttributeSyntax

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

Description copied from interface: FacilityAttributesModuleImplApi

Checks if value of this facility attribute has valid syntax.

Specified by:

checkAttributeSyntax in interface FacilityAttributesModuleImplApi

Parameters:

perunSession - perun session

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

Description copied from interface: FacilityAttributesModuleImplApi

This method MAY fill an attribute at the specified resource.

Specified by:

fillAttribute in interface FacilityAttributesModuleImplApi

Parameters:

session - perun session

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

attribute - attribute to fill in

Returns: