de.samply.auth.utils

Class OAuth2ClientConfig

java.lang.Object

de.samply.auth.utils.OAuth2ClientConfig

public class OAuth2ClientConfig
extends Object

A small helper used to generate URLs to the identity provider.

Constructor Summary

Constructors

Constructor and Description
OAuth2ClientConfig()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getHost(de.samply.common.config.OAuth2Client config, String serverName)
static String	getLocalRedirectUrl(de.samply.common.config.OAuth2Client config, String scheme, String serverName, int port, String contextPath, String redirectUrl) Creates a URL for the current host.
static String	getLocalRedirectUrl(String scheme, String serverName, int port, String contextPath, String redirectUrl)
static String	getLogoutUrl(de.samply.common.config.OAuth2Client config, String scheme, String serverName, int port, String contextPath, String localRedirectURL) Returns the logout URL for Samply Auth
static String	getRedirectUrl(de.samply.common.config.OAuth2Client config, String scheme, String serverName, int port, String contextPath, String redirectUrl, Scope... scopes) Constructs the URL to the OAuth2 provider, using the provided configuration.
static String	getRedirectUrl(de.samply.common.config.OAuth2Client config, String scheme, String serverName, int port, String contextPath, String redirectUrl, String ip, Scope... scopes) Constructs the URL to the OAuth2 provider, using the provided configuration.
static String	getRedirectUrl(de.samply.common.config.OAuth2Client config, String scheme, String serverName, int port, String contextPath, String redirectUrl, String ip, String state, Scope... scopes) Constructs the URL to the OAuth2 provider, using the provided configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2ClientConfig

public OAuth2ClientConfig()

Method Detail

getHost

public static String getHost(de.samply.common.config.OAuth2Client config,
             String serverName)

getRedirectUrl

public static String getRedirectUrl(de.samply.common.config.OAuth2Client config,
                    String scheme,
                    String serverName,
                    int port,
                    String contextPath,
                    String redirectUrl,
                    Scope... scopes)
                             throws UnsupportedEncodingException

Constructs the URL to the OAuth2 provider, using the provided configuration. The redirect is set to "http(s)?://$serverName(:$port)?/$contextPath/$redirectUrl"

Parameters:

config - the OAuth2 configuration

scheme - the scheme (http|https) from the HTTP request

serverName - the server name from the HTTP request

port - the port (80, 443, 8080 ...) from the HTTP request

contextPath - the context path for the application ("/", "/mdr-gui") from the HTTP request

redirectUrl - the redirect URL inside the context path

scopes - a list of scopes separated by a whitespace

Returns:

the URL

Throws:

UnsupportedEncodingException

getRedirectUrl

public static String getRedirectUrl(de.samply.common.config.OAuth2Client config,
                    String scheme,
                    String serverName,
                    int port,
                    String contextPath,
                    String redirectUrl,
                    String ip,
                    Scope... scopes)
                             throws UnsupportedEncodingException

Constructs the URL to the OAuth2 provider, using the provided configuration. The redirect is set to "http(s)?://$serverName(:$port)?/$contextPath/$redirectUrl"

Parameters:

config - the OAuth2 configuration

scheme - the scheme (http|https) from the HTTP request

serverName - the server name from the HTTP request

port - the port (80, 443, 8080 ...) from the HTTP request

contextPath - the context path for the application ("/", "/mdr-gui") from the HTTP request

redirectUrl - the redirect URL inside the context path

ip - the identifier for the identity provider you want to use. Use null if you don't want to use a specific identity provider

scopes - a list of scopes separated by a whitespace

Returns:

the URL

Throws:

UnsupportedEncodingException

getRedirectUrl

public static String getRedirectUrl(de.samply.common.config.OAuth2Client config,
                    String scheme,
                    String serverName,
                    int port,
                    String contextPath,
                    String redirectUrl,
                    String ip,
                    String state,
                    Scope... scopes)
                             throws UnsupportedEncodingException

Constructs the URL to the OAuth2 provider, using the provided configuration. The redirect is set to "http(s)?://$serverName(:$port)?/$contextPath/$redirectUrl"

Parameters:

config - the OAuth2 configuration

scheme - the scheme (http|https) from the HTTP request

serverName - the server name from the HTTP request

port - the port (80, 443, 8080 ...) from the HTTP request

contextPath - the context path for the application ("/", "/mdr-gui") from the HTTP request

redirectUrl - the redirect URL inside the context path

ip - the identifier for the identity provider you want to use. Use null if you don't want to use a specific identity provider

state - the state parameter used to protect against cross site requests. Use null if you don't want to use a state parameter.

scopes - a list of scopes separated by a whitespace

Returns:

the URL

Throws:

UnsupportedEncodingException

getLocalRedirectUrl

public static String getLocalRedirectUrl(de.samply.common.config.OAuth2Client config,
                         String scheme,
                         String serverName,
                         int port,
                         String contextPath,
                         String redirectUrl)

Creates a URL for the current host.

Parameters:

config - the OAuth2 Configuration

scheme - the scheme (http|https)

serverName - the server name

port - the port (80, 443, 8080 ...)

contextPath - the context path for the application ("/", "/mdr-gui")

redirectUrl - the redirect URL inside the context path.

Returns:

a String object.

getLocalRedirectUrl

public static String getLocalRedirectUrl(String scheme,
                         String serverName,
                         int port,
                         String contextPath,
                         String redirectUrl)

getLogoutUrl

public static String getLogoutUrl(de.samply.common.config.OAuth2Client config,
                  String scheme,
                  String serverName,
                  int port,
                  String contextPath,
                  String localRedirectURL)
                           throws UnsupportedEncodingException

Returns the logout URL for Samply Auth

Parameters:

config - the OAuth2 Configuration

scheme - the scheme (http|https)

serverName - the server name

port - the port (80, 443, 8080 ...)

contextPath - the context path for the application ("/", "/mdr-gui")

localRedirectURL - the redirect URL inside the context path.

Returns:

a String object.

Throws:

UnsupportedEncodingException