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

Class PasswordCredentialsHandler

java.lang.Object

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

org.apache.synapse.endpoints.auth.oauth.PasswordCredentialsHandler

All Implemented Interfaces:

AuthHandler

public class PasswordCredentialsHandler
extends OAuthHandler

This class is used to handle Password Credentials grant oauth.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PasswordCredentialsHandler(String tokenApiUrl, String clientId, String clientSecret, String username, String password, String authMode)

Method Summary

Modifier and Type	Method	Description
protected String	buildTokenRequestPayload(MessageContext messageContext)	Return the request payload relevant to the OAuth handler.
String	getPassword()
String	getUsername()
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, getCustomHeadersMap, getEncodedCredentials, getRequestParametersAsString, getRequestParametersMap, 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

PasswordCredentialsHandler

protected PasswordCredentialsHandler(String tokenApiUrl,
                                     String clientId,
                                     String clientSecret,
                                     String username,
                                     String password,
                                     String authMode)

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

getUsername

public String getUsername()

getPassword

public String getPassword()