org.mule.modules.box.adapters

Class BoxConnectorOAuth2Adapter

java.lang.Object

org.mule.modules.box.BoxConnector

org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter

org.mule.modules.box.generated.adapters.BoxConnectorMetadataAdapter

org.mule.modules.box.generated.adapters.BoxConnectorLifecycleInjectionAdapter

org.mule.modules.box.generated.adapters.BoxConnectorProcessAdapter

org.mule.modules.box.adapters.BoxConnectorOAuth2Adapter

All Implemented Interfaces:

Serializable, org.mule.api.context.MuleContextAware, org.mule.api.devkit.capability.Capabilities, org.mule.api.devkit.ProcessAdapter<org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter>, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.MetadataAware, org.mule.api.NameableObject, org.mule.api.NamedObject, org.mule.security.oauth.OAuth2Adapter, org.mule.security.oauth.OAuth2Connector, org.mule.security.oauth.OAuthAdapter, org.mule.security.oauth.OnNoTokenPolicyAware

@Generated(value="Mule DevKit Version 3.9.0",
           date="2017-08-04T05:03:02-03:00",
           comments="Build UNNAMED.2793.f49b6c7")
public class BoxConnectorOAuth2Adapter
extends org.mule.modules.box.generated.adapters.BoxConnectorProcessAdapter
implements org.mule.security.oauth.OAuth2Adapter

A BoxConnectorOAuth2Adapter is a wrapper around BoxConnector that adds OAuth capabilites to the pojo.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	redirectUri

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
BoxConnectorOAuth2Adapter(org.mule.security.oauth.OAuth2Manager<org.mule.security.oauth.OAuth2Adapter> oauthManager)

Method Summary

Methods

Modifier and Type	Method and Description
String	authorize(Map<String,String> extraParameters, String authorizationUrl, String redirectUri)
void	fetchAccessToken(String redirectUri)
Pattern	getAccessCodePattern() Retrieves ACCESS_CODE_PATTERN
String	getAccessToken()
String	getAccessTokenRegex()
String	getAccessTokenUrl() Retrieves accessTokenUrl
Set<org.mule.common.security.oauth.AuthorizationParameter<?>>	getAuthorizationParameters()
String	getAuthorizationUrl() Retrieves authorizationUrl
String	getConsumerKey()
String	getConsumerSecret()
String	getExpirationRegex()
Pattern	getExpirationTimePattern() Retrieves EXPIRATION_TIME_PATTERN
String	getName() Retrieves name
String	getOauthVerifier() Retrieves oauthVerifier
org.mule.security.oauth.OnNoTokenPolicy	getOnNoTokenPolicy() Retrieves onNoTokenPolicy
<P> org.mule.api.devkit.ProcessTemplate<P,org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter>	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	setAccessToken(String value)
void	setAccessTokenUrl(String value) Sets accessTokenUrl
void	setAuthorizationUrl(String value) Sets authorizationUrl
void	setConsumerKey(String value)
void	setConsumerSecret(String value)
void	setExpiration(Date value) Sets expiration
void	setName(String value) Sets name
void	setOauthVerifier(String value) Sets oauthVerifier
void	setOnNoTokenPolicy(org.mule.security.oauth.OnNoTokenPolicy value) Sets onNoTokenPolicy
void	setRefreshToken(String value) Sets refreshToken

Methods inherited from class org.mule.modules.box.generated.adapters.BoxConnectorLifecycleInjectionAdapter

dispose, setMuleContext, start, stop

Methods inherited from class org.mule.modules.box.generated.adapters.BoxConnectorMetadataAdapter

getDevkitBuild, getDevkitVersion, getMinMuleVersion, getModuleName, getModuleVersion

Methods inherited from class org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter

isCapableOf

Methods inherited from class org.mule.modules.box.BoxConnector

addCommentToFile, addGroupMembership, addTaskAssignment, addTaskToFile, copyFile, copyFolder, createAppUser, createCollaboration, createFolder, createGroup, createSharedLinkFile, createSharedLinkFolder, deleteCollaboration, deleteComment, deleteFile, deleteFolder, deleteGroup, deleteGroupMembership, deleteOldFileVersion, deleteTask, deleteTaskAssignment, deleteUser, downloadFile, downloadFileVersion, fullSearch, getAllGroups, getAssignmentClient, getCollaborationInfo, getCommentInfo, getConfig, getCurrentUser, getDownloadURL, getEnterpriseUsers, getFileComments, getFileInfo, getFilePreviewLink, getFileTasks, getFileVersions, getFolderCollaborations, getFolderInfo, getFolderItems, getGroupClient, getGroupInfo, getGroupMembership, getGroupMemberships, getMembershipClient, getPendingCollaborations, getTaskAssignmentInfo, getTaskAssignments, getTaskClient, getTaskInfo, getThumbnail, getTrashedFile, getTrashedFolder, getTrashedItems, getUserClient, getUserGroupMemberships, getUserInfo, moveFolderToUser, permanentlyDeleteFile, permanentlyDeleteFolder, promoteFileVersion, replyToComment, restoreFile, restoreFolder, search, setConfig, updateCollaboration, updateComment, updateFileInfo, updateFolder, updateGroupMembership, updateTaskAssignmentInfo, updateTaskInfo, updateUserInfo, uploadFile, uploadNewVersion, validate, validateFields

Methods inherited from class java.lang.Object

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

Field Detail

redirectUri

public String redirectUri

Constructor Detail

BoxConnectorOAuth2Adapter

public BoxConnectorOAuth2Adapter(org.mule.security.oauth.OAuth2Manager<org.mule.security.oauth.OAuth2Adapter> oauthManager)

Method Detail

getAccessCodePattern

public Pattern getAccessCodePattern()

Retrieves ACCESS_CODE_PATTERN

Specified by:

getAccessCodePattern in interface org.mule.security.oauth.OAuth2Adapter

getRefreshTokenPattern

public Pattern getRefreshTokenPattern()

Retrieves REFRESH_TOKEN_PATTERN

Specified by:

getRefreshTokenPattern in interface org.mule.security.oauth.OAuth2Adapter

getExpirationTimePattern

public Pattern getExpirationTimePattern()

Retrieves EXPIRATION_TIME_PATTERN

Specified by:

getExpirationTimePattern in interface org.mule.security.oauth.OAuth2Adapter

getName

public String getName()

Retrieves name

Specified by:

getName in interface org.mule.api.NamedObject

setName

public void setName(String value)

Sets name

Specified by:

setName in interface org.mule.api.NameableObject

Parameters:

value - Value to set

getOnNoTokenPolicy

public org.mule.security.oauth.OnNoTokenPolicy getOnNoTokenPolicy()

Retrieves onNoTokenPolicy

Specified by:

getOnNoTokenPolicy in interface org.mule.security.oauth.OnNoTokenPolicyAware

setOnNoTokenPolicy

public void setOnNoTokenPolicy(org.mule.security.oauth.OnNoTokenPolicy value)

Sets onNoTokenPolicy

Specified by:

setOnNoTokenPolicy in interface org.mule.security.oauth.OnNoTokenPolicyAware

Parameters:

value - Value to set

getOauthVerifier

public String getOauthVerifier()

Retrieves oauthVerifier

Specified by:

getOauthVerifier in interface org.mule.security.oauth.OAuthAdapter

setOauthVerifier

public void setOauthVerifier(String value)

Sets oauthVerifier

Specified by:

setOauthVerifier in interface org.mule.security.oauth.OAuthAdapter

Parameters:

value - Value to set

getRefreshToken

public String getRefreshToken()

Retrieves refreshToken

Specified by:

getRefreshToken in interface org.mule.security.oauth.OAuth2Adapter

setRefreshToken

public void setRefreshToken(String value)

Sets refreshToken

Specified by:

setRefreshToken in interface org.mule.security.oauth.OAuth2Adapter

Parameters:

value - Value to set

setAuthorizationUrl

public void setAuthorizationUrl(String value)

Sets authorizationUrl

Specified by:

setAuthorizationUrl in interface org.mule.security.oauth.OAuthAdapter

Parameters:

value - Value to set

getAuthorizationUrl

public String getAuthorizationUrl()

Retrieves authorizationUrl

Specified by:

getAuthorizationUrl in interface org.mule.security.oauth.OAuth2Connector

setAccessTokenUrl

public void setAccessTokenUrl(String value)

Sets accessTokenUrl

Specified by:

setAccessTokenUrl in interface org.mule.security.oauth.OAuthAdapter

Parameters:

value - Value to set

getAccessTokenUrl

public String getAccessTokenUrl()

Retrieves accessTokenUrl

Specified by:

getAccessTokenUrl in interface org.mule.security.oauth.OAuth2Connector

setExpiration

public void setExpiration(Date value)

Sets expiration

Specified by:

setExpiration in interface org.mule.security.oauth.OAuth2Adapter

Parameters:

value - Value to set

initialise

public void initialise()
                throws org.mule.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.api.lifecycle.Initialisable

Overrides:

initialise in class org.mule.modules.box.generated.adapters.BoxConnectorProcessAdapter

Throws:

org.mule.api.lifecycle.InitialisationException

authorize

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

Specified by:

authorize in interface org.mule.security.oauth.OAuth2Adapter

fetchAccessToken

public void fetchAccessToken(String redirectUri)
                      throws org.mule.common.security.oauth.exception.UnableToAcquireAccessTokenException

Specified by:

fetchAccessToken in interface org.mule.security.oauth.OAuth2Adapter

Throws:

org.mule.common.security.oauth.exception.UnableToAcquireAccessTokenException

refreshAccessToken

public void refreshAccessToken(String accessTokenId)
                        throws org.mule.common.security.oauth.exception.UnableToAcquireAccessTokenException

Specified by:

refreshAccessToken in interface org.mule.security.oauth.OAuth2Adapter

Throws:

org.mule.common.security.oauth.exception.UnableToAcquireAccessTokenException

hasTokenExpired

public boolean hasTokenExpired()

Specified by:

hasTokenExpired in interface org.mule.security.oauth.OAuth2Adapter

reset

public void reset()

hasBeenAuthorized

public void hasBeenAuthorized()
                       throws org.mule.common.security.oauth.exception.NotAuthorizedException

Specified by:

hasBeenAuthorized in interface org.mule.security.oauth.OAuthAdapter

Throws:

org.mule.common.security.oauth.exception.NotAuthorizedException

getAuthorizationParameters

public Set<org.mule.common.security.oauth.AuthorizationParameter<?>> getAuthorizationParameters()

Specified by:

getAuthorizationParameters in interface org.mule.security.oauth.OAuth2Connector

getConsumerKey

public String getConsumerKey()

Specified by:

getConsumerKey in interface org.mule.security.oauth.OAuth2Connector

setConsumerKey

public void setConsumerKey(String value)

Specified by:

setConsumerKey in interface org.mule.security.oauth.OAuth2Adapter

getConsumerSecret

public String getConsumerSecret()

Specified by:

getConsumerSecret in interface org.mule.security.oauth.OAuth2Connector

setConsumerSecret

public void setConsumerSecret(String value)

Specified by:

setConsumerSecret in interface org.mule.security.oauth.OAuth2Adapter

getAccessToken

public String getAccessToken()

Specified by:

getAccessToken in interface org.mule.security.oauth.OAuth2Adapter

Specified by:

getAccessToken in interface org.mule.security.oauth.OAuth2Connector

setAccessToken

public void setAccessToken(String value)

Specified by:

setAccessToken in interface org.mule.security.oauth.OAuthAdapter

getScope

public String getScope()

Specified by:

getScope in interface org.mule.security.oauth.OAuth2Connector

postAuth

public void postAuth()
              throws Exception

Specified by:

postAuth in interface org.mule.security.oauth.OAuth2Connector

Throws:

Exception

getProcessTemplate

public <P> org.mule.api.devkit.ProcessTemplate<P,org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter> getProcessTemplate()

Specified by:

getProcessTemplate in interface org.mule.api.devkit.ProcessAdapter<org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter>

Overrides:

getProcessTemplate in class org.mule.modules.box.generated.adapters.BoxConnectorProcessAdapter

getAccessTokenRegex

public String getAccessTokenRegex()

Specified by:

getAccessTokenRegex in interface org.mule.security.oauth.OAuth2Connector

getExpirationRegex

public String getExpirationRegex()

Specified by:

getExpirationRegex in interface org.mule.security.oauth.OAuth2Connector

getRefreshTokenRegex

public String getRefreshTokenRegex()

Specified by:

getRefreshTokenRegex in interface org.mule.security.oauth.OAuth2Connector

getVerifierRegex

public String getVerifierRegex()

Specified by:

getVerifierRegex in interface org.mule.security.oauth.OAuth2Connector