org.mule.modules.salesforce.config

Class AbstractOAuthTokenBearerConfig

java.lang.Object

org.mule.modules.salesforce.config.AbstractConfig

org.mule.modules.salesforce.config.AbstractOAuthConfig

org.mule.modules.salesforce.config.AbstractOAuthTokenBearerConfig

All Implemented Interfaces:

Config, SessionControl

Direct Known Subclasses:

AbstractCachedOAuthTokenBearerConfig, SalesforceOAuthJWTConfig, SalesforceOAuthSAMLConfig

public abstract class AbstractOAuthTokenBearerConfig
extends AbstractOAuthConfig

Author:

MuleSoft, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	consumerKey
protected boolean	disableSessionInvalidation
protected org.apache.http.impl.client.CloseableHttpClient	httpclient
protected String	keyStore
protected String	principal
protected String	storePassword
protected String	tokenEndpoint

Fields inherited from class org.mule.modules.salesforce.config.AbstractOAuthConfig

COULD_NOT_EXTRACT_FIELD

Fields inherited from class org.mule.modules.salesforce.config.AbstractConfig

RECOMMENDED_API_VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractOAuthTokenBearerConfig()

Method Summary

Modifier and Type	Method and Description
protected void	connect(String consumerKey, String keyStore, String storePassword, String principal, String tokenEndpoint, boolean disableSessionInvalidation)
void	destroySession() End the current session
protected void	establishConnection(String grantType, String consumerKey, String tokenEndpoint, String keyStore, String storePassword)
protected abstract String	getGrantType()
protected InputStream	getKeyStoreResourceStream(String keyStoreName)
String	getPrincipal() Getter method for principal user.
String	getSessionId() Getter method for connection identifier.
String	getTokenEndpoint() Getter method for token endpoint configuration element.
protected boolean	isDisableSessionInvalidationActive()
protected void	sendAuthorizationRequestAndParseResponse(String tokenEndpoint, String grantType, String jwtToken)
void	validateConfiguration(String consumerKey, String keyStore, String storePassword, String principal, String tokenEndpoint, boolean disableSessionInvalidation) Method validating configuration.

Methods inherited from class org.mule.modules.salesforce.config.AbstractOAuthConfig

getApiVersion, getOAuth2AccessToken, getOAuth2instanceId, partnerConnection, postAuthorization, setApiVersion, setOAuth2AccessToken, setOAuth2instanceId

Methods inherited from class org.mule.modules.salesforce.config.AbstractConfig

computeBaseUrl, getAllowFieldTruncationSupport, getApexClassNames, getApexClient, getAssignmentRuleId, getBatchSobjectMaxDepth, getBulkConnection, getClearNullFields, getClientId, getConnectionTimeout, getFetchAllApexRestMetadata, getFetchAllApexSoapMetadata, getMetadataConnection, getMuleContext, getPartnerConnection, getProxyHost, getProxyPassword, getProxyPort, getProxyPortAsInteger, getProxyUsername, getPushEventRestClient, getReadTimeout, getTimeObjectStore, getUrls, getUseDefaultRule, getUsername, initConnectionConfig, isConnected, logoutPartnerConnection, setAllowFieldTruncationSupport, setApexClassNames, setAssignmentRuleId, setBatchSobjectMaxDepth, setClearNullFields, setClientId, setConnectionOptions, setConnectionTimeout, setFetchAllApexRestMetadata, setFetchAllApexSoapMetadata, setMuleContext, setPartnerConnection, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setReadTimeout, setTimeObjectStore, setUseDefaultRule, setUsername, subscribe, validateApexClassesConfiguration, validateCurrentSession, validatePartnerConnection, validateProxyConfiguration, verifyApiVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.modules.salesforce.streaming.SessionControl

recreateSession

Field Detail

consumerKey

protected String consumerKey

keyStore

protected String keyStore

storePassword

protected String storePassword

principal

protected String principal

tokenEndpoint

protected String tokenEndpoint

disableSessionInvalidation

protected boolean disableSessionInvalidation

httpclient

protected org.apache.http.impl.client.CloseableHttpClient httpclient

Constructor Detail

AbstractOAuthTokenBearerConfig

public AbstractOAuthTokenBearerConfig()

Method Detail

validateConfiguration

@TestConnectivity(label="Validate Configuration...")
public void validateConfiguration(@ConnectionKey
                                                                                       String consumerKey,
                                                                                       String keyStore,
                                                                                       @Password
                                                                                       String storePassword,
                                                                                       String principal,
                                                                                       String tokenEndpoint,
                                                                                       boolean disableSessionInvalidation)
                                                                                throws org.mule.api.ConnectionException

Method validating configuration. Check if connection can be established and validates metadata file.

Parameters:

consumerKey - Consumer key for Salesforce connected app

keyStore - Path to key store used to sign data during authentication

storePassword - Password of key store

principal - Username of desired Salesforce user to take action on behalf of.

tokenEndpoint - URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

disableSessionInvalidation - If true then the session will NOT be invalidated when the connection pool deems the connection is no longer needed. This could be useful when you use the same username from * more applications and get the same session from Salesforce. Default value is false.

Throws:

org.mule.api.ConnectionException - If something goes wrong

connect

protected void connect(String consumerKey,
                       String keyStore,
                       String storePassword,
                       String principal,
                       String tokenEndpoint,
                       boolean disableSessionInvalidation)
                throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

getGrantType

protected abstract String getGrantType()

establishConnection

protected void establishConnection(String grantType,
                                   String consumerKey,
                                   String tokenEndpoint,
                                   String keyStore,
                                   String storePassword)
                            throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

sendAuthorizationRequestAndParseResponse

protected void sendAuthorizationRequestAndParseResponse(String tokenEndpoint,
                                                        String grantType,
                                                        String jwtToken)
                                                 throws IOException

Throws:

IOException

getKeyStoreResourceStream

protected InputStream getKeyStoreResourceStream(String keyStoreName)
                                         throws FileNotFoundException

Throws:

FileNotFoundException

destroySession

@Disconnect
public void destroySession()

End the current session

Overrides:

destroySession in class AbstractConfig

isDisableSessionInvalidationActive

protected boolean isDisableSessionInvalidationActive()

Specified by:

isDisableSessionInvalidationActive in class AbstractConfig

getPrincipal

public String getPrincipal()

Getter method for principal user.

Returns:

principal user

getSessionId

@Nullable
 @ConnectionIdentifier
public String getSessionId()

Getter method for connection identifier.

Specified by:

getSessionId in interface SessionControl

Overrides:

getSessionId in class AbstractOAuthConfig

Returns:

identifier of connection

getTokenEndpoint

public String getTokenEndpoint()

Getter method for token endpoint configuration element. URL pointing to the server responsible for user authentication. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

Returns:

url of login server