Page MenuHomePhabricator

final class PhutilJIRAAuthAdapter
Phabricator Technical Documentation (Auth)

Authentication adapter for JIRA OAuth1.

Methods

final public function getAccountIdentifiers()
Inherited

This method is not documented.
Return
wild

protected function newAccountIdentifiers()

This method is not documented.
Return
wild

final protected function newAccountIdentifier($raw_identifier)
Inherited

This method is not documented.
Parameters
$raw_identifier
Return
wild

public function getAccountID()
Inherited

PhutilAuthAdapter

Get a unique identifier associated with the account.

This identifier should be permanent, immutable, and uniquely identify the account. If possible, it should be nonsensitive. For providers that have a GUID or PHID value for accounts, these are the best values to use.

You can implement newAccountIdentifiers() instead if a provider is unable to emit identifiers with all of these properties.

If the adapter was unable to authenticate an identity, it should return null.

Return
string|nullUnique account identifier, or `null` if authentication failed.

public function getAdapterType()

PhutilAuthAdapter

Get a string identifying this adapter, like "ldap". This string should be unique to the adapter class.

PhutilJIRAAuthAdapter
This method is not documented.
Return
stringUnique adapter identifier.

public function getAdapterDomain()

PhutilAuthAdapter

Get a string identifying the domain this adapter is acting on. This allows an adapter (like LDAP) to act against different identity domains without conflating credentials. For providers like Facebook or Google, the adapters just return the relevant domain name.

PhutilJIRAAuthAdapter
This method is not documented.
Return
stringDomain the adapter is associated with.

public function getAdapterKey()
Inherited

PhutilAuthAdapter

Generate a string uniquely identifying this adapter configuration. Within the scope of a given key, all account IDs must uniquely identify exactly one identity.

Return
stringUnique identifier for this adapter configuration.

public function getAccountEmail()

PhutilAuthAdapter

Optionally, return an email address associated with this account.

PhutilJIRAAuthAdapter
This method is not documented.
Return
string|nullAn email address associated with the account, or `null` if data is not available.

public function getAccountName()

PhutilAuthAdapter

Optionally, return a human readable username associated with this account.

PhutilJIRAAuthAdapter
This method is not documented.
Return
string|nullAccount username, or `null` if data isn't available.

public function getAccountURI()
Inherited

PhutilAuthAdapter

Optionally, return a URI corresponding to a human-viewable profile for this account.

Return
string|nullA profile URI associated with this account, or `null` if the data isn't available.

public function getAccountImageURI()

PhutilAuthAdapter

Optionally, return a profile image URI associated with this account.

PhutilJIRAAuthAdapter
This method is not documented.
Return
string|nullURI for an account profile image, or `null` if one is not available.

public function getAccountRealName()

PhutilAuthAdapter

Optionally, return a real name associated with this account.

PhutilJIRAAuthAdapter
This method is not documented.
Return
string|nullA human real name, or `null` if this data is not available.

public function setPrivateKey($private_key)
Inherited

This method is not documented.
Parameters
PhutilOpaqueEnvelope$private_key
Return
wild

public function getPrivateKey()
Inherited

This method is not documented.
Return
wild

public function setCallbackURI($callback_uri)
Inherited

This method is not documented.
Parameters
$callback_uri
Return
wild

public function getCallbackURI()
Inherited

This method is not documented.
Return
wild

public function setVerifier($verifier)
Inherited

This method is not documented.
Parameters
$verifier
Return
wild

public function getVerifier()
Inherited

This method is not documented.
Return
wild

public function setConsumerSecret($consumer_secret)
Inherited

This method is not documented.
Parameters
PhutilOpaqueEnvelope$consumer_secret
Return
wild

public function getConsumerSecret()
Inherited

This method is not documented.
Return
wild

public function setConsumerKey($consumer_key)
Inherited

This method is not documented.
Parameters
$consumer_key
Return
wild

public function getConsumerKey()
Inherited

This method is not documented.
Return
wild

public function setTokenSecret($token_secret)
Inherited

This method is not documented.
Parameters
$token_secret
Return
wild

public function getTokenSecret()
Inherited

This method is not documented.
Return
wild

public function setToken($token)
Inherited

This method is not documented.
Parameters
$token
Return
wild

public function getToken()
Inherited

This method is not documented.
Return
wild

protected function getHandshakeData()
Inherited

This method is not documented.
Return
wild

protected function getRequestTokenURI()

This method is not documented.
Return
wild

protected function getAuthorizeTokenURI()

This method is not documented.
Return
wild

protected function getValidateTokenURI()

This method is not documented.
Return
wild

protected function getSignatureMethod()

This method is not documented.
Return
wild

public function getContentSecurityPolicyFormActions()
Inherited

This method is not documented.
Return
wild

protected function newOAuth1Future($uri, $data)
Inherited

This method is not documented.
Parameters
$uri
$data
Return
wild

public function getClientRedirectURI()
Inherited

This method is not documented.
Return
wild

protected function finishOAuthHandshake()
Inherited

This method is not documented.
Return
wild

private function readTokenAndTokenSecret($data)
Inherited

This method is not documented.
Parameters
array$data
Return
wild

protected function willFinishOAuthHandshake()

PhutilOAuth1AuthAdapter

Hook that allows subclasses to take actions before the OAuth handshake is completed.

PhutilJIRAAuthAdapter

JIRA indicates that the user has clicked the "Deny" button by passing a well known oauth_verifier value ("denied"), which we check for here.

Return
wild

public function setJIRABaseURI($jira_base_uri)

This method is not documented.
Parameters
$jira_base_uri
Return
wild

public function getJIRABaseURI()

This method is not documented.
Return
wild

public function setAdapterDomain($domain)

This method is not documented.
Parameters
$domain
Return
wild

private function getJIRAURI($path)

This method is not documented.
Parameters
$path
Return
wild

private function getUserInfo()

This method is not documented.
Return
wild

private function newUserInfo()

This method is not documented.
Return
wild

public static function newJIRAKeypair()

This method is not documented.
Return
wild

public function newJIRAFuture($path, $method, $params)

This method is not documented.
Parameters
$path
$method
$params
Return
wild