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

Interface UserFacilityVirtualAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi, UserFacilityAttributesModuleImplApi, VirtualAttributesModuleImplApi

All Known Implementing Classes:

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, UserFacilityVirtualAttributesModuleAbstract

public interface UserFacilityVirtualAttributesModuleImplApi
extends UserFacilityAttributesModuleImplApi, VirtualAttributesModuleImplApi

This interface serves as a template for virtual attributes.

Author:

Michal Prochazka invalid input: '<'michalp@ics.muni.cz>

Method Summary

Modifier and Type	Method	Description
Attribute	getAttributeValue(PerunSessionImpl perunSession, User user, Facility facility, AttributeDefinition attribute)	This method will return computed value.
boolean	removeAttributeValue(PerunSessionImpl perunSession, User user, Facility facility, AttributeDefinition attribute)	Currently do nothing.
boolean	setAttributeValue(PerunSessionImpl perunSession, User user, Facility facility, Attribute attribute)	Method sets attributes' values which are dependent on this virtual attribute.

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

getAttributeDefinition, getAuthorizedRoles, getDependencies, resolveVirtualAttributeValueChange

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

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, fillAttribute

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

getStrongDependencies

Method Details

getAttributeValue

Attribute getAttributeValue(PerunSessionImpl perunSession,
 User user,
 Facility facility,
 AttributeDefinition attribute)

This method will return computed value.

Parameters:

perunSession - perun session

user - user which is needed for computing the value

facility - facility which is needed for computing the value

attribute - attribute to operate on

Returns:

Throws:

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

removeAttributeValue

boolean removeAttributeValue(PerunSessionImpl perunSession,
 User user,
 Facility facility,
 AttributeDefinition attribute)

Currently do nothing.

Parameters:

perunSession -

user - user which is needed for computing the value

facility - facility which is needed for computing the value

attribute - attribute to operate on

Returns:

true if attribute was changed (deleted) or false if attribute was not present in a first place

setAttributeValue

boolean setAttributeValue(PerunSessionImpl perunSession,
 User user,
 Facility facility,
 Attribute attribute)
                   throws WrongReferenceAttributeValueException

Method sets attributes' values which are dependent on this virtual attribute.

Parameters:

perunSession -

user - user which is needed for computing the value

facility - facility which is needed for computing the value

attribute - attribute to operate on

Returns:

true if attribute was really changed

Throws:

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

WrongReferenceAttributeValueException