Package ch.ivyteam.ivy.rest.client.oauth2.uri

Class OAuth2UriProperty

java.lang.Object

ch.ivyteam.ivy.rest.client.oauth2.uri.OAuth2UriProperty

All Implemented Interfaces:

OAuth2UriProvider

public class OAuth2UriProperty
extends Object
implements OAuth2UriProvider

Provides OAUTH2 authentication URIs with Rest Client property support. So, that users can override URIs conveniently per environment. What's more, OAUTH2-flows involving a grant-code request are easier to setup since a common base-uri is used and can be used: see getUri(String).

Since:

9.2

API:

This is a public API.

Constructor Summary

Constructors

Constructor	Description
OAuth2UriProperty(FeatureConfig config, String defaultBaseUri)
OAuth2UriProperty(FeatureConfig config, String baseUriPropertyName, String defaultBaseUri)

Method Summary

Modifier and Type	Method	Description
URI	getUri(String baseRelativePath)

Constructor Detail

OAuth2UriProperty

public OAuth2UriProperty(FeatureConfig config,
                         String defaultBaseUri)

API:

This public API is available in Java.

OAuth2UriProperty

public OAuth2UriProperty(FeatureConfig config,
                         String baseUriPropertyName,
                         String defaultBaseUri)

API:

This public API is available in Java.

Method Detail

getUri

public URI getUri(String baseRelativePath)

Parameters:

baseRelativePath - A path relative to the initial base_uri. (e.g. 'auth')

Returns:

full qualified uri (e.g. https://api.twitter.com/oauth2/auth )

API:

This public API is available in Java.