org.mule.modules.salesforce.config

Class AbstractConfig

java.lang.Object

org.mule.modules.salesforce.config.AbstractConfig

All Implemented Interfaces:

Config, SessionControl

Direct Known Subclasses:

AbstractOAuthConfig, CachedSalesforceBasicAuthConfig, SalesforceBasicAuthConfig

public abstract class AbstractConfig
extends Object
implements Config, SessionControl

Field Summary

Fields

Modifier and Type	Field and Description
static double	RECOMMENDED_API_VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractConfig()

Method Summary

Modifier and Type	Method and Description
String	computeBaseUrl(String url)
void	destroySession() End the current session
Boolean	getAllowFieldTruncationSupport()
List<String>	getApexClassNames() Getter method for apex class names.
ApexClient	getApexClient() Getter method for apex client.
String	getAssignmentRuleId()
Integer	getBatchSobjectMaxDepth()
com.sforce.async.BulkConnection	getBulkConnection()
boolean	getClearNullFields()
String	getClientId()
Integer	getConnectionTimeout() Getter method for connection timeout.
boolean	getFetchAllApexRestMetadata()
boolean	getFetchAllApexSoapMetadata()
com.sforce.soap.metadata.MetadataConnection	getMetadataConnection()
org.mule.api.MuleContext	getMuleContext() Getter method for mule context.
com.sforce.soap.partner.PartnerConnection	getPartnerConnection() Getter method for { com.sforce.soap.partner.PartnerConnection}.
String	getProxyHost() Getter method for proxy host.
String	getProxyPassword() Getter method for proxy password.
String	getProxyPort() Getter method for proxy port.
Integer	getProxyPortAsInteger()
String	getProxyUsername() Getter method for proxy username.
PushEventRestClient	getPushEventRestClient()
Integer	getReadTimeout() Getter method for read timeout.
abstract String	getSessionId()
org.mule.api.store.ObjectStore<? extends Serializable>	getTimeObjectStore()
Map<String,String>	getUrls()
Boolean	getUseDefaultRule()
String	getUsername()
protected void	initConnectionConfig(com.sforce.ws.ConnectorConfig connectorConfig)
boolean	isConnected() Check if connection is already established.
protected abstract boolean	isDisableSessionInvalidationActive()
void	logoutPartnerConnection()
void	setAllowFieldTruncationSupport(Boolean allowFieldTruncationSupport)
void	setApexClassNames(List<String> apexClassNames) Setter method for apex class names.
void	setAssignmentRuleId(String assignmentRuleId)
void	setBatchSobjectMaxDepth(Integer batchSobjectMaxDepth)
void	setClearNullFields(boolean clearNullFields)
void	setClientId(String clientId)
void	setConnectionOptions(com.sforce.soap.partner.PartnerConnection connection)
void	setConnectionTimeout(Integer connectionTimeout)
void	setFetchAllApexRestMetadata(boolean fetchAllApexRestMetadata)
void	setFetchAllApexSoapMetadata(boolean fetchAllApexMetadata)
void	setMuleContext(org.mule.api.MuleContext muleContext) Setter method for mule context.
void	setPartnerConnection(com.sforce.soap.partner.PartnerConnection partnerConnection) Setter method for { com.sforce.soap.partner.PartnerConnection}.
void	setProxyHost(String proxyHost) Setter method for proxy host.
void	setProxyPassword(String proxyPassword) Setter method for proxy password.
void	setProxyPort(String proxyPort) Setter method for proxy port.
void	setProxyUsername(String proxyUsername) Setter method for proxy username.
void	setReadTimeout(Integer readTimeout)
void	setTimeObjectStore(org.mule.api.store.ObjectStore<? extends Serializable> timeObjectStore)
void	setUseDefaultRule(Boolean useDefaultRule)
void	setUsername(String username)
org.mule.api.callback.StopSourceCallback	subscribe(SubscribeParams params)
protected void	validateApexClassesConfiguration()
protected void	validateCurrentSession()
protected void	validatePartnerConnection()
protected void	validateProxyConfiguration()
protected void	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.Config

getApiVersion

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

recreateSession

Field Detail

RECOMMENDED_API_VERSION

public static final double RECOMMENDED_API_VERSION

See Also:

Constant Field Values

Constructor Detail

AbstractConfig

public AbstractConfig()

Method Detail

isConnected

@ValidateConnection
public boolean isConnected()

Check if connection is already established.

Returns:

true if connection already established, false otherwise

destroySession

@Disconnect
public void destroySession()

End the current session

getUrls

@NotNull
public Map<String,String> getUrls()
                                    throws SalesforceException

Specified by:

getUrls in interface Config

Throws:

SalesforceException

getProxyHost

@Nullable
public String getProxyHost()

Getter method for proxy host.

Specified by:

getProxyHost in interface Config

Returns:

proxy host

setProxyHost

public void setProxyHost(String proxyHost)

Setter method for proxy host.

Parameters:

proxyHost - - proxy host

getProxyPort

public String getProxyPort()

Getter method for proxy port.

Specified by:

getProxyPort in interface Config

Returns:

proxy port

getProxyPortAsInteger

public Integer getProxyPortAsInteger()

setProxyPort

public void setProxyPort(String proxyPort)

Setter method for proxy port.

Parameters:

proxyPort - - proxy port

getProxyUsername

@Nullable
public String getProxyUsername()

Getter method for proxy username.

Specified by:

getProxyUsername in interface Config

Returns:

proxy username

setProxyUsername

public void setProxyUsername(String proxyUsername)

Setter method for proxy username.

Parameters:

proxyUsername - - proxy username

getProxyPassword

@Nullable
public String getProxyPassword()

Getter method for proxy password.

Specified by:

getProxyPassword in interface Config

Returns:

proxy password

setProxyPassword

public void setProxyPassword(String proxyPassword)

Setter method for proxy password.

Parameters:

proxyPassword - - proxy password

getMuleContext

public org.mule.api.MuleContext getMuleContext()

Getter method for mule context.

Returns:

mule context

setMuleContext

public void setMuleContext(org.mule.api.MuleContext muleContext)

Setter method for mule context.

Parameters:

muleContext - - mule context

getReadTimeout

public Integer getReadTimeout()

Description copied from interface: Config

Getter method for read timeout.

Specified by:

getReadTimeout in interface Config

Returns:

the readTimeout

setReadTimeout

public void setReadTimeout(Integer readTimeout)

Parameters:

readTimeout - the readTimeout to set

getConnectionTimeout

public Integer getConnectionTimeout()

Description copied from interface: Config

Getter method for connection timeout.

Specified by:

getConnectionTimeout in interface Config

Returns:

the connectionTimeout

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

Parameters:

connectionTimeout - the connectionTimeout to set

getPartnerConnection

public com.sforce.soap.partner.PartnerConnection getPartnerConnection()

Getter method for { com.sforce.soap.partner.PartnerConnection}.

Specified by:

getPartnerConnection in interface Config

Returns:

mule context

setPartnerConnection

public void setPartnerConnection(@NotNull
                                 com.sforce.soap.partner.PartnerConnection partnerConnection)
                          throws SalesforceException

Setter method for { com.sforce.soap.partner.PartnerConnection}.

Parameters:

partnerConnection - - partner connection instance to be set

Throws:

SalesforceException - if subscription fails

getClientId

public String getClientId()

Specified by:

getClientId in interface Config

setClientId

public void setClientId(String clientId)

Specified by:

setClientId in interface Config

getAssignmentRuleId

public String getAssignmentRuleId()

Specified by:

getAssignmentRuleId in interface Config

setAssignmentRuleId

public void setAssignmentRuleId(String assignmentRuleId)

Specified by:

setAssignmentRuleId in interface Config

getUseDefaultRule

public Boolean getUseDefaultRule()

Specified by:

getUseDefaultRule in interface Config

setUseDefaultRule

public void setUseDefaultRule(Boolean useDefaultRule)

Specified by:

setUseDefaultRule in interface Config

getAllowFieldTruncationSupport

public Boolean getAllowFieldTruncationSupport()

Specified by:

getAllowFieldTruncationSupport in interface Config

setAllowFieldTruncationSupport

public void setAllowFieldTruncationSupport(Boolean allowFieldTruncationSupport)

Specified by:

setAllowFieldTruncationSupport in interface Config

getApexClassNames

@NotNull
public List<String> getApexClassNames()

Getter method for apex class names.

Specified by:

getApexClassNames in interface Config

Returns:

list of apex class names

setApexClassNames

public void setApexClassNames(@Nullable
                              List<String> apexClassNames)

Setter method for apex class names.

Specified by:

setApexClassNames in interface Config

Parameters:

apexClassNames - - list of apex class names

getFetchAllApexSoapMetadata

public boolean getFetchAllApexSoapMetadata()

Specified by:

getFetchAllApexSoapMetadata in interface Config

Returns:

the fetchAllApexMetadata

setFetchAllApexSoapMetadata

public void setFetchAllApexSoapMetadata(boolean fetchAllApexMetadata)

Specified by:

setFetchAllApexSoapMetadata in interface Config

Parameters:

fetchAllApexMetadata - the fetchAllApexMetadata to set

getClearNullFields

public boolean getClearNullFields()

Returns:

clearNullFields

setClearNullFields

public void setClearNullFields(boolean clearNullFields)

Parameters:

clearNullFields - the clearNullFields value to set

getSessionId

@Nullable
public abstract String getSessionId()

Specified by:

getSessionId in interface SessionControl

verifyApiVersion

protected void verifyApiVersion()
                         throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

getFetchAllApexRestMetadata

public boolean getFetchAllApexRestMetadata()

Specified by:

getFetchAllApexRestMetadata in interface Config

Returns:

the fetchAllApexRestMetadata

setFetchAllApexRestMetadata

public void setFetchAllApexRestMetadata(boolean fetchAllApexRestMetadata)

Specified by:

setFetchAllApexRestMetadata in interface Config

Parameters:

fetchAllApexRestMetadata - the fetchAllApexRestMetadata to set

getUsername

public String getUsername()

Specified by:

getUsername in interface SessionControl

Returns:

the username

setUsername

public void setUsername(String username)

Parameters:

username - the username to be set

computeBaseUrl

@NotNull
public String computeBaseUrl(String url)
                               throws SalesforceException

Throws:

SalesforceException

getBulkConnection

@NotNull
public com.sforce.async.BulkConnection getBulkConnection()
                                                           throws SalesforceException

Specified by:

getBulkConnection in interface Config

Throws:

SalesforceException

validatePartnerConnection

protected void validatePartnerConnection()

validateApexClassesConfiguration

protected void validateApexClassesConfiguration()
                                         throws SalesforceException

Throws:

SalesforceException

validateCurrentSession

protected void validateCurrentSession()
                               throws SalesforceException

Throws:

SalesforceException

validateProxyConfiguration

protected void validateProxyConfiguration()
                                   throws SalesforceException

Throws:

SalesforceException

getApexClient

@NotNull
public final ApexClient getApexClient()
                                        throws SalesforceException

Getter method for apex client. This is the service class responsible for handling apex.

Specified by:

getApexClient in interface Config

Returns:

instance of apex client

Throws:

SalesforceException

getPushEventRestClient

public final PushEventRestClient getPushEventRestClient()
                                                 throws SalesforceException

Throws:

SalesforceException

getMetadataConnection

@NotNull
public final com.sforce.soap.metadata.MetadataConnection getMetadataConnection()
                                                                                 throws com.sforce.ws.ConnectionException

Specified by:

getMetadataConnection in interface Config

Throws:

com.sforce.ws.ConnectionException

logoutPartnerConnection

public void logoutPartnerConnection()
                             throws SalesforceException

Throws:

SalesforceException

isDisableSessionInvalidationActive

protected abstract boolean isDisableSessionInvalidationActive()

initConnectionConfig

protected void initConnectionConfig(@NotNull
                                    com.sforce.ws.ConnectorConfig connectorConfig)

setConnectionOptions

public void setConnectionOptions(@NotNull
                                 com.sforce.soap.partner.PartnerConnection connection)

Specified by:

setConnectionOptions in interface Config

subscribe

public org.mule.api.callback.StopSourceCallback subscribe(SubscribeParams params)
                                                   throws SalesforceException

Throws:

SalesforceException

getTimeObjectStore

public org.mule.api.store.ObjectStore<? extends Serializable> getTimeObjectStore()

Returns:

the timeObjectStore

setTimeObjectStore

public void setTimeObjectStore(org.mule.api.store.ObjectStore<? extends Serializable> timeObjectStore)

Parameters:

timeObjectStore - the timeObjectStore to set

getBatchSobjectMaxDepth

public Integer getBatchSobjectMaxDepth()

Returns:

the batchSobjectMaxDepth

setBatchSobjectMaxDepth

public void setBatchSobjectMaxDepth(Integer batchSobjectMaxDepth)

Parameters:

batchSobjectMaxDepth - the batchSobjectMaxDepth to set