senselogic.sitevision.api.user

Interface UserUtil

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

User utility interface.

This interface primarily handles nodes with primary node type sv:user, but some methods can also handle other user types (i.e. sv:simpleUser and/or sv:systemUser).

Tip! Some user-related functionality in other interfaces:

• Use PortletContextUtil.getCurrentUser() if you should get current user.
• Use UserIdentityUtil.getUserIdentity(javax.jcr.Node) if you should get the sv:userIdentity of a user.
• Use DirectoryUtil if you should lookup/search directory-bound users.
• Use PermissionUtil if you should check permission(s) for a sv:user.

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

Since:

SiteVision 4.0.1

Author:

Magnus Lövgren

See Also:

SystemUserUtil, SimpleUserUtil

Method Summary

Modifier and Type	Method and Description
boolean	isMemberOfGroup(Node aGroup) Checks if current user is member of a group.
boolean	isMemberOfGroup(Node aUser, Node aGroup) Checks if a specific user is member of a group.

Method Detail

isMemberOfGroup

boolean isMemberOfGroup(Node aGroup)

Checks if current user is member of a group.

This is a convenience for isMemberOfGroup(javax.jcr.Node, javax.jcr.Node) using current user (as of PortletContextUtil.getCurrentUser()).

Parameters:

aGroup - a group node (sv:userGroup or sv:virtualGroup)

Returns:

true if current user is member of aGroup, false otherwise

isMemberOfGroup

boolean isMemberOfGroup(Node aUser,
                        Node aGroup)

Checks if a specific user is member of a group.

Tip! To check if a sv:userIdentity is member of a sv:collaborationGroup, you would typically use UserIdentityWrapper.isMemberOf(javax.jcr.Node) or CollaborationGroupWrapper.isMember(javax.jcr.Node).

Parameters:

aUser - a user node (sv:user, sv:simpleUser or sv:systemUser)

aGroup - a group node (sv:userGroup or sv:virtualGroup)

Returns:

true if aUser is member of aGroup, false otherwise