public class

GoogleSpreadSheetConnectorOAuth2Adapter

extends GoogleSpreadSheetConnectorProcessAdapter
implements OAuth2Adapter OAuth2Connector

java.lang.Object
↳	org.mule.modules.google.AbstractGoogleOAuthConnector
	↳	org.mule.module.google.spreadsheet.GoogleSpreadSheetConnector
		↳	org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorCapabilitiesAdapter
			↳	org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorMetadataAdapater
				↳	org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorLifecycleAdapter
					↳	org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorProcessAdapter
						↳	org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorOAuth2Adapter

Class Overview

A GoogleSpreadSheetConnectorOAuth2Adapter is a wrapper around GoogleSpreadSheetConnector that adds OAuth capabilites to the pojo.

Summary

[Expand]

Inherited Constants

From class org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorMetadataAdapater

From class org.mule.modules.google.AbstractGoogleOAuthConnector

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.module.google.spreadsheet.GoogleSpreadSheetConnector

From class org.mule.modules.google.AbstractGoogleOAuthConnector

Public Constructors
	GoogleSpreadSheetConnectorOAuth2Adapter(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, GoogleSpreadSheetConnectorCapabilitiesAdapter>	getProcessTemplate()
String	getRefreshToken() Retrieves refreshToken
Pattern	getRefreshTokenPattern() Retrieves REFRESH_TOKEN_PATTERN
String	getRefreshTokenRegex()
String	getVerifierRegex()
void	hasBeenAuthorized()
boolean	hasTokenExpired()
void	initialise()
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.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorProcessAdapter

From class org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorLifecycleAdapter

From class org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorMetadataAdapater

From class org.mule.module.google.spreadsheet.adapters.GoogleSpreadSheetConnectorCapabilitiesAdapter

From class org.mule.module.google.spreadsheet.GoogleSpreadSheetConnector

void	createSpreadsheet(String title) Creates a new spreadsheet using a given title
Worksheet	createWorksheet(String spreadsheet, int spreadsheetIndex, String title, int rowCount, int colCount) Creates a new worksheet for an specified spreadsheet
void	deleteWorksheet(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex) Deletes an specified worksheet
String	getAccessToken()
List<Row>	getAllCells(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex) Returns a list of `Row` in which each entry represents one of the initialized cells on a worksheet
String	getAllCellsAsCsv(String spreadsheet, String worksheet, String columnSeparator, String lineSeparator, int spreadsheetIndex, int worksheetIndex) Returns a CSV file representing all the initialized cells in a worksheet.
List<Spreadsheet>	getAllSpreadsheets() Returns all the spreadsheets associated with the user's account
List<Worksheet>	getAllWorksheets(String spreadsheet, int spreadsheetIndex) Lists all the worksheets contained in an specified spreadsheet
String	getApplicationName()
List<Person>	getAuthors(String spreadsheet, int spreadsheetIndex) Returns a list of com.google.gdata.data.Person where each entry represent a a contributor on a specified spreadsheet
List<Row>	getCellRange(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex, Integer minRow, Integer maxRow, Integer minCol, Integer maxCol) Returns a list of `Row` containing the cells contained in a given range
String	getCellRangeAsCsv(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex, String columnSeparator, String lineSeparator, Integer minRow, Integer maxRow, Integer minCol, Integer maxCol) Returns a CSV file representing the requested cell range.
Object	getClient()
Row	getColumnHeaders(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex) This processor returns the a worksheet's first row
String	getConsumerKey()
String	getConsumerSecret()
String	getScope()
List<Spreadsheet>	getSpreadsheetsByTitle(String title) Returns a list of `Spreadsheet` with all the spreadsheets associated with the user which title matches the one specified.
List<Worksheet>	getWorksheetByTitle(String spreadsheet, String title, int spreadsheetIndex) Returns a list of `Worksheet` which title matches the one specified.
void	postAuth()
void	purgeWorksheet(String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex) This processors deletes all the cell entries of a specified worksheet.
List<Row>	search(String spreadsheet, String worksheet, String query, int spreadsheetIndex, int worksheetIndex) Performs a full-text search on a worksheet and returns a list of `Row` in which each entry represent a cell containing a matching value
void	setAccessToken(String accessToken)
void	setApplicationName(String applicationName)
void	setConsumerKey(String consumerKey)
void	setConsumerSecret(String consumerSecret)
void	setCsvValues(String spreadsheet, String worksheet, String csv, int startingRow, int startingColumn, String lineSeparator, String columnSeparator, int spreadsheetIndex, int worksheetIndex, boolean purge) Performs a batch update of a worksheet's cells taking values from a csv String.
void	setDocService(DocsService docService)
void	setRowValues(List<Row> rows, String spreadsheet, String worksheet, int spreadsheetIndex, int worksheetIndex, boolean purge) Performs a batch update of a worksheet's cells taking values from a list of `Row` taken from the message payload.
void	setScope(String scope)
void	setSpreadsheetService(SpreadsheetService spreadsheetService)
void	updateWorksheetMetadata(String spreadsheet, String worksheet, String title, Boolean draft, Boolean canEdit, String summary, int rowCount, int colCount, int spreadsheetIndex, int worksheetIndex) This processor allows updating a worksheet's metadata, constituted by its title, dimensions, summary, draft and editability status.

From class org.mule.modules.google.AbstractGoogleOAuthConnector

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 GoogleSpreadSheetConnectorOAuth2Adapter (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, GoogleSpreadSheetConnectorCapabilitiesAdapter> getProcessTemplate ()

public String getRefreshToken ()

Retrieves refreshToken

public Pattern getRefreshTokenPattern ()

Retrieves REFRESH_TOKEN_PATTERN

public String getRefreshTokenRegex ()

public String getVerifierRegex ()

public void hasBeenAuthorized ()

Throws

NotAuthorizedException

public boolean hasTokenExpired ()

public void initialise ()

Throws

InitialisationException

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

GoogleSpreadSheetConnectorOAuth2Adapter

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 GoogleSpreadSheetConnectorOAuth2Adapter (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, GoogleSpreadSheetConnectorCapabilitiesAdapter> getProcessTemplate ()

public String getRefreshToken ()

public Pattern getRefreshTokenPattern ()

public String getRefreshTokenRegex ()

public String getVerifierRegex ()

public void hasBeenAuthorized ()

Throws

public boolean hasTokenExpired ()

public void initialise ()

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