Class UserAttributesModuleAbstract
java.lang.Object
cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleAbstract
cz.metacentrum.perun.core.implApi.modules.attributes.UserAttributesModuleAbstract
- All Implemented Interfaces:
AttributesModuleImplApi
,UserAttributesModuleImplApi
- Direct Known Subclasses:
urn_perun_user_attribute_def_def_cnCeitecAD
,urn_perun_user_attribute_def_def_cscaleCountry
,urn_perun_user_attribute_def_def_cscaleResearchField
,urn_perun_user_attribute_def_def_cscaleUserCategory
,urn_perun_user_attribute_def_def_cscaleUserFunction
,urn_perun_user_attribute_def_def_eduroamIdentities
,urn_perun_user_attribute_def_def_elixirBonaFideStatus
,urn_perun_user_attribute_def_def_elixirScopedAffiliation
,urn_perun_user_attribute_def_def_expirationDc2
,urn_perun_user_attribute_def_def_expirationKos
,urn_perun_user_attribute_def_def_expirationManual
,urn_perun_user_attribute_def_def_IPAddresses
,urn_perun_user_attribute_def_def_isCesnetEligibleLastSeen
,urn_perun_user_attribute_def_def_k4Nav
,urn_perun_user_attribute_def_def_k4Staleakt
,urn_perun_user_attribute_def_def_kerberosAdminPrincipal
,urn_perun_user_attribute_def_def_kerberosLogins
,urn_perun_user_attribute_def_def_login_namespace
,urn_perun_user_attribute_def_def_mailaliasesGenericMail
,urn_perun_user_attribute_def_def_mfaEnforceSettings
,urn_perun_user_attribute_def_def_o365SystemEmailAddresses_mu
,urn_perun_user_attribute_def_def_o365UserEmailAddresses_mu
,urn_perun_user_attribute_def_def_osbIddc2
,urn_perun_user_attribute_def_def_phone
,urn_perun_user_attribute_def_def_preferredMail
,urn_perun_user_attribute_def_def_preferredShells
,urn_perun_user_attribute_def_def_preferredUnixGroupName_namespace
,urn_perun_user_attribute_def_def_rootMailAliasesMail
,urn_perun_user_attribute_def_def_sshPublicKey
,urn_perun_user_attribute_def_def_timezone
,urn_perun_user_attribute_def_def_titleBeforeDc2
,urn_perun_user_attribute_def_def_titleBeforeKos
,urn_perun_user_attribute_def_def_ucoVsup
,urn_perun_user_attribute_def_def_uid_namespace
,urn_perun_user_attribute_def_def_userCertDNs
,urn_perun_user_attribute_def_def_userCertificates
,urn_perun_user_attribute_def_def_userPreferredCertDN
,urn_perun_user_attribute_def_def_vsupExchangeMail
,urn_perun_user_attribute_def_def_vsupExchangeMailAliases
,urn_perun_user_attribute_def_def_vsupMail
,urn_perun_user_attribute_def_def_vsupPreferredMail
,UserVirtualAttributesModuleAbstract
public abstract class UserAttributesModuleAbstract
extends AttributesModuleAbstract
implements UserAttributesModuleImplApi
Abstract class for 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
changedAttributeHook
(PerunSessionImpl session, User user, Attribute attribute) If you need to do some further work with other modules, this method do thatvoid
checkAttributeSemantics
(PerunSessionImpl perunSession, User user, Attribute attribute) Checks if value of assigned attribute to the user has valid semantics.void
checkAttributeSyntax
(PerunSessionImpl perunSession, User user, Attribute attribute) Checks if assigned attribute value to the user has valid syntax.fillAttribute
(PerunSessionImpl session, User user, AttributeDefinition attribute) Tries to fill an attribute to the specified user.getAnonymizedValue
(PerunSessionImpl session, User user, Attribute attribute) Gets anonymized value of the attribute.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
-
UserAttributesModuleAbstract
public UserAttributesModuleAbstract()
-
-
Method Details
-
changedAttributeHook
public void changedAttributeHook(PerunSessionImpl session, User user, Attribute attribute) throws WrongReferenceAttributeValueException Description copied from interface:UserAttributesModuleImplApi
If you need to do some further work with other modules, this method do that- Specified by:
changedAttributeHook
in interfaceUserAttributesModuleImplApi
- Parameters:
session
- sessionuser
- the userattribute
- the attribute- Throws:
WrongReferenceAttributeValueException
-
checkAttributeSemantics
public void checkAttributeSemantics(PerunSessionImpl perunSession, User user, Attribute attribute) throws WrongReferenceAttributeValueException, WrongAttributeAssignmentException Description copied from interface:UserAttributesModuleImplApi
Checks if value of assigned attribute to the user has valid semantics.- Specified by:
checkAttributeSemantics
in interfaceUserAttributesModuleImplApi
- Parameters:
perunSession
- PerunSessionuser
- Userattribute
- Attribute of the user.- Throws:
WrongReferenceAttributeValueException
- if an referenced attribute against the parameter is to be compared is not availableWrongAttributeAssignmentException
- if attribute does not belong to appropriate entity
-
checkAttributeSyntax
public void checkAttributeSyntax(PerunSessionImpl perunSession, User user, Attribute attribute) throws WrongAttributeValueException Description copied from interface:UserAttributesModuleImplApi
Checks if assigned attribute value to the user has valid syntax.- Specified by:
checkAttributeSyntax
in interfaceUserAttributesModuleImplApi
- Parameters:
perunSession
- PerunSessionuser
- Userattribute
- Attribute of the user.- Throws:
WrongAttributeValueException
- if the attribute value has wrong/illegal syntax
-
fillAttribute
public Attribute fillAttribute(PerunSessionImpl session, User user, AttributeDefinition attribute) throws WrongAttributeAssignmentException Description copied from interface:UserAttributesModuleImplApi
Tries to fill an attribute to the specified user.- Specified by:
fillAttribute
in interfaceUserAttributesModuleImplApi
- Parameters:
session
- PerunSessionuser
- Userattribute
- Attribute in relationship between facility and user to be filled in.- Returns:
- Attribute which MAY be filled in
- Throws:
WrongAttributeAssignmentException
-
getAnonymizedValue
public Attribute getAnonymizedValue(PerunSessionImpl session, User user, Attribute attribute) throws AnonymizationNotSupportedException Description copied from interface:UserAttributesModuleImplApi
Gets anonymized value of the attribute.- Specified by:
getAnonymizedValue
in interfaceUserAttributesModuleImplApi
- Parameters:
session
- PerunSessionuser
- Userattribute
- Attribute of the user.- Returns:
- Attribute with anonymized value
- Throws:
AnonymizationNotSupportedException
- if the module doesn't implement this method
-