org.mule.runtime.oauth.api.builder

Interface OAuthPlatformManagedDancerBuilder

All Superinterfaces:

org.mule.runtime.oauth.api.builder.OAuthDancerBuilder<PlatformManagedOAuthDancer>

@NoImplement
 @Experimental
public interface OAuthPlatformManagedDancerBuilder
extends org.mule.runtime.oauth.api.builder.OAuthDancerBuilder<PlatformManagedOAuthDancer>

Builder that allows to configure the attributes for the PlatformManagedOAuthDancer

Platform Managed OAuth is an experimental feature. It will only be enabled on selected environments and scenarios. Backwards compatibility is not guaranteed.

Since:

4.3.0

Method Summary

Modifier and Type	Method and Description
OAuthPlatformManagedDancerBuilder	addListener(PlatformManagedOAuthStateListener listener) Adds the listener.
default OAuthPlatformManagedDancerBuilder	apiVersion(String apiVersion) Sets the platform API version to a specific one.
OAuthPlatformManagedDancerBuilder	connectionUri(String connectionUri) Sets the URI that identifies the connection that is defined in the Anypoint Platform
OAuthPlatformManagedDancerBuilder	organizationId(String organizationId) Sets the ID of the organization that defined the connection in the Anypoint Platform
OAuthPlatformManagedDancerBuilder	platformUrl(String platformUrl) Sets the url of the platform API that serves the managed tokens

Methods inherited from interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

build, clientCredentials, customParametersExtractorsExprs, encoding, name, resourceOwnerIdTransformer, responseAccessTokenExpr, responseExpiresInExpr, responseRefreshTokenExpr, scopes, tokenUrl, tokenUrl, tokenUrl, tokenUrl, tokenUrl, withClientCredentialsIn

Method Detail

connectionUri

OAuthPlatformManagedDancerBuilder connectionUri(String connectionUri)

Sets the URI that identifies the connection that is defined in the Anypoint Platform

Parameters:

connectionUri - the id of the connection which token we want to obtain

Returns:

this builder

organizationId

OAuthPlatformManagedDancerBuilder organizationId(String organizationId)

Sets the ID of the organization that defined the connection in the Anypoint Platform

Parameters:

organizationId - an organizationId

Returns:

this builder

platformUrl

OAuthPlatformManagedDancerBuilder platformUrl(String platformUrl)

Sets the url of the platform API that serves the managed tokens

Parameters:

platformUrl - the url of the platform API that serves the managed tokens

Returns:

this builder

apiVersion

default OAuthPlatformManagedDancerBuilder apiVersion(String apiVersion)

Sets the platform API version to a specific one.

Parameters:

apiVersion - the platform API version

Returns:

this builder

Since:

4.4.0

addListener

OAuthPlatformManagedDancerBuilder addListener(PlatformManagedOAuthStateListener listener)

Adds the listener. Listeners will be invoked in the same order as they were added

Parameters:

listener - the PlatformManagedOAuthStateListener to be added

Throws:

IllegalArgumentException - if the listener is null