net.krotscheck.kangaroo.authz.common.util

Class ValidationUtil

java.lang.Object

net.krotscheck.kangaroo.authz.common.util.ValidationUtil

public final class ValidationUtil
extends Object

A utility filled with validation tools.

Author:

Michael Krotscheck

Method Summary

Modifier and Type	Method and Description
static URI	requireValidRedirect(String redirect, List<ClientRedirect> redirects) Require that the provided string matches the set of redirection URL's.
static URI	requireValidRedirect(String redirect, Set<URI> redirects) Require that the provided string matches the set of redirection URL's.
static URI	requireValidRedirect(URI redirect, List<ClientRedirect> redirects) Require that the provided string matches the set of redirection URL's.
static SortedMap<String,ApplicationScope>	revalidateScope(String[] requestedScopes, SortedMap<String,ApplicationScope> originalScopes, SortedMap<String,ApplicationScope> validScopes) Revalidates a list of provided scopes against the originally granted scopes, as well as the current list of valid scopes.
static SortedMap<String,ApplicationScope>	revalidateScope(String requestedScopes, SortedMap<String,ApplicationScope> originalScopes, Role role) Revalidate a list of scopes against an originally granted list, as well as the current list of valid scopes from a user's role.
static SortedMap<String,ApplicationScope>	revalidateScope(String requestedScopes, SortedMap<String,ApplicationScope> originalScopes, SortedMap<String,ApplicationScope> validScopes) Revalidates a list of provided scopes against the originally granted scopes, as well as the current list of valid scopes.
static Authenticator	validateAuthenticator(AuthenticatorType type, List<Authenticator> authenticators) Ensure that an authenticator, requested by name, is valid within a specific list of authenticators.
static URI	validateRedirect(String redirect, List<ClientRedirect> redirects) This method assists in determining if a particular URI is valid for the scope of this client.
static URI	validateRedirect(String redirect, Set<URI> redirects) This method assists in determining if a particular URI is valid for the scope of this client.
static URI	validateRedirect(URI redirect, List<ClientRedirect> redirects) This method assists in determining if a particular URI is valid for the scope of this client.
static URI	validateRedirect(URI redirect, Set<URI> redirects) This method assists in determining if a particular URI is valid for the scope of this client.
static void	validateResponseType(Client client, String responseType) Validate that a response type is appropriate for a given client.
static SortedMap<String,ApplicationScope>	validateScope(SortedMap<String,ApplicationScope> requestedScopes, Role role) Ensure that a requested list of scopes is permitted for a specific role.
static SortedMap<String,ApplicationScope>	validateScope(String[] requestedScopes, SortedMap<String,ApplicationScope> validScopes) Creates a collection of scopes from a list of valid scopes.
static SortedMap<String,ApplicationScope>	validateScope(String requestedScopes, Role role) Validate a list of scopes against a role.
static SortedMap<String,ApplicationScope>	validateScope(String requestedScopes, SortedMap<String,ApplicationScope> validScopes) Creates a collection of scopes from a list of valid scopes.

Methods inherited from class java.lang.Object

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

Method Detail

validateResponseType

public static void validateResponseType(Client client,
                                        String responseType)

Validate that a response type is appropriate for a given client.

Parameters:

client - The client to check.

responseType - The requested response type.

requireValidRedirect

public static URI requireValidRedirect(URI redirect,
                                       List<ClientRedirect> redirects)

Require that the provided string matches the set of redirection URL's.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

requireValidRedirect

public static URI requireValidRedirect(String redirect,
                                       List<ClientRedirect> redirects)

Require that the provided string matches the set of redirection URL's.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

requireValidRedirect

public static URI requireValidRedirect(String redirect,
                                       Set<URI> redirects)

Require that the provided string matches the set of redirection URL's.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

validateRedirect

public static URI validateRedirect(URI redirect,
                                   List<ClientRedirect> redirects)

This method assists in determining if a particular URI is valid for the scope of this client.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

validateRedirect

public static URI validateRedirect(String redirect,
                                   List<ClientRedirect> redirects)

This method assists in determining if a particular URI is valid for the scope of this client.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

validateRedirect

public static URI validateRedirect(URI redirect,
                                   Set<URI> redirects)

This method assists in determining if a particular URI is valid for the scope of this client.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

validateRedirect

public static URI validateRedirect(String redirect,
                                   Set<URI> redirects)

This method assists in determining if a particular URI is valid for the scope of this client.

Parameters:

redirect - The URI to check.

redirects - A set of redirect url's to check against.

Returns:

The validated redirect URI, or null.

validateScope

public static SortedMap<String,ApplicationScope> validateScope(String[] requestedScopes,
                                                               SortedMap<String,ApplicationScope> validScopes)

Creates a collection of scopes from a list of valid scopes. If the requested scopes are not in that valid list, it will throw an exception.

Parameters:

requestedScopes - An array of requested scopes.

validScopes - A list of valid scopes.

Returns:

A list of the requested scopes, as database instances.

validateScope

public static SortedMap<String,ApplicationScope> validateScope(String requestedScopes,
                                                               SortedMap<String,ApplicationScope> validScopes)

Creates a collection of scopes from a list of valid scopes. If the requested scopes are not in that valid list, it will throw an exception.

Parameters:

requestedScopes - An array of requested scopes.

validScopes - A string of valid scopes.

Returns:

A list of the requested scopes, as database instances.

validateScope

public static SortedMap<String,ApplicationScope> validateScope(SortedMap<String,ApplicationScope> requestedScopes,
                                                               Role role)

Ensure that a requested list of scopes is permitted for a specific role.

Parameters:

requestedScopes - The requested client scopes.

role - The role.

Returns:

A valid map of scopes.

validateScope

public static SortedMap<String,ApplicationScope> validateScope(String requestedScopes,
                                                               Role role)

Validate a list of scopes against a role.

Parameters:

requestedScopes - An array of requested scopes.

role - The role.

Returns:

A list of the requested scopes, as database instances.

revalidateScope

public static SortedMap<String,ApplicationScope> revalidateScope(String[] requestedScopes,
                                                                 SortedMap<String,ApplicationScope> originalScopes,
                                                                 SortedMap<String,ApplicationScope> validScopes)

Revalidates a list of provided scopes against the originally granted scopes, as well as the current list of valid scopes. If the list of valid scopes has changed since the original token list, any missing scopes will be quietly dropped.

Parameters:

requestedScopes - An array of requested scopes.

originalScopes - The original set of scopes.

validScopes - The current list of valid scopes.

Returns:

A list of the requested scopes, as database instances.

revalidateScope

public static SortedMap<String,ApplicationScope> revalidateScope(String requestedScopes,
                                                                 SortedMap<String,ApplicationScope> originalScopes,
                                                                 SortedMap<String,ApplicationScope> validScopes)

Revalidates a list of provided scopes against the originally granted scopes, as well as the current list of valid scopes. If the list of valid scopes has changed since the original token list, any missing scopes will be quietly dropped.

Parameters:

requestedScopes - An array of requested scopes.

originalScopes - The original set of scopes.

validScopes - The current list of valid scopes.

Returns:

A list of the requested scopes, as database instances.

revalidateScope

public static SortedMap<String,ApplicationScope> revalidateScope(String requestedScopes,
                                                                 SortedMap<String,ApplicationScope> originalScopes,
                                                                 Role role)

Revalidate a list of scopes against an originally granted list, as well as the current list of valid scopes from a user's role.

Parameters:

requestedScopes - A space-separated list of scopes.

originalScopes - The original set of scopes.

role - The user's role to check for a scope list.

Returns:

A list of the requested scopes, as database instances.

validateAuthenticator

public static Authenticator validateAuthenticator(AuthenticatorType type,
                                                  List<Authenticator> authenticators)

Ensure that an authenticator, requested by name, is valid within a specific list of authenticators. If no string is provided, and yet the list of authenticators only contains one, this will default to that authenticator.

Parameters:

type - The requested authenticator type.

authenticators - The list of authenticators to test against.

Returns:

The valid authenticator.