public class

SalesforceOAuthConnectorOAuth2Adapter

extends SalesforceOAuthConnectorProcessAdapter
implements OAuth2Adapter OAuth2Connector

java.lang.Object
↳	org.mule.modules.salesforce.BaseSalesforceConnector
	↳	org.mule.modules.salesforce.SalesforceOAuthConnector
		↳	org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorCapabilitiesAdapter
			↳	org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorMetadataAdapater
				↳	org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorLifecycleAdapter
					↳	org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorProcessAdapter
						↳	org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorOAuth2Adapter

Class Overview

A SalesforceOAuthConnectorOAuth2Adapter is a wrapper around SalesforceOAuthConnector that adds OAuth capabilites to the pojo.

Summary

[Expand]

Inherited Constants

From class org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorMetadataAdapater

From interface org.mule.api.lifecycle.Disposable

From interface org.mule.api.lifecycle.Initialisable

From interface org.mule.api.lifecycle.Startable

From interface org.mule.api.lifecycle.Stoppable

Fields
private static final Pattern	ACCESS_CODE_PATTERN
private static final Pattern	EXPIRATION_TIME_PATTERN
private static final Logger	LOGGER
private static final Pattern	REFRESH_TOKEN_PATTERN
private String	accessTokenUrl
private String	authorizationUrl
private Date	expiration
private String	name
private OAuth2Manager<OAuth2Adapter>	oauthManager
private String	oauthVerifier
private OnNoTokenPolicy	onNoTokenPolicy
public String	redirectUri
private String	refreshToken

[Expand]

Inherited Fields

From class org.mule.modules.salesforce.SalesforceOAuthConnector

From class org.mule.modules.salesforce.BaseSalesforceConnector

Public Constructors
	SalesforceOAuthConnectorOAuth2Adapter(OAuth2Manager<OAuth2Adapter> oauthManager)

Public Methods
String	authorize(Map<String, String> extraParameters, String authorizationUrl, String redirectUri)
void	fetchAccessToken(String redirectUri)
Pattern	getAccessCodePattern() Retrieves ACCESS_CODE_PATTERN
String	getAccessTokenRegex()
String	getAccessTokenUrl() Retrieves accessTokenUrl
Set<AuthorizationParameter<?>>	getAuthorizationParameters()
String	getAuthorizationUrl() Retrieves authorizationUrl
String	getExpirationRegex()
Pattern	getExpirationTimePattern() Retrieves EXPIRATION_TIME_PATTERN
String	getName() Retrieves name
String	getOauthVerifier() Retrieves oauthVerifier
OnNoTokenPolicy	getOnNoTokenPolicy() Retrieves onNoTokenPolicy
<P> ProcessTemplate<P, SalesforceOAuthConnectorCapabilitiesAdapter>	getProcessTemplate()
String	getRefreshToken() Retrieves refreshToken
Pattern	getRefreshTokenPattern() Retrieves REFRESH_TOKEN_PATTERN
String	getRefreshTokenRegex()
String	getScope()
String	getVerifierRegex()
void	hasBeenAuthorized()
boolean	hasTokenExpired()
void	initialise()
void	postAuth()
void	refreshAccessToken(String accessTokenId)
void	reset()
void	setAccessTokenUrl(String value) Sets accessTokenUrl
void	setAuthorizationUrl(String value) Sets authorizationUrl
void	setExpiration(Date value) Sets expiration
void	setName(String value) Sets name
void	setOauthVerifier(String value) Sets oauthVerifier
void	setOnNoTokenPolicy(OnNoTokenPolicy value) Sets onNoTokenPolicy
void	setRefreshToken(String value) Sets refreshToken

[Expand]

Inherited Methods

From class org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorProcessAdapter

From class org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorLifecycleAdapter

From class org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorMetadataAdapater

From class org.mule.modules.salesforce.adapters.SalesforceOAuthConnectorCapabilitiesAdapter

From class org.mule.modules.salesforce.SalesforceOAuthConnector

From class org.mule.modules.salesforce.BaseSalesforceConnector

JobInfo	abortJob(String jobId) Aborts an open Job given its ID.
BatchInfo	batchInfo(BatchInfo batchInfo) Access latest BatchInfo of a submitted BatchInfo.
BatchResult	batchResult(BatchInfo batchInfo) Access com.sforce.async.BatchResult of a submitted BatchInfo.
InputStream	batchResultStream(BatchInfo batchInfo) Access com.sforce.async.BatchResult of a submitted BatchInfo.
JobInfo	closeJob(String jobId) Closes an open Job given its ID.
String	convertDateToString(Object object)
LeadConvertResult	convertLead(String leadId, String contactId, String accountId, Boolean overWriteLeadSource, Boolean doNotCreateOpportunity, String opportunityName, String convertedStatus, Boolean sendEmailToOwner) Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
List<SaveResult>	create(String type, List<Map<String, Object>> objects) Adds one or more new records to your organization's data.
BatchInfo	createBatch(JobInfo jobInfo, List<Map<String, Object>> objects) Creates a Batch using the given objects within the specified Job.
BatchInfo	createBatchForQuery(JobInfo jobInfo, String query) Creates a Batch using the given query.
BatchInfo	createBatchStream(JobInfo jobInfo, InputStream stream) Creates a Batch using the given stream within the specified Job.
BatchInfo	createBulk(String type, List<Map<String, Object>> objects) Adds one or more new records to your organization's data.
JobInfo	createJob(OperationEnum operation, String type, String externalIdFieldName, ContentType contentType, ConcurrencyMode concurrencyMode) Creates a Job in order to perform one or more batches through Bulk API Operations.
SaveResult	createSingle(String type, Map<String, Object> object) Adds one new records to your organization's data.
List<DeleteResult>	delete(List<String> ids) Deletes one or more records from your organization's data.
DescribeGlobalResult	describeGlobal() Retrieves a list of available objects for your organization's data.
DescribeSObjectResult	describeSObject(String type) Describes metadata (field list and object properties) for the specified object.
List<EmptyRecycleBinResult>	emptyRecycleBin(List<String> ids) The recycle bin lets you view and restore recently deleted records for 30 days before they are permanently deleted.
Boolean	getAllowFieldTruncationSupport()
String	getAssignmentRuleId()
SalesforceBayeuxClient	getBayeuxClient()
abstract BulkConnection	getBulkConnection()
String	getClientId()
abstract PartnerConnection	getConnection()
GetDeletedResult	getDeleted(String type, int duration) Retrieves the list of individual records that have been deleted between the range of now to the duration before now.
GetDeletedResult	getDeletedRange(String type, Calendar startTime, Calendar endTime) Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
Calendar	getServerTimestamp() Retrieves the current system timestamp (Coordinated Universal Time (UTC) time zone) from the API.
abstract String	getSessionId()
ObjectStore<? extends Serializable>	getTimeObjectStore()
GetUpdatedResult	getUpdated(String type, int duration) Retrieves the list of individual records that have been updated between the range of now to the duration before now.
List<Map<String, Object>>	getUpdatedObjects(String type, int initialTimeWindow, List<String> fields) Retrieves the list of records that have been updated between the last time this method was called and now.
GetUpdatedResult	getUpdatedRange(String type, Calendar startTime, Calendar endTime) Retrieves the list of individual records that have been created/updated within the given timespan for the specified object.
Boolean	getUseDefaultRule()
GetUserInfoResult	getUserInfo() Retrieves personal information for the user associated with the current session.
BatchInfo	hardDeleteBulk(String type, List<Map<String, Object>> objects) Deletes one or more records from your organization's data.
boolean	isDateField(Object object)
boolean	isInitializedBayeuxClient()
abstract boolean	isReadyToSubscribe()
QueryResultObject	paginatedQuery(String query, QueryResultObject queryResultObject, Boolean withDeletedRecords) Executes a paginated query against the specified object and returns data that matches the specified criteria.
void	processSubscriptions()
void	publishTopic(String topicName, String query, String description) Creates a topic which represents a query that is the basis for notifying listeners of changes to records in an organization.
PagingDelegate<Map<String, Object>>	query(String query, PagingConfiguration pagingConfiguration) Executes a query against the specified object and returns data that matches the specified criteria.
PagingDelegate<Map<String, Object>>	queryAll(String query, PagingConfiguration pagingConfiguration) Retrieves data from specified objects, whether or not they have been deleted.
InputStream	queryResultStream(BatchInfo batchInfo) Returns an InputStream with the query results of a submitted BatchInfo Internally the InputStreams contained in the sequence will be requested on-demand (lazy-loading)
Map<String, Object>	querySingle(String query) Executes a query against the specified object and returns the first record that matches the specified criteria.
void	resetUpdatedObjectsTimestamp(String type) Resets the timestamp of the last updated object.
List<Map<String, Object>>	retrieve(String type, List<String> ids, List<String> fields) Retrieves one or more records based on the specified IDs.
List<Map<String, Object>>	search(String query) Search for objects using Salesforce Object Search Language
void	setAllowFieldTruncationSupport(Boolean allowFieldTruncationSupport)
void	setAssignmentRuleId(String assignmentRuleId)
void	setBayeuxClient(SalesforceBayeuxClient bc)
void	setClientId(String clientId)
void	setConnectionOptions(PartnerConnection connection)
void	setMuleContext(MuleContext context)
void	setObjectStoreHelper(ObjectStoreHelper objectStoreHelper)
void	setObjectStoreManager(ObjectStoreManager objectStoreManager)
void	setPassword(String userId, String newPassword) Change the password of a User or SelfServiceUser to a value that you specify.
void	setRegistry(Registry registry)
void	setTimeObjectStore(ObjectStore<? extends Serializable> timeObjectStore)
void	setUseDefaultRule(Boolean useDefaultRule)
StopSourceCallback	subscribeTopic(String topic, SourceCallback callback) Subscribe to a topic.
SObject[]	toAsyncSObjectList(List<Map<String, Object>> objects)
String	toNativeQuery(DsqlQuery query)
SObject	toSObject(String type, Map<String, Object> map)
SObject[]	toSObjectList(String type, List<Map<String, Object>> objects)
Map<String, Object>	toSObjectMap(Map map) Enforce map keys are converted to String to comply with generic signature in toSObject
List<SaveResult>	update(String type, List<Map<String, Object>> objects) Updates one or more existing records in your organization's data.
BatchInfo	updateBulk(String type, List<Map<String, Object>> objects) Updates one or more existing records in your organization's data.
SaveResult	updateSingle(String type, Map<String, Object> object) Updates one or more existing records in your organization's data.
List<UpsertResult>	upsert(String externalIdFieldName, String type, List<Map<String, Object>> objects) Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.
BatchInfo	upsertBulk(String type, String externalIdFieldName, List<Map<String, Object>> objects) Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.

From class java.lang.Object

From interface org.mule.api.MetadataAware

From interface org.mule.api.NameableObject

From interface org.mule.api.NamedObject

From interface org.mule.api.context.MuleContextAware

From interface org.mule.api.devkit.ProcessAdapter

From interface org.mule.api.devkit.capability.Capabilities

From interface org.mule.api.lifecycle.Disposable

From interface org.mule.api.lifecycle.Initialisable

From interface org.mule.api.lifecycle.Startable

From interface org.mule.api.lifecycle.Stoppable

From interface org.mule.security.oauth.OAuth2Adapter

abstract String	authorize(Map<String, String> arg0, String arg1, String arg2)
abstract void	fetchAccessToken(String arg0)
abstract Pattern	getAccessCodePattern()
abstract String	getAccessToken()
abstract Pattern	getExpirationTimePattern()
abstract String	getRefreshToken()
abstract Pattern	getRefreshTokenPattern()
abstract boolean	hasTokenExpired()
abstract void	refreshAccessToken(String arg0)
abstract void	setConsumerKey(String arg0)
abstract void	setConsumerSecret(String arg0)
abstract void	setExpiration(Date arg0)
abstract void	setRefreshToken(String arg0)

From interface org.mule.security.oauth.OAuth2Connector

abstract String	getAccessToken()
abstract String	getAccessTokenRegex()
abstract String	getAccessTokenUrl()
abstract Set<AuthorizationParameter<?>>	getAuthorizationParameters()
abstract String	getAuthorizationUrl()
abstract String	getConsumerKey()
abstract String	getConsumerSecret()
abstract String	getExpirationRegex()
abstract String	getRefreshTokenRegex()
abstract String	getScope()
abstract String	getVerifierRegex()
abstract void	postAuth()

From interface org.mule.security.oauth.OAuthAdapter

From interface org.mule.security.oauth.OnNoTokenPolicyAware

Fields

private static final Pattern ACCESS_CODE_PATTERN

private static final Pattern EXPIRATION_TIME_PATTERN

private static final Logger LOGGER

private static final Pattern REFRESH_TOKEN_PATTERN

private String accessTokenUrl

private String authorizationUrl

private Date expiration

private String name

private OAuth2Manager<OAuth2Adapter> oauthManager

private String oauthVerifier

private OnNoTokenPolicy onNoTokenPolicy

public String redirectUri

private String refreshToken

Public Constructors

public SalesforceOAuthConnectorOAuth2Adapter (OAuth2Manager<OAuth2Adapter> oauthManager)

Parameters

oauthManager

Public Methods

public String authorize (Map<String, String> extraParameters, String authorizationUrl, String redirectUri)

Parameters

extraParameters
authorizationUrl
redirectUri

public void fetchAccessToken (String redirectUri)

Parameters

redirectUri

Throws

UnableToAcquireAccessTokenException

public Pattern getAccessCodePattern ()

Retrieves ACCESS_CODE_PATTERN

public String getAccessTokenRegex ()

public String getAccessTokenUrl ()

Retrieves accessTokenUrl

public Set<AuthorizationParameter<?>> getAuthorizationParameters ()

public String getAuthorizationUrl ()

Retrieves authorizationUrl

public String getExpirationRegex ()

public Pattern getExpirationTimePattern ()

Retrieves EXPIRATION_TIME_PATTERN

public String getName ()

Retrieves name

public String getOauthVerifier ()

Retrieves oauthVerifier

public OnNoTokenPolicy getOnNoTokenPolicy ()

Retrieves onNoTokenPolicy

public ProcessTemplate<P, SalesforceOAuthConnectorCapabilitiesAdapter> getProcessTemplate ()

public String getRefreshToken ()

Retrieves refreshToken

public Pattern getRefreshTokenPattern ()

Retrieves REFRESH_TOKEN_PATTERN

public String getRefreshTokenRegex ()

public String getScope ()

public String getVerifierRegex ()

public void hasBeenAuthorized ()

Throws

NotAuthorizedException

public boolean hasTokenExpired ()

public void initialise ()

Throws

InitialisationException

public void postAuth ()

Throws

Exception

public void refreshAccessToken (String accessTokenId)

Parameters

accessTokenId

Throws

UnableToAcquireAccessTokenException

public void reset ()

public void setAccessTokenUrl (String value)

Sets accessTokenUrl

Parameters

value	Value to set

public void setAuthorizationUrl (String value)

Sets authorizationUrl

Parameters

value	Value to set

public void setExpiration (Date value)

Sets expiration

Parameters

value	Value to set

public void setName (String value)

Sets name

Parameters

value	Value to set

public void setOauthVerifier (String value)

Sets oauthVerifier

Parameters

value	Value to set

public void setOnNoTokenPolicy (OnNoTokenPolicy value)

Sets onNoTokenPolicy

Parameters

value	Value to set

public void setRefreshToken (String value)

Sets refreshToken

Parameters

value	Value to set

Classes

SalesforceOAuthConnectorOAuth2Adapter

Class Overview

Summary

Fields

private static final Pattern ACCESS_CODE_PATTERN

private static final Pattern EXPIRATION_TIME_PATTERN

private static final Logger LOGGER

private static final Pattern REFRESH_TOKEN_PATTERN

private String accessTokenUrl

private String authorizationUrl

private Date expiration

private String name

private OAuth2Manager<OAuth2Adapter> oauthManager

private String oauthVerifier

private OnNoTokenPolicy onNoTokenPolicy

public String redirectUri

private String refreshToken

Public Constructors

public SalesforceOAuthConnectorOAuth2Adapter (OAuth2Manager<OAuth2Adapter> oauthManager)

Parameters

Public Methods

public String authorize (Map<String, String> extraParameters, String authorizationUrl, String redirectUri)

Parameters

public void fetchAccessToken (String redirectUri)

Parameters

Throws

public Pattern getAccessCodePattern ()

public String getAccessTokenRegex ()

public String getAccessTokenUrl ()

public Set<AuthorizationParameter<?>> getAuthorizationParameters ()

public String getAuthorizationUrl ()

public String getExpirationRegex ()

public Pattern getExpirationTimePattern ()

public String getName ()

public String getOauthVerifier ()

public OnNoTokenPolicy getOnNoTokenPolicy ()

public ProcessTemplate<P, SalesforceOAuthConnectorCapabilitiesAdapter> getProcessTemplate ()

public String getRefreshToken ()

public Pattern getRefreshTokenPattern ()

public String getRefreshTokenRegex ()

public String getScope ()

public String getVerifierRegex ()

public void hasBeenAuthorized ()

Throws

public boolean hasTokenExpired ()

public void initialise ()

Throws

public void postAuth ()

Throws

public void refreshAccessToken (String accessTokenId)

Parameters

Throws

public void reset ()

public void setAccessTokenUrl (String value)

Parameters

public void setAuthorizationUrl (String value)

Parameters

public void setExpiration (Date value)

Parameters

public void setName (String value)

Parameters

public void setOauthVerifier (String value)

Parameters

public void setOnNoTokenPolicy (OnNoTokenPolicy value)

Parameters

public void setRefreshToken (String value)

Parameters