com.helger.photon.basic.security.util

Class SecurityUtils

java.lang.Object

com.helger.photon.basic.security.util.SecurityUtils

@Immutable
public final class SecurityUtils
extends Object

Security utility methods

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static String	getGuestUserDisplayName(Locale aDisplayLocale) Get the display name of the guest user in the specified locale.
static String	getUserDisplayName(IUser aUser, Locale aDisplayLocale) Get the display name of the user.
static String	getUserDisplayName(String sUserID, Locale aDisplayLocale) Get the display name of the user.
static boolean	hasCurrentUserRole(String sRoleID)
static boolean	isCurrentUserAssignedToUserGroup(String sUserGroupID)

Methods inherited from class java.lang.Object

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

Method Detail

isCurrentUserAssignedToUserGroup

public static boolean isCurrentUserAssignedToUserGroup(@Nullable
                                       String sUserGroupID)

hasCurrentUserRole

public static boolean hasCurrentUserRole(@Nullable
                         String sRoleID)

getGuestUserDisplayName

@Nullable
public static String getGuestUserDisplayName(@Nonnull
                                      Locale aDisplayLocale)

Get the display name of the guest user in the specified locale.

Parameters:

aDisplayLocale - The locale to be used. May not be null.

Returns:

null if no translation is present.

getUserDisplayName

@Nullable
public static String getUserDisplayName(@Nullable
                                 String sUserID,
                                 @Nonnull
                                 Locale aDisplayLocale)

Get the display name of the user.

Parameters:

sUserID - User ID. May be null.

aDisplayLocale - The display locale to be used.

Returns:

The "guest" text if no user ID was provided, the display name of the user if a valid user ID was provided or the ID of the user if an invalid user was provided.

getUserDisplayName

@Nullable
public static String getUserDisplayName(@Nullable
                                 IUser aUser,
                                 @Nonnull
                                 Locale aDisplayLocale)

Get the display name of the user. If no display name is present (because first name and last name are empty), the login name is returned.

Parameters:

aUser - User. May be null.

aDisplayLocale - The display locale to be used to resolve the "Guest" text if the passed user is null.

Returns:

Never null. Either the display name or the login name of the user.