com.technia.tvc.core.db

Class UserUtils

java.lang.Object

com.technia.tvc.core.db.UserUtils

public class UserUtils
extends java.lang.Object

Contains utility methods for accessing information about users when the type of the actual is unknown (i.e., it is not known whether the user is a role, group or person.

Constructor Summary

Constructors

Constructor and Description
UserUtils()

Method Summary

Modifier and Type	Method and Description
static void	clearCache() Clear cache for child roles and child groups, etc.
static void	fillCachePrivileged() Ensure that cache is filled with configured where clause and name filter
static java.util.List<java.lang.String>	getAllChildGroups(java.lang.String groupName) Returns a list of all child groups.
static java.util.List<java.lang.String>	getAllChildRoles(java.lang.String roleName) Returns a list of all child roles.
static java.util.Collection<java.lang.String>	getAllParentGroups(java.lang.String groupName)
static java.util.Collection<java.lang.String>	getAllParentRoles(java.lang.String roleName)
static java.util.List<java.lang.String>	getChildGroups(java.lang.String groupName) Returns a list of child groups.
static java.util.List<java.lang.String>	getChildRoles(java.lang.String roleName) Returns a list of child roles.
static java.util.List<java.lang.String>	getChildUsers(java.lang.String user) Returns the child users for the specified user.
static java.util.Collection<java.lang.String>	getParentUsers(java.lang.String user) Returns the parent users for the specified user.
static java.lang.String[]	getTopLevelGroups()
static java.lang.String[]	getTopLevelRoles()
static boolean	isGroup(java.lang.String user) Returns whether the specified user is a group or not.
static boolean	isPerson(java.lang.String user) Returns whether the specified user is a person or not.
static boolean	isRole(java.lang.String user) Returns whether the specified user is a role or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserUtils

public UserUtils()

Method Detail

clearCache

public static void clearCache()

Clear cache for child roles and child groups, etc.

Since:

6.0.0

isPerson

public static boolean isPerson(java.lang.String user)
                        throws TVCException

Returns whether the specified user is a person or not.

Throws:

TVCException

Since:

4.0

isRole

public static boolean isRole(java.lang.String user)
                      throws TVCException

Returns whether the specified user is a role or not.

Throws:

TVCException

Since:

4.0

isGroup

public static boolean isGroup(java.lang.String user)
                       throws TVCException

Returns whether the specified user is a group or not.

Throws:

TVCException

Since:

4.0

getAllParentRoles

public static java.util.Collection<java.lang.String> getAllParentRoles(java.lang.String roleName)
                                                                throws TVCException

Throws:

TVCException

getAllParentGroups

public static java.util.Collection<java.lang.String> getAllParentGroups(java.lang.String groupName)
                                                                 throws TVCException

Throws:

TVCException

getParentUsers

public static java.util.Collection<java.lang.String> getParentUsers(java.lang.String user)
                                                             throws TVCException

Returns the parent users for the specified user. Note this method should only be used when the caller don't know if the user argument is a group, role or person.

Throws:

TVCException

Since:

2010.1.1

See Also:

getAllParentGroups(String), getAllParentRoles(String)

getChildUsers

public static java.util.List<java.lang.String> getChildUsers(java.lang.String user)
                                                      throws TVCException

Returns the child users for the specified user. Note this method should only be used when the called don't know if the user is a group, role or person.

Throws:

TVCException

See Also:

getChildRoles(String), getChildGroups(String)

getTopLevelGroups

public static java.lang.String[] getTopLevelGroups()
                                            throws TVCException

Throws:

TVCException

getTopLevelRoles

public static java.lang.String[] getTopLevelRoles()
                                           throws TVCException

Throws:

TVCException

getChildGroups

public static java.util.List<java.lang.String> getChildGroups(java.lang.String groupName)
                                                       throws TVCException

Returns a list of child groups. Note the result will only

Parameters:

groupName - A group.

Returns:

A list of child groups.

Throws:

TVCException - If unable to get child groups.

getChildRoles

public static java.util.List<java.lang.String> getChildRoles(java.lang.String roleName)
                                                      throws TVCException

Returns a list of child roles. The list contains the first level only.

Parameters:

roleName - The name of a role.

Returns:

A list of child roles.

Throws:

TVCException - If unable to get child groups.

getAllChildGroups

public static java.util.List<java.lang.String> getAllChildGroups(java.lang.String groupName)
                                                          throws TVCException

Returns a list of all child groups.

Parameters:

groupName - The name of a group.

Returns:

A list of child groups.

Throws:

TVCException - If unable to get child groups.

getAllChildRoles

public static java.util.List<java.lang.String> getAllChildRoles(java.lang.String roleName)
                                                         throws TVCException

Returns a list of all child roles.

Parameters:

roleName - The name of a role.

Returns:

A list of child roles.

Throws:

TVCException - If unable to get child groups.

fillCachePrivileged

public static void fillCachePrivileged()
                                throws TVCException

Ensure that cache is filled with configured where clause and name filter

Throws:

TVCException