com.pingidentity.pa.sdk.oauth

Class OAuthUtilities

java.lang.Object

com.pingidentity.pa.sdk.oauth.OAuthUtilities

public final class OAuthUtilities
extends Object

OAuthUtilities is a utility class containing useful methods for OAuth.

Method Summary

Modifier and Type	Method and Description
static void	createBaseWwwAuthenticateErrorHeaderValue(String realm, Set<String> scopes, String error, String errorDescription, String errorUri, StringBuilder builder) Returns the header value for the WWW-Authenticate header defined in RFC6750.
static String	createWwwAuthenticateErrorHeaderValue(Exchange exchange, Set<String> scopes, String error, String errorDescription, String errorUri) Returns the header value for the WWW-Authenticate header defined in RFC6750.
static String	createWwwAuthenticateErrorHeaderValue(String realm, Set<String> scopes, String error, String errorDescription, String errorUri) Returns the header value for the WWW-Authenticate header defined in RFC6750.

Methods inherited from class java.lang.Object

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

Method Detail

createWwwAuthenticateErrorHeaderValue

public static String createWwwAuthenticateErrorHeaderValue(String realm,
                                                           Set<String> scopes,
                                                           String error,
                                                           String errorDescription,
                                                           String errorUri)

Returns the header value for the WWW-Authenticate header defined in RFC6750. Attribute values should be well formed as described in RFC6750. No validation is done.

Parameters:

realm - the realm associated with the OAuth token that would be required for access

scopes - the required scopes to add to the WWW-Authenticate header, must not be null

error - the error as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorDescription - the error_description as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorUri - the error_uri as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

Returns:

the header value for the WWW-Authenticate header createWwwAuthenticateErrorHeaderValue(Exchange, Set, String, String, String) should be used when the realm from the application is required.

createBaseWwwAuthenticateErrorHeaderValue

public static void createBaseWwwAuthenticateErrorHeaderValue(String realm,
                                                             Set<String> scopes,
                                                             String error,
                                                             String errorDescription,
                                                             String errorUri,
                                                             StringBuilder builder)

Returns the header value for the WWW-Authenticate header defined in RFC6750. Attribute values should be well formed as described in RFC6750. No validation is done.

Parameters:

realm - the realm associated with the OAuth token that would be required for access

scopes - the required scopes to add to the WWW-Authenticate header, must not be null

error - the error as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorDescription - the error_description as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorUri - the error_uri as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

builder - a base StringBuilder that represents the auth-scheme for the WWW-Authenticate header createWwwAuthenticateErrorHeaderValue(Exchange, Set, String, String, String) should be used when the realm from the application is required.

createWwwAuthenticateErrorHeaderValue

public static String createWwwAuthenticateErrorHeaderValue(Exchange exchange,
                                                           Set<String> scopes,
                                                           String error,
                                                           String errorDescription,
                                                           String errorUri)

Returns the header value for the WWW-Authenticate header defined in RFC6750. Attribute values should be well formed as described in RFC6750. No validation is done.

Parameters:

exchange - the exchange used to retrieve the realm for the current application

scopes - the required scopes to add to the WWW-Authenticate header, must not be null

error - the error as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorDescription - the error_description as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

errorUri - the error_uri as outlined in RFC6750 to add to the WWW-Authenticate header, can be null

Returns:

the header value for the WWW-Authenticate header