Package io.micronaut.security.oauth2.url

Class DefaultOauthRouteUrlBuilder

java.lang.Object

io.micronaut.security.oauth2.url.DefaultOauthRouteUrlBuilder

All Implemented Interfaces:

AbsoluteUrlBuilder, OauthRouteUrlBuilder

@Singleton
public class DefaultOauthRouteUrlBuilder
extends java.lang.Object
implements OauthRouteUrlBuilder

Default implementation of OauthRouteUrlBuilder

Since:

1.2.0

Author:

James Kleeh

Method Summary

Modifier and Type	Method	Description
protected java.net.URL	build(io.micronaut.http.HttpRequest originating, java.lang.String providerName, java.lang.String uriTemplate)	Builds a URL with the provided arguments
java.net.URI	buildCallbackUri(java.lang.String providerName)	Builds the URI to receive the OAuth 2.0 authorization callback request
java.net.URL	buildCallbackUrl(io.micronaut.http.HttpRequest originating, java.lang.String providerName)	Builds the URL to receive the OAuth 2.0 authorization callback request
java.net.URI	buildLoginUri(java.lang.String providerName)	Builds the URI to start the OAuth 2.0 authorization code flow
java.net.URL	buildLoginUrl(io.micronaut.http.HttpRequest originating, java.lang.String providerName)	Builds the URL to start the OAuth 2.0 authorization code flow
java.net.URL	buildUrl(io.micronaut.http.HttpRequest current, java.lang.String path)	Builds an absolute URL for the given path
protected java.lang.String	getPath(java.lang.String uriTemplate, java.lang.String providerName)	Builds the path portion of the URL

Methods inherited from class java.lang.Object

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

Method Detail

buildLoginUrl

public java.net.URL buildLoginUrl(@Nullable
                                  io.micronaut.http.HttpRequest originating,
                                  java.lang.String providerName)

Description copied from interface: OauthRouteUrlBuilder

Builds the URL to start the OAuth 2.0 authorization code flow

Specified by:

buildLoginUrl in interface OauthRouteUrlBuilder

Parameters:

originating - The originating request

providerName - The oauth provider name

Returns:

The URL

buildCallbackUrl

public java.net.URL buildCallbackUrl(@Nullable
                                     io.micronaut.http.HttpRequest originating,
                                     java.lang.String providerName)

Description copied from interface: OauthRouteUrlBuilder

Builds the URL to receive the OAuth 2.0 authorization callback request

Specified by:

buildCallbackUrl in interface OauthRouteUrlBuilder

Parameters:

originating - The originating request

providerName - The oauth provider name

Returns:

The URL

buildLoginUri

public java.net.URI buildLoginUri(@Nullable
                                  java.lang.String providerName)

Description copied from interface: OauthRouteUrlBuilder

Builds the URI to start the OAuth 2.0 authorization code flow

Specified by:

buildLoginUri in interface OauthRouteUrlBuilder

Parameters:

providerName - The oauth provider name

Returns:

The URL

buildCallbackUri

public java.net.URI buildCallbackUri(@Nullable
                                     java.lang.String providerName)

Description copied from interface: OauthRouteUrlBuilder

Builds the URI to receive the OAuth 2.0 authorization callback request

Specified by:

buildCallbackUri in interface OauthRouteUrlBuilder

Parameters:

providerName - The oauth provider name

Returns:

The URL

build

protected java.net.URL build(@Nullable
                             io.micronaut.http.HttpRequest originating,
                             java.lang.String providerName,
                             java.lang.String uriTemplate)

Builds a URL with the provided arguments

Parameters:

originating - The originating request

providerName - The oauth provider name

uriTemplate - The URI template

Returns:

The URL

getPath

protected java.lang.String getPath(java.lang.String uriTemplate,
                                   java.lang.String providerName)

Builds the path portion of the URL

Parameters:

uriTemplate - The uri template

providerName - The provider name

Returns:

The URL path

buildUrl

public java.net.URL buildUrl(@Nullable
                             io.micronaut.http.HttpRequest current,
                             java.lang.String path)

Description copied from interface: AbsoluteUrlBuilder

Builds an absolute URL for the given path

Specified by:

buildUrl in interface AbsoluteUrlBuilder

Parameters:

current - The current request

path - The path

Returns:

The absolute URL