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

Class UserFacilityAttributesModuleAbstract

java.lang.Object

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

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

All Implemented Interfaces:

AttributesModuleImplApi, UserFacilityAttributesModuleImplApi

Direct Known Subclasses:

urn_perun_user_facility_attribute_def_def_accountExpirationTime, urn_perun_user_facility_attribute_def_def_basicDefaultGID, urn_perun_user_facility_attribute_def_def_defaultUnixGID, urn_perun_user_facility_attribute_def_def_homeMountPoint, urn_perun_user_facility_attribute_def_def_o365AccountExtension, urn_perun_user_facility_attribute_def_def_shell, urn_perun_user_facility_attribute_def_def_shell_passwd_scp, UserFacilityVirtualAttributesModuleAbstract

public abstract class UserFacilityAttributesModuleAbstract
extends AttributesModuleAbstract
implements UserFacilityAttributesModuleImplApi

Abstract class for Facility User 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 invalid input: '<'stavamichal@gmail.com>

Constructor Summary

Constructors

Constructor	Description
UserFacilityAttributesModuleAbstract()

Method Summary

Modifier and Type	Method	Description
void	changedAttributeHook(PerunSessionImpl session, User user, Facility facility, Attribute attribute)	If you need to do some further work with other modules, this method do that
void	checkAttributeSemantics(PerunSessionImpl perunSession, User user, Facility facility, Attribute attribute)	Checks if value of assigned attribute in relationship between those two entities has a correct semantics.
void	checkAttributeSyntax(PerunSessionImpl perunSession, User user, Facility facility, Attribute attribute)	Checks if value of assigned attribute in relationship between those two entities has a correct syntax.
Attribute	fillAttribute(PerunSessionImpl session, User user, Facility facility, AttributeDefinition attribute)	Tries to fill an attribute in the relationship between a facility and user

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

UserFacilityAttributesModuleAbstract

public UserFacilityAttributesModuleAbstract()

Method Details

changedAttributeHook

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

Description copied from interface: UserFacilityAttributesModuleImplApi

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

Specified by:

changedAttributeHook in interface UserFacilityAttributesModuleImplApi

Parameters:

session - session

user - the user

facility - the facility

attribute - the attribute

checkAttributeSemantics

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

Description copied from interface: UserFacilityAttributesModuleImplApi

Checks if value of assigned attribute in relationship between those two entities has a correct semantics.

Specified by:

checkAttributeSemantics in interface UserFacilityAttributesModuleImplApi

Parameters:

perunSession - Perun session

user - User of the facility.

facility - Facility to be used by a user.

attribute - Attribute in relationship between facility and user.

Throws:

WrongReferenceAttributeValueException - if the attribute value has wrong/illegal semantics

WrongAttributeAssignmentException

checkAttributeSyntax

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

Description copied from interface: UserFacilityAttributesModuleImplApi

Checks if value of assigned attribute in relationship between those two entities has a correct syntax.

Specified by:

checkAttributeSyntax in interface UserFacilityAttributesModuleImplApi

Parameters:

perunSession - Perun session

user - User of the facility.

facility - Facility to be used by a user.

attribute - Attribute in relationship between facility and user.

Throws:

WrongAttributeValueException - if the attribute value has wrong/illegal syntax

fillAttribute

public Attribute fillAttribute(PerunSessionImpl session,
 User user,
 Facility facility,
 AttributeDefinition attribute)
                        throws WrongAttributeAssignmentException

Description copied from interface: UserFacilityAttributesModuleImplApi

Tries to fill an attribute in the relationship between a facility and user

Specified by:

fillAttribute in interface UserFacilityAttributesModuleImplApi

Parameters:

session - Perun Session

user - User of the facility

facility - Facility to be used by user.

attribute - Attribute in relationship between facility and user to be filled in.

Returns:

Attribute which MAY be filled in

Throws:

WrongAttributeAssignmentException