org.apereo.cas.support.oauth.util

Class OAuth20Utils

java.lang.Object

org.apereo.cas.support.oauth.util.OAuth20Utils

public class OAuth20Utils
extends java.lang.Object

This class has some useful methods to output data in plain text, handle redirects, add parameter in url or find the right provider.

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
OAuth20Utils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	casOAuthCallbackUrl(java.lang.String serverPrefixUrl) Cas oauth callback url.
static boolean	checkCallbackValid(org.apereo.cas.services.RegisteredService registeredService, java.lang.String redirectUri) Check if the callback url is valid.
static boolean	checkClientSecret(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService, java.lang.String clientSecret) Check the client secret.
static boolean	checkResponseTypes(java.lang.String type, OAuth20ResponseTypes... expectedTypes) Check the response type against expected response types.
static org.apereo.cas.support.oauth.services.OAuthRegisteredService	getRegisteredOAuthServiceByClientId(org.apereo.cas.services.ServicesManager servicesManager, java.lang.String clientId) Locate the requested instance of OAuthRegisteredService by the given clientId.
static org.apereo.cas.support.oauth.services.OAuthRegisteredService	getRegisteredOAuthServiceByRedirectUri(org.apereo.cas.services.ServicesManager servicesManager, java.lang.String redirectUri) Gets registered oauth service by redirect uri.
static java.util.Collection<java.lang.String>	getRequestedScopes(javax.servlet.http.HttpServletRequest context) Gets requested scopes.
static java.util.Collection<java.lang.String>	getRequestedScopes(org.pac4j.core.context.J2EContext context) Gets requested scopes.
static java.util.Map<java.lang.String,java.lang.Object>	getRequestParameters(java.util.Collection<java.lang.String> attributes, javax.servlet.http.HttpServletRequest context) Gets attributes.
static OAuth20ResponseTypes	getResponseType(org.pac4j.core.context.J2EContext context) Gets response type.
static java.lang.String	getServiceRequestHeaderIfAny(javax.servlet.http.HttpServletRequest context) Gets service request header if any.
static boolean	isAuthorizedGrantTypeForService(org.pac4j.core.context.J2EContext context, org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService) Is authorized grant type for service?
static boolean	isAuthorizedGrantTypeForService(java.lang.String grantType, org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService) Is authorized grant type for service?
static boolean	isAuthorizedResponseTypeForService(org.pac4j.core.context.J2EContext context, org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService) Is authorized response type for service?
static boolean	isGrantType(java.lang.String type, OAuth20GrantTypes expectedType) Check the grant type against an expected grant type.
static boolean	isResponseType(java.lang.String type, OAuth20ResponseTypes expectedType) Check the response type against an expected response type.
static java.lang.String	jsonify(java.util.Map map) Jsonify string.
static java.util.Set<java.lang.String>	parseRequestScopes(javax.servlet.http.HttpServletRequest context) Parse request scopes set.
static java.util.Set<java.lang.String>	parseRequestScopes(org.pac4j.core.context.J2EContext context) Parse request scopes set.
static org.springframework.web.servlet.ModelAndView	produceErrorView(java.lang.Exception e) Produce error view model and view.
static org.springframework.web.servlet.ModelAndView	produceUnauthorizedErrorView() Produce unauthorized error view model and view.
static org.springframework.web.servlet.ModelAndView	redirectTo(org.springframework.web.servlet.View view) Redirect to model and view.
static org.springframework.web.servlet.ModelAndView	writeText(javax.servlet.http.HttpServletResponse response, java.lang.String text, int status) Write to the output the text and return a null view.
static org.springframework.web.servlet.ModelAndView	writeTextError(javax.servlet.http.HttpServletResponse response, java.lang.String error) Write to the output this error text and return a null view.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth20Utils

public OAuth20Utils()

Method Detail

writeTextError

public static org.springframework.web.servlet.ModelAndView writeTextError(javax.servlet.http.HttpServletResponse response,
                                                                          java.lang.String error)

Write to the output this error text and return a null view.

Parameters:

response - http response

error - error message

Returns:

a null view

writeText

public static org.springframework.web.servlet.ModelAndView writeText(javax.servlet.http.HttpServletResponse response,
                                                                     java.lang.String text,
                                                                     int status)

Write to the output the text and return a null view.

Parameters:

response - http response

text - output text

status - status code

Returns:

a null view

redirectTo

public static org.springframework.web.servlet.ModelAndView redirectTo(org.springframework.web.servlet.View view)

Redirect to model and view.

Parameters:

view - the view

Returns:

the model and view

getRegisteredOAuthServiceByClientId

public static org.apereo.cas.support.oauth.services.OAuthRegisteredService getRegisteredOAuthServiceByClientId(org.apereo.cas.services.ServicesManager servicesManager,
                                                                                                               java.lang.String clientId)

Locate the requested instance of OAuthRegisteredService by the given clientId.

Parameters:

servicesManager - the service registry DAO instance.

clientId - the client id by which the OAuthRegisteredService is to be located.

Returns:

null, or the located OAuthRegisteredService instance in the service registry.

getRegisteredOAuthServiceByRedirectUri

public static org.apereo.cas.support.oauth.services.OAuthRegisteredService getRegisteredOAuthServiceByRedirectUri(org.apereo.cas.services.ServicesManager servicesManager,
                                                                                                                  java.lang.String redirectUri)

Gets registered oauth service by redirect uri.

Parameters:

servicesManager - the services manager

redirectUri - the redirect uri

Returns:

the registered o auth service by redirect uri

getRequestParameters

public static java.util.Map<java.lang.String,java.lang.Object> getRequestParameters(java.util.Collection<java.lang.String> attributes,
                                                                                    javax.servlet.http.HttpServletRequest context)

Gets attributes.

Parameters:

attributes - the attributes

context - the context

Returns:

the attributes

getRequestedScopes

public static java.util.Collection<java.lang.String> getRequestedScopes(org.pac4j.core.context.J2EContext context)

Gets requested scopes.

Parameters:

context - the context

Returns:

the requested scopes

getRequestedScopes

public static java.util.Collection<java.lang.String> getRequestedScopes(javax.servlet.http.HttpServletRequest context)

Gets requested scopes.

Parameters:

context - the context

Returns:

the requested scopes

produceUnauthorizedErrorView

public static org.springframework.web.servlet.ModelAndView produceUnauthorizedErrorView()

Produce unauthorized error view model and view.

Returns:

the model and view

produceErrorView

public static org.springframework.web.servlet.ModelAndView produceErrorView(java.lang.Exception e)

Produce error view model and view.

Parameters:

e - the e

Returns:

the model and view

casOAuthCallbackUrl

public static java.lang.String casOAuthCallbackUrl(java.lang.String serverPrefixUrl)

Cas oauth callback url.

Parameters:

serverPrefixUrl - the server prefix url

Returns:

the string

jsonify

public static java.lang.String jsonify(java.util.Map map)

Jsonify string.

Parameters:

map - the map

Returns:

the string

getResponseType

public static OAuth20ResponseTypes getResponseType(org.pac4j.core.context.J2EContext context)

Gets response type.

Parameters:

context - the context

Returns:

the response type

isGrantType

public static boolean isGrantType(java.lang.String type,
                                  OAuth20GrantTypes expectedType)

Check the grant type against an expected grant type.

Parameters:

type - the given grant type

expectedType - the expected grant type

Returns:

whether the grant type is the expected one

isResponseType

public static boolean isResponseType(java.lang.String type,
                                     OAuth20ResponseTypes expectedType)

Check the response type against an expected response type.

Parameters:

type - the given response type

expectedType - the expected response type

Returns:

whether the response type is the expected one

isAuthorizedResponseTypeForService

public static boolean isAuthorizedResponseTypeForService(org.pac4j.core.context.J2EContext context,
                                                         org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService)

Is authorized response type for service?

Parameters:

context - the context

registeredService - the registered service

Returns:

the boolean

isAuthorizedGrantTypeForService

public static boolean isAuthorizedGrantTypeForService(java.lang.String grantType,
                                                      org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService)

Is authorized grant type for service?

Parameters:

grantType - the grant type

registeredService - the registered service

Returns:

true/false

isAuthorizedGrantTypeForService

public static boolean isAuthorizedGrantTypeForService(org.pac4j.core.context.J2EContext context,
                                                      org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService)

Is authorized grant type for service?

Parameters:

context - the context

registeredService - the registered service

Returns:

true/false

parseRequestScopes

public static java.util.Set<java.lang.String> parseRequestScopes(org.pac4j.core.context.J2EContext context)

Parse request scopes set.

Parameters:

context - the context

Returns:

the set

parseRequestScopes

public static java.util.Set<java.lang.String> parseRequestScopes(javax.servlet.http.HttpServletRequest context)

Parse request scopes set.

Parameters:

context - the context

Returns:

the set

getServiceRequestHeaderIfAny

public static java.lang.String getServiceRequestHeaderIfAny(javax.servlet.http.HttpServletRequest context)

Gets service request header if any.

Parameters:

context - the context

Returns:

the service request header if any

checkCallbackValid

public static boolean checkCallbackValid(@NonNull
                                         org.apereo.cas.services.RegisteredService registeredService,
                                         java.lang.String redirectUri)

Check if the callback url is valid.

Parameters:

registeredService - the registered service

redirectUri - the callback url

Returns:

whether the callback url is valid

checkClientSecret

public static boolean checkClientSecret(org.apereo.cas.support.oauth.services.OAuthRegisteredService registeredService,
                                        java.lang.String clientSecret)

Check the client secret.

Parameters:

registeredService - the registered service

clientSecret - the client secret

Returns:

whether the secret is valid

checkResponseTypes

public static boolean checkResponseTypes(java.lang.String type,
                                         OAuth20ResponseTypes... expectedTypes)

Check the response type against expected response types.

Parameters:

type - the current response type

expectedTypes - the expected response types

Returns:

whether the response type is supported