com.incorta.connector

Interface OAuthManager

public interface OAuthManager

This interface only needs to be implemented for connectors that require OAuth authentication. It provides the necessary functionality for OAuth authentication steps.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OAuthManager.Request Represents an OAuth authorization request.
static class	OAuthManager.Response Represents a successful OAuth authorization response.

Method Summary

Modifier and Type	Method and Description
OAuthManager.Response	getAuthorizationResponse(java.lang.String redirectUri, java.lang.String state, java.lang.String authCode) Completes OAuth authorization and returns a OAuthManager.Response object containing the permanent token and username.
OAuthManager.Request	prepareAuthorizationRequest(java.lang.String redirectUri) Returns a OAuthManager.Request object containing the authorization URL and unique state string to be used by UI.

Method Detail

prepareAuthorizationRequest

OAuthManager.Request prepareAuthorizationRequest(java.lang.String redirectUri)
                                          throws ConnectorException

Returns a OAuthManager.Request object containing the authorization URL and unique state string to be used by UI.

Parameters:

redirectUri - Incorta's OAuth redirect URI

Returns:

A OAuthManager.Request object

Throws:

ConnectorException

Since:

1.0

getAuthorizationResponse

OAuthManager.Response getAuthorizationResponse(java.lang.String redirectUri,
                                               java.lang.String state,
                                               java.lang.String authCode)
                                        throws ConnectorException

Completes OAuth authorization and returns a OAuthManager.Response object containing the permanent token and username.

Parameters:

redirectUri - Incorta's OAuth redirect URI

state - Unique state string

authCode - Authorization code obtained from third party

Returns:

A OAuthManager.Response object

Throws:

ConnectorException

Since:

1.0