com.adobe.cq.mcm.salesforce

Class SalesforceClient

java.lang.Object

com.adobe.cq.mcm.salesforce.SalesforceClient

public class SalesforceClient
extends java.lang.Object

The SalesforceClient uses the Salesforce REST API to authenticate and query Salesforce.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SalesforceClient.AvailableMethods

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_FORMURL_ENCODED
static java.lang.String	CLIENT_ID
static java.lang.String	CLIENT_SECRET
static java.lang.String	GRANT_TYPE
static java.lang.String	INVALID_CLIENT
static java.lang.String	INVALID_CLIENT_ID
static java.lang.String	REFRESH_ACCESS_TOKEN_ENDPOINT
static java.lang.String	REFRESH_TOKEN

Constructor Summary

Constructors

Constructor and Description
SalesforceClient()

Method Summary

Modifier and Type	Method and Description
void	addData(java.lang.String key, java.lang.String value) Adds a key-value pair to parameters list
void	addData(java.lang.String key, java.lang.String value, boolean encode) Adds a key-value pair to parameters list with an option not to encode the parameters
void	addParameter(java.lang.String key, java.lang.String value) Adds a parameter to the param list
SalesforceResponse	doExecuteDataRequest() Executes the Current POST/PATCH Request
SalesforceResponse	doExecuteGetRequest() Executes the Current GET Request
SalesforceResponse	executeDataRequest() Executes the Current POST/PATCH Request and refreshes the access token if expired
SalesforceResponse	executeGetRequest() Executes the Current GET Request and refreshes the access token if expired
SalesforceResponse	executeRequest() Executes the current request.
java.lang.String	getAccessToken() Returns the Access Token
java.lang.String	getClientId() Returns the Client Identifier.
java.lang.String	getClientSecret() Returns the Client Secret.
java.lang.String	getContentType() Returns the Content-Type of the Request
java.lang.String	getData() Returns the URL encoded parameters used for REST Api calls as a String.
java.lang.String	getInstanceURL() Returns the Instance URL for the Salesforce configuration
SalesforceClient.AvailableMethods	getMethod() Returns the HTTP Method used in the Current Request.
java.util.HashMap<java.lang.String,java.lang.String>	getParameters() Returns the list of parameters as a map
java.lang.String	getPath() Returns the current REST API endpoint
java.lang.String	getRefreshToken() Returns the Refresh Token
boolean	isAccessTokenExpired(SalesforceResponse salesforceResponse) Checks if the currently set access token has been expired or not
SalesforceResponse	refreshAccessToken() Refreshes the Access Token using the refresh_token Assumes that the client_id and client_secret are set before invoking this function
void	setAccessToken(java.lang.String accessToken) Sets the Access Token
void	setClientBuilderFactory(HttpClientBuilderFactory clientBuilderFactory) Sets the HTTP Client Builder factory
void	setClientId(java.lang.String clientId) Sets the Client Identifier.
void	setClientSecret(java.lang.String clientSecret) Sets the Client Secret.
void	setContentType(java.lang.String contentType) Sets the Content-Type of the Request
void	setData(java.util.Map<java.lang.String,java.lang.String> data) Set the URL encoded parameters used for REST Api calls as a Map of key-value pairs.
void	setData(java.lang.String data) Set the URL encoded parameters used for REST Api calls as a String.
void	setInstanceURL(java.lang.String instanceURL) Sets the Instance URL for the Salesforce configuration
void	setMethod(SalesforceClient.AvailableMethods method) Sets the HTTP Method used in the Current Request.
void	setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters) Sets the list of parameters.
void	setPath(java.lang.String path) Sets the current REST API endpoint
void	setRefreshToken(java.lang.String refreshToken) Sets the Refresh Token
void	setStringMethod(java.lang.String method) Sets the HTTP Method as a String to be used in Current Request

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_CLIENT_ID

public static final java.lang.String INVALID_CLIENT_ID

See Also:

Constant Field Values

INVALID_CLIENT

public static final java.lang.String INVALID_CLIENT

See Also:

Constant Field Values

CLIENT_ID

public static final java.lang.String CLIENT_ID

See Also:

Constant Field Values

CLIENT_SECRET

public static final java.lang.String CLIENT_SECRET

See Also:

Constant Field Values

REFRESH_ACCESS_TOKEN_ENDPOINT

public static final java.lang.String REFRESH_ACCESS_TOKEN_ENDPOINT

See Also:

Constant Field Values

APPLICATION_FORMURL_ENCODED

public static final java.lang.String APPLICATION_FORMURL_ENCODED

See Also:

Constant Field Values

GRANT_TYPE

public static final java.lang.String GRANT_TYPE

See Also:

Constant Field Values

REFRESH_TOKEN

public static final java.lang.String REFRESH_TOKEN

See Also:

Constant Field Values

Constructor Detail

SalesforceClient

public SalesforceClient()

Method Detail

getClientId

public java.lang.String getClientId()

Returns the Client Identifier.

setClientId

public void setClientId(java.lang.String clientId)

Sets the Client Identifier. Also add into the data if not already present.

getClientSecret

public java.lang.String getClientSecret()

Returns the Client Secret.

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

Sets the Client Secret. Also add into the data if not already present.

getData

public java.lang.String getData()

Returns the URL encoded parameters used for REST Api calls as a String.

addData

public void addData(java.lang.String key,
                    java.lang.String value)

Adds a key-value pair to parameters list

addData

public void addData(java.lang.String key,
                    java.lang.String value,
                    boolean encode)

Adds a key-value pair to parameters list with an option not to encode the parameters

setData

public void setData(java.util.Map<java.lang.String,java.lang.String> data)

Set the URL encoded parameters used for REST Api calls as a Map of key-value pairs.

setData

public void setData(java.lang.String data)

Set the URL encoded parameters used for REST Api calls as a String.

getInstanceURL

public java.lang.String getInstanceURL()

Returns the Instance URL for the Salesforce configuration

setInstanceURL

public void setInstanceURL(java.lang.String instanceURL)

Sets the Instance URL for the Salesforce configuration

getPath

public java.lang.String getPath()

Returns the current REST API endpoint

setPath

public void setPath(java.lang.String path)

Sets the current REST API endpoint

getAccessToken

public java.lang.String getAccessToken()

Returns the Access Token

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Sets the Access Token

getRefreshToken

public java.lang.String getRefreshToken()

Returns the Refresh Token

setRefreshToken

public void setRefreshToken(java.lang.String refreshToken)

Sets the Refresh Token

getContentType

public java.lang.String getContentType()

Returns the Content-Type of the Request

setContentType

public void setContentType(java.lang.String contentType)

Sets the Content-Type of the Request

getMethod

public SalesforceClient.AvailableMethods getMethod()

Returns the HTTP Method used in the Current Request. Will be one of the SalesforceClient.AvailableMethods

setMethod

public void setMethod(SalesforceClient.AvailableMethods method)

Sets the HTTP Method used in the Current Request. Will be one of the SalesforceClient.AvailableMethods

setStringMethod

public void setStringMethod(java.lang.String method)

Sets the HTTP Method as a String to be used in Current Request

addParameter

public void addParameter(java.lang.String key,
                         java.lang.String value)

Adds a parameter to the param list

getParameters

public java.util.HashMap<java.lang.String,java.lang.String> getParameters()

Returns the list of parameters as a map

setParameters

public void setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters)

Sets the list of parameters.

setClientBuilderFactory

public void setClientBuilderFactory(HttpClientBuilderFactory clientBuilderFactory)

Sets the HTTP Client Builder factory

Parameters:

clientBuilderFactory - The HTTP Client Builder factory

executeRequest

public SalesforceResponse executeRequest()
                                  throws SalesforceException

Executes the current request. Delegates to appropriate method based on the HTTP method used

Throws:

SalesforceException

executeGetRequest

public SalesforceResponse executeGetRequest()
                                     throws SalesforceException

Executes the Current GET Request and refreshes the access token if expired

Throws:

SalesforceException

doExecuteGetRequest

public SalesforceResponse doExecuteGetRequest()
                                       throws java.io.IOException,
                                              SalesforceException

Executes the Current GET Request

Throws:

java.io.IOException

SalesforceException

executeDataRequest

public SalesforceResponse executeDataRequest()
                                      throws SalesforceException

Executes the Current POST/PATCH Request and refreshes the access token if expired

Throws:

SalesforceException

doExecuteDataRequest

public SalesforceResponse doExecuteDataRequest()
                                        throws java.io.IOException,
                                               SalesforceException

Executes the Current POST/PATCH Request

Throws:

java.io.IOException

SalesforceException

refreshAccessToken

public SalesforceResponse refreshAccessToken()
                                      throws SalesforceException

Refreshes the Access Token using the refresh_token Assumes that the client_id and client_secret are set before invoking this function

Throws:

SalesforceException

isAccessTokenExpired

public boolean isAccessTokenExpired(SalesforceResponse salesforceResponse)
                             throws SalesforceException

Checks if the currently set access token has been expired or not

Throws:

SalesforceException