com.mulesoft.service.oauth.internal.platform

Class OCSClient

java.lang.Object

com.mulesoft.service.oauth.internal.platform.OCSClient

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Stoppable

public class OCSClient
extends Object
implements org.mule.runtime.api.lifecycle.Stoppable

Client for the OCS API.

This client uses the Client Credentials grant type to OAuth into the Anypoint Platform in order to access the OCS API.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCSClient.OCSClientFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	REVISION_TOKEN_QUERY_PARAM

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse>	getAccessToken(String connectionUri) Gets the access token for the given connectionUri
CompletableFuture<org.mule.runtime.oauth.api.PlatformManagedConnectionDescriptor>	getConnectionDescriptor(String connectionUri) Obtains a PlatformManagedConnectionDescriptor describing the connection of the given connectionUri
static OCSClient.OCSClientFactory	getFactory()
CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse>	refreshToken(String connectionUri, String revisionToken) Refreshes the token for the given connectionUri
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION_TOKEN_QUERY_PARAM

public static final String REVISION_TOKEN_QUERY_PARAM

See Also:

Constant Field Values

Method Detail

getFactory

public static OCSClient.OCSClientFactory getFactory()

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

getAccessToken

public CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse> getAccessToken(String connectionUri)
                                                                                                 throws org.mule.runtime.oauth.api.exception.RequestAuthenticationException

Gets the access token for the given connectionUri

Parameters:

connectionUri - the uri of the connection which token we want

Returns:

a CompletableFuture with the obtained HttpResponse

Throws:

org.mule.runtime.oauth.api.exception.RequestAuthenticationException - in case of failure to OAuth into the Anypoint Platform

refreshToken

public CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse> refreshToken(String connectionUri,
                                                                                                      String revisionToken)
                                                                                               throws org.mule.runtime.oauth.api.exception.RequestAuthenticationException

Refreshes the token for the given connectionUri

Parameters:

connectionUri - the uri of the connection which token we want to refresh

revisionToken - the revision token of the token being refreshed

Returns:

a CompletableFuture with the obtained HttpResponse

Throws:

org.mule.runtime.oauth.api.exception.RequestAuthenticationException - in case of failure to OAuth into the Anypoint Platform

getConnectionDescriptor

public CompletableFuture<org.mule.runtime.oauth.api.PlatformManagedConnectionDescriptor> getConnectionDescriptor(String connectionUri)
                                                                                                          throws org.mule.runtime.oauth.api.exception.RequestAuthenticationException

Obtains a PlatformManagedConnectionDescriptor describing the connection of the given connectionUri

Parameters:

connectionUri - the uri of the connection which informatiton we seek

Returns:

a CompletableFuture with the obtained RequestAuthenticationException

Throws:

org.mule.runtime.oauth.api.exception.RequestAuthenticationException - in case of failure to OAuth into the Anypoint Platform