com.tsgrp.opencontent.core.user

Class UserUtil

java.lang.Object

com.tsgrp.opencontent.core.user.UserUtil

public class UserUtil
extends java.lang.Object

User Utilities

Constructor Summary

Constructors

Constructor and Description
UserUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	areValidUsers(java.lang.String ticket, java.lang.String[] userLoginNames) Returns true if all the parameterized userLoginNames correspond to valid users, false otherwise.
static java.lang.String	getCurrentUserDisplayName(java.lang.String ticket) Convenience method that returns the currently logged in user's Display Name.
static java.lang.String	getCurrentUserLoginName(java.lang.String ticket) Convenience method that returns the currently logged in user's userLoginName.
static java.lang.String	getDisplayNameFromLoginName(java.lang.String ticket, java.lang.String loginName, boolean strictMode) Gets the display name of a user from a provided login name.
static java.lang.String	getLabelName(java.lang.String ticket, java.lang.String userLoginName) Get the "Label Name" for the given user.
static java.lang.String	getLabelName(UserBean userBean)
static java.lang.String	getLoginNameFromDisplayName(java.lang.String ticket, java.lang.String loginName, boolean strictMode) Gets the username of a user from a provided display name.
static java.util.List<OCAuthority>	getOCAuthorityUser(java.lang.String ticket, java.lang.String loginName, boolean strictMode) This method is called by getDisplayNameFromLoginName/getLoginNameFromDisplayName to return a List that will be used to access the users display/login name.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserUtil

public UserUtil()

Method Detail

getCurrentUserLoginName

public static java.lang.String getCurrentUserLoginName(java.lang.String ticket)

Convenience method that returns the currently logged in user's userLoginName.

Parameters:

ticket -

Returns:

(String) userLoginName

getCurrentUserDisplayName

public static java.lang.String getCurrentUserDisplayName(java.lang.String ticket)

Convenience method that returns the currently logged in user's Display Name.

Parameters:

ticket - A valid OC Ticket

Returns:

The user's display name associated witht the ticket

getLabelName

public static java.lang.String getLabelName(java.lang.String ticket,
                                            java.lang.String userLoginName)

Get the "Label Name" for the given user. The label name is formatted as: User Display (userLoginName). Since this method is used primarily for display purposes, if the userLoginName does not correspond to any users, the value is returned unchanged.

Parameters:

ticket - OC ticket

userLoginName - the user login name to look for

Returns:

the Label Name for the given user login name or the userLoginName value unchanged if the user cannot be found

getLabelName

public static java.lang.String getLabelName(UserBean userBean)

Parameters:

userBean -

Returns:

See Also:

getLabelName(String, String)

getOCAuthorityUser

public static java.util.List<OCAuthority> getOCAuthorityUser(java.lang.String ticket,
                                                             java.lang.String loginName,
                                                             boolean strictMode)
                                                      throws OCRuntimeException

This method is called by getDisplayNameFromLoginName/getLoginNameFromDisplayName to return a List that will be used to access the users display/login name.

Parameters:

ticket - A valid OC ticket to use.

loginName - The loginName of the user to fetch the displayName for.

strictMode - True to throw an exception if the getUser call fails, false otherwise.

Returns:

The displayName of the user who has the loginName provided.

Throws:

OCRuntimeException - If an error occurs finding a user with the provided loginName parameter and the strictMode parameter is set to true.

getDisplayNameFromLoginName

public static java.lang.String getDisplayNameFromLoginName(java.lang.String ticket,
                                                           java.lang.String loginName,
                                                           boolean strictMode)

Gets the display name of a user from a provided login name. You can use this method if you're not sure if the loginName is a user name or a display name and this method will return the display name. Pass strictMode as true to throw an error if a user is not found.

Parameters:

ticket - A valid OC ticket to use.

loginName - The loginName of the user to fetch the displayName for.

strictMode - True to throw an exception if the getUser call fails, false otherwise.

Returns:

The displayName of the user who has the loginName provided.

Throws:

OCRuntimeException - If an error occurs finding a user with the provided loginName parameter and the strictMode parameter is set to true.

getLoginNameFromDisplayName

public static java.lang.String getLoginNameFromDisplayName(java.lang.String ticket,
                                                           java.lang.String loginName,
                                                           boolean strictMode)

Gets the username of a user from a provided display name. You can use this method if you're not sure if the loginName is a user name or a display name and this method will return the login name. Pass strictMode as true to throw an error if a user is not found.

Parameters:

ticket - A valid OC ticket to use.

loginName - The loginName of the user to fetch the displayName for.

strictMode - True to throw an exception if the getUser call fails, false otherwise.

Returns:

The loginName of the user.

Throws:

OCRuntimeException - If an error occurs finding a user with the provided loginName parameter and the strictMode parameter is set to true.

areValidUsers

public static boolean areValidUsers(java.lang.String ticket,
                                    java.lang.String[] userLoginNames)

Returns true if all the parameterized userLoginNames correspond to valid users, false otherwise.

Parameters:

ticket -

userLoginNames -

Returns: