Package org.apache.synapse.endpoints.auth.oauth

Class AuthorizationCodeHandler

java.lang.Object

org.apache.synapse.endpoints.auth.oauth.OAuthHandler

org.apache.synapse.endpoints.auth.oauth.AuthorizationCodeHandler

All Implemented Interfaces:

AuthHandler

public class AuthorizationCodeHandler
extends OAuthHandler

This class is used to handle Authorization code grant oauth.

Field Summary

Fields inherited from class org.apache.synapse.endpoints.auth.oauth.OAuthHandler

connectionRequestTimeout, connectionTimeout, socketTimeout

Constructor Summary

Constructors

Constructor	Description
AuthorizationCodeHandler(String tokenApiUrl, String clientId, String clientSecret, String refreshToken, String authMode, int connectionTimeout, int connectionRequestTimeout, int socketTimeout)

Method Summary

Modifier and Type	Method	Description
protected String	buildTokenRequestPayload(MessageContext messageContext)	Return the request payload relevant to the OAuth handler.
String	getRefreshToken()	Return the refresh token secret relevant to the Authorization Code Handler.
protected org.apache.axiom.om.OMElement	serializeSpecificOAuthConfigs(org.apache.axiom.om.OMFactory omFactory)	Return the OMElement for OAuth configuration relevant to the OAuth handler.

Methods inherited from class org.apache.synapse.endpoints.auth.oauth.OAuthHandler

getAuthMode, getAuthType, getClientId, getClientSecret, getConnectionRequestTimeout, getConnectionTimeout, getCustomHeadersMap, getEncodedCredentials, getRequestParametersAsString, getRequestParametersMap, getSocketTimeout, getTokenUrl, removeTokenFromCache, serializeOAuthConfiguration, setAuthHeader, setCustomHeaders, setRequestParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationCodeHandler

public AuthorizationCodeHandler(String tokenApiUrl,
                                String clientId,
                                String clientSecret,
                                String refreshToken,
                                String authMode,
                                int connectionTimeout,
                                int connectionRequestTimeout,
                                int socketTimeout)

Method Detail

buildTokenRequestPayload

protected String buildTokenRequestPayload(MessageContext messageContext)
                                   throws AuthException

Description copied from class: OAuthHandler

Return the request payload relevant to the OAuth handler.

Specified by:

buildTokenRequestPayload in class OAuthHandler

Returns:

String payload

Throws:

AuthException

serializeSpecificOAuthConfigs

protected org.apache.axiom.om.OMElement serializeSpecificOAuthConfigs(org.apache.axiom.om.OMFactory omFactory)

Description copied from class: OAuthHandler

Return the OMElement for OAuth configuration relevant to the OAuth handler.

Specified by:

serializeSpecificOAuthConfigs in class OAuthHandler

Returns:

OMElement OAuth configuration

getRefreshToken

public String getRefreshToken()

Return the refresh token secret relevant to the Authorization Code Handler.

Returns:

String refresh token