senselogic.sitevision.api.user

Interface UserIdentityUtil

@Requireable(value="UserIdentityUtil")
public interface UserIdentityUtil

User identity utility interface.

An instance of the Sitevision class implementing this interface can be obtained via UserFactory.getUserIdentityUtil(). See UserFactory for how to obtain an instance of the UserFactory interface.

Tip! Use PortletContextUtil.getCurrentUserIdentity() for getting the user identity of current user.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Node	getOrCreateUserIdentity(Node aUserNode) Creates the corresponding sv:userIdentity Node for a specified sv:user Node.
Node	getUserIdentity(Node aUserNode) Gets the corresponding sv:userIdentity Node for a specified sv:user Node.

Method Detail

getOrCreateUserIdentity

Node getOrCreateUserIdentity(Node aUserNode)

Creates the corresponding sv:userIdentity Node for a specified sv:user Node.

Note! When Collaboration is activated for a site, user identities are automatically created for each user when they authenticates themselves. This method is typically used for "infrequent" users during the startup phase of using Collaboration.

Note that neither anonymous users, the indexer or the extractor can have a user identity!

Parameters:

aUserNode - a user node that presumably do not have a corresponding user identity

Returns:

the existing or created sv:userIdentity Node for aUserNode, or null if aUserNode is null or isn't allowed to have user identity for current site (e.g. user is anonymized).

See Also:

getUserIdentity(javax.jcr.Node)

getUserIdentity

Node getUserIdentity(Node aUserNode)

Gets the corresponding sv:userIdentity Node for a specified sv:user Node.

Note that neither anonymous users, the indexer or the extractor user has a user identity!

Tip! Use PortletContextUtil.getCurrentUserIdentity() for getting the user identity of current user.

Parameters:

aUserNode - a user node

Returns:

the corresponding sv:userIdentity Node for aUserNode, or null if aUserNode is null or has no corresponding user identity for current site (e.g. user is anonymized).