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

Interface UserFacilityAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Subinterfaces:

UserFacilityVirtualAttributesModuleImplApi

All Known Implementing Classes:

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, urn_perun_user_facility_attribute_def_virt_blacklisted, urn_perun_user_facility_attribute_def_virt_dataQuotas, urn_perun_user_facility_attribute_def_virt_defaultUnixGID, urn_perun_user_facility_attribute_def_virt_enabledO365MailForward, urn_perun_user_facility_attribute_def_virt_fileQuotas, urn_perun_user_facility_attribute_def_virt_groupStatus, urn_perun_user_facility_attribute_def_virt_isBanned, urn_perun_user_facility_attribute_def_virt_login, urn_perun_user_facility_attribute_def_virt_preferredUnixGroupName, urn_perun_user_facility_attribute_def_virt_shell, urn_perun_user_facility_attribute_def_virt_UID, UserFacilityAttributesModuleAbstract, UserFacilityVirtualAttributesModuleAbstract

public interface UserFacilityAttributesModuleImplApi
extends AttributesModuleImplApi

Author:

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

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 session, 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 session, 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 interface cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleImplApi

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

Method Details

changedAttributeHook

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

Parameters:

session - session

user - the user

facility - the facility

attribute - the attribute

checkAttributeSemantics

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

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

Parameters:

session - Perun session

user - User of the facility.

facility - Facility to be used by a user.

attribute - Attribute in relationship between facility and user.

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 session,
 User user,
 Facility facility,
 Attribute attribute)
                   throws WrongAttributeValueException

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

Parameters:

session - Perun session

user - User of the facility.

facility - Facility to be used by a user.

attribute - Attribute in relationship between facility and user.

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 session,
 User user,
 Facility facility,
 AttributeDefinition attribute)
                 throws WrongAttributeAssignmentException

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

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:

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

WrongAttributeAssignmentException