Inheritance diagram for OauthService:

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, ConsumerFactory $consumerFactory, TokenFactory $tokenFactory, IntegrationOauthHelper $dataHelper, \Magento\Framework\HTTP\ZendClient $httpClient, \Psr\Log\LoggerInterface $logger, OauthHelper $oauthHelper, TokenProvider $tokenProvider)

	createConsumer ($consumerData)

	createAccessToken ($consumerId, $clearExistingToken=false)

	getAccessToken ($consumerId)

	loadConsumer ($consumerId)

	loadConsumerByKey ($key)

	postToConsumer ($consumerId, $endpointUrl)

	deleteConsumer ($consumerId)

	deleteIntegrationToken ($consumerId)

Protected Member Functions
	_loadConsumerById ($consumerId)

Protected Attributes
	$_storeManager

	$_consumerFactory

	$_tokenFactory

	$_dataHelper

	$_httpClient

	$_logger

	$_oauthHelper

	$_tokenProvider

Detailed Description

Integration oAuth service.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file OauthService.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		ConsumerFactory	$consumerFactory,
		TokenFactory	$tokenFactory,
		IntegrationOauthHelper	$dataHelper,
		\Magento\Framework\HTTP\ZendClient	$httpClient,
		\Psr\Log\LoggerInterface	$logger,
		OauthHelper	$oauthHelper,
		TokenProvider	$tokenProvider
	)

Initialize dependencies.

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
ConsumerFactory	$consumerFactory
TokenFactory	$tokenFactory
IntegrationOauthHelper	$dataHelper
\Magento\Framework\HTTP\ZendClient	$httpClient
\Psr\Log\LoggerInterface	$logger
OauthHelper	$oauthHelper
TokenProvider	$tokenProvider

Definition at line 82 of file OauthService.php.

       {
         $this->_storeManager = $storeManager;
         $this->_consumerFactory = $consumerFactory;
         $this->_tokenFactory = $tokenFactory;
         $this->_dataHelper = $dataHelper;
         $this->_httpClient = $httpClient;
         $this->_logger = $logger;
         $this->_oauthHelper = $oauthHelper;
         $this->_tokenProvider = $tokenProvider;
     }

Member Function Documentation

◆ _loadConsumerById()

_loadConsumerById ( $consumerId )

protected

Load consumer by id.

Parameters

int $consumerId

Returns: ConsumerModel

Exceptions

Definition at line 289 of file OauthService.php.

     {
         $consumer = $this->_consumerFactory->create()->load($consumerId);
         if (!$consumer->getId()) {
             throw new IntegrationException(
                 __('A consumer with ID "%1" doesn\'t exist. Verify the ID and try again.', $consumerId)
             );
         }
         return $consumer;
     }

◆ createAccessToken()

createAccessToken	(	$consumerId,
		$clearExistingToken = `false`
	)

{Create access token for provided consumer.

Parameters

int	$consumerId
bool	$clearExistingToken

Returns: bool If token was created

}

Implements OauthServiceInterface.

Definition at line 143 of file OauthService.php.

     {
         try {
             $consumer = $this->_consumerFactory->create()->load($consumerId);
             $existingToken = $this->_tokenProvider->getIntegrationTokenByConsumerId($consumer->getId());
             if ($existingToken && $clearExistingToken) {
                 $existingToken->delete();
                 unset($existingToken);
             }
         } catch (\Exception $e) {
         }
         if (!isset($existingToken)) {
             $consumer = $this->_consumerFactory->create()->load($consumerId);
             $this->_tokenFactory->create()->createVerifierToken($consumerId);
             $this->_tokenProvider->createRequestToken($consumer);
             $this->_tokenProvider->getAccessToken($consumer);
             return true;
         }
         return false;
     }

◆ createConsumer()

createConsumer ( $consumerData )

{Create a new consumer account.

Parameters

array

$consumerData

- Information provided by an integration when the integration is installed.

array(
    'name' => 'Integration Name',
    '...' => '...', // Other consumer data can be passed as well
)

Returns: \Magento\Integration\Model\Oauth\Consumer

Exceptions

}

Implements OauthServiceInterface.

Definition at line 121 of file OauthService.php.

     {
         try {
             $consumerData['key'] = $this->_oauthHelper->generateConsumerKey();
             $consumerData['secret'] = $this->_oauthHelper->generateConsumerSecret();
             $consumer = $this->_consumerFactory->create()->setData($consumerData);
             $consumer->save();
             return $consumer;
         } catch (\Magento\Framework\Exception\LocalizedException $exception) {
             throw $exception;
         } catch (\Exception $exception) {
             throw new \Magento\Framework\Oauth\Exception(
                 __(
                     "The oAuth consumer account couldn't be created due to an unexpected error. Please try again later."
                 )
             );
         }
     }

◆ deleteConsumer()

deleteConsumer ( $consumerId )

{Delete the consumer data associated with the integration including its token and nonce

Parameters

int $consumerId

Returns: array Consumer data array

}

Implements OauthServiceInterface.

Definition at line 259 of file OauthService.php.

     {
         $consumer = $this->_loadConsumerById($consumerId);
         $data = $consumer->getData();
         $consumer->delete();
         return $data;
     }

◆ deleteIntegrationToken()

deleteIntegrationToken ( $consumerId )

{Remove token associated with provided consumer.

Parameters

int $consumerId

Returns: bool If token was deleted

}

Implements OauthServiceInterface.

Definition at line 270 of file OauthService.php.

     {
         try {
             $consumer = $this->_consumerFactory->create()->load($consumerId);
             $existingToken = $this->_tokenProvider->getIntegrationTokenByConsumerId($consumer->getId());
             $existingToken->delete();
             return true;
         } catch (\Exception $e) {
             return false;
         }
     }

◆ getAccessToken()

getAccessToken ( $consumerId )

{Retrieve access token assigned to the consumer.

Parameters

int $consumerId

Returns: OauthTokenModel|bool Return false if no access token is available.

}

Implements OauthServiceInterface.

Definition at line 167 of file OauthService.php.

     {
         try {
             $consumer = $this->_consumerFactory->create()->load($consumerId);
             $token = $this->_tokenProvider->getIntegrationTokenByConsumerId($consumer->getId());
             if ($token->getType() != OauthTokenModel::TYPE_ACCESS) {
                 return false;
             }
         } catch (\Exception $e) {
             return false;
         }
         return $token;
     }

◆ loadConsumer()

loadConsumer ( $consumerId )

{Load consumer by its ID.

Parameters

int $consumerId

Returns: \Magento\Integration\Model\Oauth\Consumer

Exceptions

}

Implements OauthServiceInterface.

Definition at line 184 of file OauthService.php.

     {
         try {
             return $this->_consumerFactory->create()->load($consumerId);
         } catch (\Magento\Framework\Exception\LocalizedException $exception) {
             throw $exception;
         } catch (\Exception $exception) {
             throw new \Magento\Framework\Oauth\Exception(
                 __("The oAuth consumer account couldn't be loaded due to an unexpected error. Please try again later.")
             );
         }
     }

◆ loadConsumerByKey()

loadConsumerByKey ( $key )

{Load consumer by its key.

Parameters

string $key

Returns: \Magento\Integration\Model\Oauth\Consumer

Exceptions

}

Implements OauthServiceInterface.

Definition at line 200 of file OauthService.php.

     {
         try {
             return $this->_consumerFactory->create()->load($key, 'key');
         } catch (\Magento\Framework\Exception\LocalizedException $exception) {
             throw $exception;
         } catch (\Exception $exception) {
             throw new \Magento\Framework\Oauth\Exception(
                 __("The oAuth consumer account couldn't be loaded due to an unexpected error. Please try again later.")
             );
         }
     }

◆ postToConsumer()

postToConsumer	(	$consumerId,
		$endpointUrl
	)

{Execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier.

Parameters

int	$consumerId	- The consumer Id.
string	$endpointUrl	- The integration endpoint Url (for HTTP Post)

Returns: string - The oauth_verifier.

Exceptions

}

Implements OauthServiceInterface.

Definition at line 216 of file OauthService.php.

     {
         try {
             $consumer = $this->loadConsumer($consumerId);
             $consumer->setUpdatedAt($this->getDateHelper()->gmtDate());
             $consumer->save();
             if (!$consumer->getId()) {
                 throw new \Magento\Framework\Oauth\Exception(
                     __('A consumer with "%1" ID doesn\'t exist. Verify the ID and try again.', $consumerId)
                 );
             }
             $consumerData = $consumer->getData();
             $verifier = $this->_tokenFactory->create()->createVerifierToken($consumerId);
             $storeBaseUrl = $this->_storeManager->getStore()->getBaseUrl();
             $this->_httpClient->setUri($endpointUrl);
             $this->_httpClient->setParameterPost(
                 [
                     'oauth_consumer_key' => $consumerData['key'],
                     'oauth_consumer_secret' => $consumerData['secret'],
                     'store_base_url' => $storeBaseUrl,
                     'oauth_verifier' => $verifier->getVerifier(),
                 ]
             );
             $maxredirects = $this->_dataHelper->getConsumerPostMaxRedirects();
             $timeout = $this->_dataHelper->getConsumerPostTimeout();
             $this->_httpClient->setConfig(['maxredirects' => $maxredirects, 'timeout' => $timeout]);
             $this->_httpClient->request(\Magento\Framework\HTTP\ZendClient::POST);
             return $verifier->getVerifier();
         } catch (\Magento\Framework\Exception\LocalizedException $exception) {
             throw $exception;
         } catch (\Magento\Framework\Oauth\Exception $exception) {
             throw $exception;
         } catch (\Exception $exception) {
             $this->_logger->critical($exception);
             throw new \Magento\Framework\Oauth\Exception(
                 __('The attempt to post data to consumer failed due to an unexpected error. Please try again later.')
             );
         }
     }

Field Documentation

◆ $_consumerFactory

$_consumerFactory

protected

Definition at line 33 of file OauthService.php.

◆ $_dataHelper

$_dataHelper

protected

Definition at line 43 of file OauthService.php.

◆ $_httpClient

$_httpClient

protected

Definition at line 48 of file OauthService.php.

◆ $_logger

$_logger

protected

Definition at line 53 of file OauthService.php.

◆ $_oauthHelper

$_oauthHelper

protected

Definition at line 58 of file OauthService.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 28 of file OauthService.php.

◆ $_tokenFactory

$_tokenFactory

protected

Definition at line 38 of file OauthService.php.

◆ $_tokenProvider

$_tokenProvider

protected

Definition at line 63 of file OauthService.php.

The documentation for this class was generated from the following file:

vendor/magento/module-integration/Model/OauthService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _loadConsumerById()

◆ createAccessToken()

◆ createConsumer()

◆ deleteConsumer()

◆ deleteIntegrationToken()

◆ getAccessToken()

◆ loadConsumer()

◆ loadConsumerByKey()

◆ postToConsumer()

Field Documentation

◆ $_consumerFactory

◆ $_dataHelper

◆ $_httpClient

◆ $_logger

◆ $_oauthHelper

◆ $_storeManager

◆ $_tokenFactory

◆ $_tokenProvider