io.micronaut.security.oauth2.url

Interface OauthRouteUrlBuilder

All Superinterfaces:

AbsoluteUrlBuilder

All Known Implementing Classes:

DefaultOauthRouteUrlBuilder

@DefaultImplementation(value=DefaultOauthRouteUrlBuilder.class)
public interface OauthRouteUrlBuilder
extends AbsoluteUrlBuilder

Responsible for building URLs to routes the client will receive requests on.

Since:

1.2.0

Author:

James Kleeh

Method Summary

Modifier and Type	Method and Description
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

Methods inherited from interface io.micronaut.security.oauth2.url.AbsoluteUrlBuilder

buildUrl

Method Detail

buildLoginUrl

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

Builds the URL to start the OAuth 2.0 authorization code flow

Parameters:

originating - The originating request

providerName - The oauth provider name

Returns:

The URL

buildCallbackUrl

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

Builds the URL to receive the OAuth 2.0 authorization callback request

Parameters:

originating - The originating request

providerName - The oauth provider name

Returns:

The URL

buildLoginUri

java.net.URI buildLoginUri(java.lang.String providerName)

Builds the URI to start the OAuth 2.0 authorization code flow

Parameters:

providerName - The oauth provider name

Returns:

The URL

buildCallbackUri

java.net.URI buildCallbackUri(java.lang.String providerName)

Builds the URI to receive the OAuth 2.0 authorization callback request

Parameters:

providerName - The oauth provider name

Returns:

The URL