org.mule.modules.salesforce.config

Class AbstractCachedOAuthTokenBearerConfig

java.lang.Object

org.mule.modules.salesforce.config.AbstractConfig

org.mule.modules.salesforce.config.AbstractOAuthConfig

org.mule.modules.salesforce.config.AbstractOAuthTokenBearerConfig

org.mule.modules.salesforce.config.AbstractCachedOAuthTokenBearerConfig

All Implemented Interfaces:

Config, SessionControl

Direct Known Subclasses:

CachedSalesforceOAuthJWTConfig, CachedSalesforceOAuthSAMLConfig

public abstract class AbstractCachedOAuthTokenBearerConfig
extends AbstractOAuthTokenBearerConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected long	initialDelay Specify the time in seconds the connector will wait before executing the first keep-alive request
protected long	keepAliveRequestFrequency Specifies the time in seconds the connector will wait between two successive requests
protected boolean	useKeepAlive If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

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

consumerKey, disableSessionInvalidation, httpclient, keyStore, principal, storePassword, 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
AbstractCachedOAuthTokenBearerConfig()

Method Summary

Modifier and Type	Method and Description
protected void	connect(String consumerKey, String keyStore, String storePassword, String principal, String tokenEndpoint, boolean disableSessionInvalidation)
long	getInitialDelay()
long	getKeepAliveRequestFrequency()
boolean	isConnected() Check if connection is already established.
boolean	isUseKeepAlive()
void	setInitialDelay(long initialDelay)
void	setKeepAliveRequestFrequency(long keepAliveRequestFrequency)
void	setUseKeepAlive(boolean useKeepAlive)
protected void	startKeepAliveFeature(com.sforce.soap.partner.PartnerConnection partnerConnection)

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

destroySession, establishConnection, getGrantType, getKeyStoreResourceStream, getPrincipal, getSessionId, getTokenEndpoint, isDisableSessionInvalidationActive, sendAuthorizationRequestAndParseResponse, validateConfiguration

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, 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

useKeepAlive

@Configurable
 @Placement(group="Keep-Alive")
 @Default(value="false")
 @FriendlyName(value="Use keep alive")
protected boolean useKeepAlive

If set to true then the session will not expire and the connector will execute a simple request to mantain the session.

initialDelay

@Configurable
 @Placement(group="Keep-Alive")
 @Default(value="0")
 @FriendlyName(value="Initial delay")
protected long initialDelay

Specify the time in seconds the connector will wait before executing the first keep-alive request

keepAliveRequestFrequency

@Configurable
 @Placement(group="Keep-Alive")
 @Default(value="320")
 @FriendlyName(value="Keep-Alive request frequency")
protected long keepAliveRequestFrequency

Specifies the time in seconds the connector will wait between two successive requests

Constructor Detail

AbstractCachedOAuthTokenBearerConfig

public AbstractCachedOAuthTokenBearerConfig()

Method Detail

connect

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

Overrides:

connect in class AbstractOAuthTokenBearerConfig

Throws:

org.mule.api.ConnectionException

startKeepAliveFeature

protected void startKeepAliveFeature(com.sforce.soap.partner.PartnerConnection partnerConnection)

isUseKeepAlive

public boolean isUseKeepAlive()

setUseKeepAlive

public void setUseKeepAlive(boolean useKeepAlive)

getInitialDelay

public long getInitialDelay()

setInitialDelay

public void setInitialDelay(long initialDelay)

getKeepAliveRequestFrequency

public long getKeepAliveRequestFrequency()

setKeepAliveRequestFrequency

public void setKeepAliveRequestFrequency(long keepAliveRequestFrequency)

isConnected

@ValidateConnection
public boolean isConnected()

Check if connection is already established.

Overrides:

isConnected in class AbstractConfig

Returns:

true if connection already established, false otherwise