net.krotscheck.kangaroo.authz.admin

Class Scope

java.lang.Object

net.krotscheck.kangaroo.authz.admin.Scope

public final class Scope
extends Object

List of all authorization scopes used in this application.

Author:

Michael Krotscheck

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION Authorization scope for the application resource.
static String	APPLICATION_ADMIN Administration scope for the application resource.
static String	AUTHENTICATOR Authorization scope for the authenticator resource.
static String	AUTHENTICATOR_ADMIN Authorization scope for the authenticator resource.
static String	CLIENT Authorization scope for the client resource.
static String	CLIENT_ADMIN Administration scope for the client resource.
static String	IDENTITY Authorization scope for the identity resource.
static String	IDENTITY_ADMIN Administration scope for the identity resource.
static String	ROLE Authorization scope for the roles resource.
static String	ROLE_ADMIN Administration scope for the roles resource.
static String	SCOPE Authorization scope for the scopes resource (not to be mistaken with this class).
static String	SCOPE_ADMIN Administration scope for the scopes resource (not to be mistaken with this class).
static String	TOKEN Authorization scope for the token resource.
static String	TOKEN_ADMIN Administration scope for the token resource.
static String	USER Authorization scope for the user resource.
static String	USER_ADMIN Administration scope for the user resource.

Method Summary

Modifier and Type	Method and Description
static List<String>	adminScopes() List of all scopes granted to admins.
static List<String>	allScopes() Get a list of all the scopes.
static String	forEntity(AbstractAuthzEntity entity, Boolean admin) Determine the required scope for the given entity.
static List<String>	userScopes() List of all scopes granted to users.

Methods inherited from class java.lang.Object

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

Field Detail

USER

public static final String USER

Authorization scope for the user resource.

See Also:

Constant Field Values

USER_ADMIN

public static final String USER_ADMIN

Administration scope for the user resource.

See Also:

Constant Field Values

APPLICATION

public static final String APPLICATION

Authorization scope for the application resource.

See Also:

Constant Field Values

APPLICATION_ADMIN

public static final String APPLICATION_ADMIN

Administration scope for the application resource.

See Also:

Constant Field Values

AUTHENTICATOR

public static final String AUTHENTICATOR

Authorization scope for the authenticator resource.

See Also:

Constant Field Values

AUTHENTICATOR_ADMIN

public static final String AUTHENTICATOR_ADMIN

Authorization scope for the authenticator resource.

See Also:

Constant Field Values

CLIENT

public static final String CLIENT

Authorization scope for the client resource.

See Also:

Constant Field Values

CLIENT_ADMIN

public static final String CLIENT_ADMIN

Administration scope for the client resource.

See Also:

Constant Field Values

IDENTITY

public static final String IDENTITY

Authorization scope for the identity resource.

See Also:

Constant Field Values

IDENTITY_ADMIN

public static final String IDENTITY_ADMIN

Administration scope for the identity resource.

See Also:

Constant Field Values

TOKEN

public static final String TOKEN

Authorization scope for the token resource.

See Also:

Constant Field Values

TOKEN_ADMIN

public static final String TOKEN_ADMIN

Administration scope for the token resource.

See Also:

Constant Field Values

ROLE

public static final String ROLE

Authorization scope for the roles resource.

See Also:

Constant Field Values

ROLE_ADMIN

public static final String ROLE_ADMIN

Administration scope for the roles resource.

See Also:

Constant Field Values

SCOPE

public static final String SCOPE

Authorization scope for the scopes resource (not to be mistaken with this class).

See Also:

Constant Field Values

SCOPE_ADMIN

public static final String SCOPE_ADMIN

Administration scope for the scopes resource (not to be mistaken with this class).

See Also:

Constant Field Values

Method Detail

allScopes

public static List<String> allScopes()

Get a list of all the scopes.

Returns:

A list of all scopes.

adminScopes

public static List<String> adminScopes()

List of all scopes granted to admins.

Returns:

List of all administrator scopes.

userScopes

public static List<String> userScopes()

List of all scopes granted to users.

Returns:

List of all user scopes.

forEntity

public static String forEntity(AbstractAuthzEntity entity,
                               Boolean admin)

Determine the required scope for the given entity.

Parameters:

entity - The entity to check.

admin - Whether to get the admin role or the regular one.

Returns:

The name of the scope for admin rights.