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

Class urn_perun_user_attribute_def_virt_eduPersonORCID

java.lang.Object

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

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

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

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

cz.metacentrum.perun.core.impl.modules.attributes.urn_perun_user_attribute_def_virt_eduPersonORCID

All Implemented Interfaces:

AttributesModuleImplApi, UserAttributesModuleImplApi, UserVirtualAttributesModuleImplApi, VirtualAttributesModuleImplApi

public class urn_perun_user_attribute_def_virt_eduPersonORCID
extends UserVirtualAttributeCollectedFromUserExtSource

ORCIDs collected from UserExtSources attributes. The behaviour can be further extended by setting the following properties in the eduPersonORCIDConfig entityless attribute:

• source_attribute - UES attribute name from which to fetch the values
• get_ext_login - set to "true" or "1" to fetch also the external logins
• value_filter - regex to filter the collected values by
• es_type - filter external sources by type
• es_name - filter external sources by name
• pattern and replacement - define the transformation to apply to the collected values

Author:

Martin Kuba makub@ics.muni.cz

Nested Class Summary

Nested classes/interfaces inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.UserVirtualAttributeCollectedFromUserExtSource

UserVirtualAttributeCollectedFromUserExtSource.AttributeHandleIdentifier, UserVirtualAttributeCollectedFromUserExtSource.ModifyValueContext

Constructor Summary

Constructors

Constructor	Description
urn_perun_user_attribute_def_virt_eduPersonORCID()

Method Summary

Modifier and Type	Method	Description
boolean	getAlsoExtLogin(PerunSessionImpl sess)	Override this method to return true to also collect logins from the user ext sources.
Attribute	getAttributeValue(PerunSessionImpl sess, User user, AttributeDefinition destinationAttributeDefinition)	This method will return computed value.
String	getDestinationAttributeDescription()
String	getDestinationAttributeFriendlyName()	Specifies friendly (short) name of attribute from namespace urn:perun:user:attribute-def:virt where values will be stored
Predicate<UserExtSource>	getExtSourceFilter(PerunSessionImpl sess)	Override this method to filter the user ext sources (collect the value from the UES only if it passes the filter).
String	getSourceAttributeFriendlyName()	Specifies friendly (short) name of attribute from namespace urn:perun:ues:attribute-def:def whose values are to be collected.
List<String>	getStrongDependencies()	Get list of attributes which this attribute value is computed from.
Predicate<String>	getValueFilter(PerunSessionImpl sess)	Override this method to filter the collected values.
String	modifyValue(PerunSession session, UserVirtualAttributeCollectedFromUserExtSource.ModifyValueContext ctx, UserExtSource ues, String value)	Override this method if you need to modify the original values.

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.UserVirtualAttributeCollectedFromUserExtSource

getAttributeDefinition, getDestinationAttributeDisplayName, getDestinationAttributeName, getHandleIdentifiers, getSourceAttributeName, initModifyValueContext, isLastAccessValid, resolveVirtualAttributeValueChange

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.UserVirtualAttributesModuleAbstract

removeAttributeValue, searchInAttributesValues, setAttributeValue

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.UserAttributesModuleAbstract

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, deletedEntityHook, fillAttribute, getAnonymizedValue

Methods inherited from class cz.metacentrum.perun.core.implApi.modules.attributes.AttributesModuleAbstract

getAuthorizedRoles, getDependencies

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

getAuthorizedRoles, getDependencies

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

changedAttributeHook, checkAttributeSemantics, checkAttributeSyntax, deletedEntityHook, fillAttribute, getAnonymizedValue

Constructor Details

urn_perun_user_attribute_def_virt_eduPersonORCID

public urn_perun_user_attribute_def_virt_eduPersonORCID()

Method Details

getDestinationAttributeDescription

public String getDestinationAttributeDescription()

Overrides:

getDestinationAttributeDescription in class UserVirtualAttributeCollectedFromUserExtSource

getDestinationAttributeFriendlyName

public String getDestinationAttributeFriendlyName()

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Specifies friendly (short) name of attribute from namespace urn:perun:user:attribute-def:virt where values will be stored

Specified by:

getDestinationAttributeFriendlyName in class UserVirtualAttributeCollectedFromUserExtSource

Returns:

short name of user attribute which is destination for collected values

getAttributeValue

public Attribute getAttributeValue(PerunSessionImpl sess,
 User user,
 AttributeDefinition destinationAttributeDefinition)

Description copied from interface: UserVirtualAttributesModuleImplApi

This method will return computed value.

Specified by:

getAttributeValue in interface UserVirtualAttributesModuleImplApi

Overrides:

getAttributeValue in class UserVirtualAttributeCollectedFromUserExtSource

Parameters:

sess - perun session

user - user which is needed for computing the value

destinationAttributeDefinition - attribute to operate on

Returns:

getSourceAttributeFriendlyName

public String getSourceAttributeFriendlyName()

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Specifies friendly (short) name of attribute from namespace urn:perun:ues:attribute-def:def whose values are to be collected.

Specified by:

getSourceAttributeFriendlyName in class UserVirtualAttributeCollectedFromUserExtSource

Returns:

short name of userExtSource attribute which is source of values

getExtSourceFilter

public Predicate<UserExtSource> getExtSourceFilter(PerunSessionImpl sess)

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Override this method to filter the user ext sources (collect the value from the UES only if it passes the filter).

Overrides:

getExtSourceFilter in class UserVirtualAttributeCollectedFromUserExtSource

Returns:

UES predicate serving as a filter

getValueFilter

public Predicate<String> getValueFilter(PerunSessionImpl sess)

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Override this method to filter the collected values.

Overrides:

getValueFilter in class UserVirtualAttributeCollectedFromUserExtSource

Returns:

regex by which the collected values will be filtered.

modifyValue

public String modifyValue(PerunSession session,
 UserVirtualAttributeCollectedFromUserExtSource.ModifyValueContext ctx,
 UserExtSource ues,
 String value)

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Override this method if you need to modify the original values. The default implementation makes no modification. Return null if the value should be skipped.

Overrides:

modifyValue in class UserVirtualAttributeCollectedFromUserExtSource

Parameters:

session - PerunSession

ctx - context initialized in initModifyValueContext method

ues - UserExtSource

value - of userExtSource attribute

Returns:

modified value or null to skip the value

getAlsoExtLogin

public boolean getAlsoExtLogin(PerunSessionImpl sess)

Description copied from class: UserVirtualAttributeCollectedFromUserExtSource

Override this method to return true to also collect logins from the user ext sources.

Overrides:

getAlsoExtLogin in class UserVirtualAttributeCollectedFromUserExtSource

Returns:

boolean value indicating whether to also collect logins

getStrongDependencies

public List<String> getStrongDependencies()

Description copied from interface: VirtualAttributesModuleImplApi

Get list of attributes which this attribute value is computed from. In other words attributes whose values change can also directly affect value of this attribute.

An attribute should strongly depend on all attributes which values are used in method "getAttributeValue" defined in attribute module for virtual attributes.

Specified by:

getStrongDependencies in interface VirtualAttributesModuleImplApi

Overrides:

getStrongDependencies in class UserVirtualAttributesModuleAbstract

Returns:

list of attributes this attribute strongly depends on

See Also:

• AttributesManagerBl.checkAttributeDependencies(PerunSession, RichAttribute)