org.apereo.cas.support.oauth.util

Class OAuth20Utils

java.lang.Object

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

public final class OAuth20Utils
extends java.lang.Object

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

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
static java.lang.String	casOAuthCallbackUrl(java.lang.String serverPrefixUrl) Cas oauth callback url.
static org.apereo.cas.support.oauth.services.OAuthRegisteredService	getRegisteredOAuthService(org.apereo.cas.services.ServicesManager servicesManager, java.lang.String clientId) Locate the requested instance of OAuthRegisteredService by the given clientId.
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 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 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(java.lang.String url) Return a view which is a redirection to an url.
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

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(java.lang.String url)

Return a view which is a redirection to an url.

Parameters:

url - redirect url

Returns:

A view which is a redirection to an url

getRegisteredOAuthService

public static org.apereo.cas.support.oauth.services.OAuthRegisteredService getRegisteredOAuthService(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.

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

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