org.picketlink.authorization.util

Class AuthorizationUtil

java.lang.Object

org.picketlink.authorization.util.AuthorizationUtil

public class AuthorizationUtil
extends Object

Provides some comon authorization methods.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
AuthorizationUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	hasLevel(Identity identity, Level level) Checks if an user has given security level.
static boolean	hasPartition(Identity identity, Class<?> partitionType, String... partitionNames) Checks if an authenticated user is associated with a partition with the given type and name.
static boolean	hasPermission(Identity identity, Object resource, Class<?> resourceClass, Serializable resourceIdentifier, String operation) Checks if the user has permissions to a resource considering an operation.
static boolean	hasRole(Identity identity, PartitionManager partitionManager, String roleName) Checks if an authenticated user is granted with a role with the given name.
static boolean	isLoggedIn(Identity identity) Checks if the user is logged in.
static boolean	isMember(Identity identity, PartitionManager partitionManager, String groupName) Checks if an authenticated user is member of the a group with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationUtil

public AuthorizationUtil()

Method Detail

isLoggedIn

public static boolean isLoggedIn(Identity identity)

Checks if the user is logged in.

Parameters:

identity - The Identity instance representing an authenticated user.

Returns:

True if the user is logged in. Otherwise, returns false.

hasPermission

public static boolean hasPermission(Identity identity,
                    Object resource,
                    Class<?> resourceClass,
                    Serializable resourceIdentifier,
                    String operation)

Checks if the user has permissions to a resource considering an operation.

Parameters:

identity - The Identity instance representing an authenticated user.

resource - The resource.

resourceClass - The resource class if specified.

resourceIdentifier - The resource identifier, if specified.

operation - The operation.

hasRole

public static boolean hasRole(Identity identity,
              PartitionManager partitionManager,
              String roleName)

Checks if an authenticated user is granted with a role with the given name.

Parameters:

identity - The Identity instance representing an authenticated user.

partitionManager -

roleName - The role name.

Returns:

True if the user is granted with the role. Otherwise, returns false.

isMember

public static boolean isMember(Identity identity,
               PartitionManager partitionManager,
               String groupName)

Checks if an authenticated user is member of the a group with the given name.

Parameters:

identity - The Identity instance representing an authenticated user.

partitionManager -

groupName - The group name.

Returns:

True if the user is granted with the role. Otherwise, returns false.

hasPartition

public static boolean hasPartition(Identity identity,
                   Class<?> partitionType,
                   String... partitionNames)

Checks if an authenticated user is associated with a partition with the given type and name.

Parameters:

identity - The Identity instance representing an authenticated user.

partitionType - The required type of the partition. If null, all partition types should be considered.

partitionNames - The name of the partitions that should be associated with an authenticated user.

Returns:

True if the user is associated with the partition. Otherwise, returns false.

hasLevel

public static boolean hasLevel(Identity identity,
               Level level)

Checks if an user has given security level.

Parameters:

identity - The Identity instance representing an authenticated user.

level - Level which user should have

Returns:

True if the user has at least given level