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

Interface UserAttributesModuleImplApi

All Superinterfaces:

AttributesModuleImplApi

All Known Subinterfaces:

UserVirtualAttributesModuleImplApi

All Known Implementing Classes:

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_login_namespace_admin_meta, urn_perun_user_attribute_def_def_login_namespace_bbmri_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_bbmriid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_ceitec, urn_perun_user_attribute_def_def_login_namespace_eduroam_vsup, urn_perun_user_attribute_def_def_login_namespace_eduteams_acc_nickname, urn_perun_user_attribute_def_def_login_namespace_eduteams_acc_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_eduteams_nickname, urn_perun_user_attribute_def_def_login_namespace_eduteams_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_einfra, urn_perun_user_attribute_def_def_login_namespace_einfraid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_elixir_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_envriid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_eosc_federation_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_erasmus_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_erasmus_username, urn_perun_user_attribute_def_def_login_namespace_eurofusion_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_fenix_nickname, urn_perun_user_attribute_def_def_login_namespace_fenix_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_geant_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_lifescienceid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_lifescienceid_username, urn_perun_user_attribute_def_def_login_namespace_mu_adm, urn_perun_user_attribute_def_def_login_namespace_myaccessid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_researcher_access_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_surf_ram_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_umbrellaid_persistent_shadow, urn_perun_user_attribute_def_def_login_namespace_vsup, 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_sshPublicAdminKey, 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, urn_perun_user_attribute_def_virt_additionalIdentifiers, urn_perun_user_attribute_def_virt_alternativeLoginNames, urn_perun_user_attribute_def_virt_anonymized, urn_perun_user_attribute_def_virt_associatedUsersMails, urn_perun_user_attribute_def_virt_earliestActiveLastAccess, urn_perun_user_attribute_def_virt_eduPersonEntitlement, urn_perun_user_attribute_def_virt_eduPersonORCID, urn_perun_user_attribute_def_virt_eduPersonPrincipalNames, urn_perun_user_attribute_def_virt_eduPersonScopedAffiliations, urn_perun_user_attribute_def_virt_eIDASPersonIdentifiers, urn_perun_user_attribute_def_virt_epuids, urn_perun_user_attribute_def_virt_europeanStudentIDs, urn_perun_user_attribute_def_virt_forwardedVoPersonExternalAffiliation, urn_perun_user_attribute_def_virt_groupNames, urn_perun_user_attribute_def_virt_institutionsCountries, urn_perun_user_attribute_def_virt_kerberosLogins, urn_perun_user_attribute_def_virt_loa, urn_perun_user_attribute_def_virt_loaFenix, urn_perun_user_attribute_def_virt_login_namespace_bbmri_persistent, urn_perun_user_attribute_def_virt_login_namespace_bbmriid_persistent, urn_perun_user_attribute_def_virt_login_namespace_eduteams_acc_persistent, urn_perun_user_attribute_def_virt_login_namespace_eduteams_persistent, urn_perun_user_attribute_def_virt_login_namespace_einfraid_persistent, urn_perun_user_attribute_def_virt_login_namespace_elixir_persistent, urn_perun_user_attribute_def_virt_login_namespace_envriid_persistent, urn_perun_user_attribute_def_virt_login_namespace_eosc_federation_persistent, urn_perun_user_attribute_def_virt_login_namespace_erasmus_persistent, urn_perun_user_attribute_def_virt_login_namespace_erasmus_username, urn_perun_user_attribute_def_virt_login_namespace_eurofusion_persistent, urn_perun_user_attribute_def_virt_login_namespace_fenix_persistent, urn_perun_user_attribute_def_virt_login_namespace_geant_persistent, urn_perun_user_attribute_def_virt_login_namespace_lifescienceid_persistent, urn_perun_user_attribute_def_virt_login_namespace_myaccessid_persistent, urn_perun_user_attribute_def_virt_login_namespace_researcher_access_persistent, urn_perun_user_attribute_def_virt_login_namespace_surf_ram_persistent, urn_perun_user_attribute_def_virt_login_namespace_umbrellaid_persistent, urn_perun_user_attribute_def_virt_logins_namespace_google, urn_perun_user_attribute_def_virt_mails_namespace_google, urn_perun_user_attribute_def_virt_mails_namespace_microsoft, urn_perun_user_attribute_def_virt_mfaStatus, urn_perun_user_attribute_def_virt_optional_login_namespace, urn_perun_user_attribute_def_virt_optional_login_namespace_mu, urn_perun_user_attribute_def_virt_organizationsWithLoa, urn_perun_user_attribute_def_virt_preferredPhone, urn_perun_user_attribute_def_virt_schacHomeOrganizations, urn_perun_user_attribute_def_virt_schacPersonalUniqueCodes, urn_perun_user_attribute_def_virt_scopedLogin_namespace_mu, urn_perun_user_attribute_def_virt_shibbolethExtSources, urn_perun_user_attribute_def_virt_sponsoredMembershipInOrganizations, urn_perun_user_attribute_def_virt_studentIdentifiers, urn_perun_user_attribute_def_virt_tcsMails_mu, urn_perun_user_attribute_def_virt_unscopedLogin_namespace, urn_perun_user_attribute_def_virt_unscopedLogin_namespace_einfraid_persistent_shadow, urn_perun_user_attribute_def_virt_userCertDNs, urn_perun_user_attribute_def_virt_userCertExpirations, urn_perun_user_attribute_def_virt_userCertificatesLimited, urn_perun_user_attribute_def_virt_userEligibilities, urn_perun_user_attribute_def_virt_userOrganizations, urn_perun_user_attribute_def_virt_vomsDiracNickname, urn_perun_user_attribute_def_virt_voPersonExternalAffiliation, UserAttributesModuleAbstract, UserPersistentShadowAttribute, UserPersistentShadowAttributeWithConfig, UserVirtualAttributeCollectedFromUserExtSource, UserVirtualAttributesModuleAbstract

public interface UserAttributesModuleImplApi
extends AttributesModuleImplApi

Interface for checking and filling in user's attributes.

Author:

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

Method Summary

Modifier and Type	Method	Description
void	changedAttributeHook(PerunSessionImpl session, User user, Attribute attribute)	If you need to do some further work with other modules, this method do that
void	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.
Attribute	fillAttribute(PerunSessionImpl perunSession, User user, AttributeDefinition attribute)	Tries to fill an attribute to the specified user.
Attribute	getAnonymizedValue(PerunSessionImpl perunSession, User user, Attribute attribute)	Gets anonymized value of the attribute.

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,
 Attribute attribute)
                   throws WrongReferenceAttributeValueException

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

Parameters:

session - session

user - the user

attribute - the attribute

Throws:

WrongReferenceAttributeValueException

checkAttributeSemantics

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

Checks if value of assigned attribute to the user has valid semantics.

Parameters:

perunSession - PerunSession

user - User

attribute - Attribute of the user.

Throws:

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

WrongReferenceAttributeValueException - if an referenced attribute against the parameter is to be compared is not available

WrongAttributeAssignmentException - if attribute does not belong to appropriate entity

checkAttributeSyntax

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

Checks if assigned attribute value to the user has valid syntax.

Parameters:

perunSession - PerunSession

user - User

attribute - Attribute of the 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 perunSession,
 User user,
 AttributeDefinition attribute)
                 throws WrongAttributeAssignmentException

Tries to fill an attribute to the specified user.

Parameters:

perunSession - PerunSession

user - 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

getAnonymizedValue

Attribute getAnonymizedValue(PerunSessionImpl perunSession,
 User user,
 Attribute attribute)
                      throws AnonymizationNotSupportedException

Gets anonymized value of the attribute.

Parameters:

perunSession - PerunSession

user - User

attribute - Attribute of the user.

Returns:

Attribute with anonymized value

Throws:

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

AnonymizationNotSupportedException - if the module doesn't implement this method