Index

A B C D E F G H I K M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values

A

ACCESS - Enum constant in enum class com.atlassian.oauth.Token.Type

AccessTokenAddedEvent - Class in com.atlassian.oauth.event

This event is published when an access token is added to the service provider.

AccessTokenAddedEvent(String, String) - Constructor for class com.atlassian.oauth.event.AccessTokenAddedEvent

AccessTokenRemovedEvent - Class in com.atlassian.oauth.event

This event is published when an access token is removed from the service provider.

AccessTokenRemovedEvent(String) - Constructor for class com.atlassian.oauth.event.AccessTokenRemovedEvent

Deprecated.

use AccessTokenRemovedEvent(String, String) instead

AccessTokenRemovedEvent(String, String) - Constructor for class com.atlassian.oauth.event.AccessTokenRemovedEvent

B

build() - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Constructs and returns the finalConsumer instance.

build() - Method in class com.atlassian.oauth.Token.TokenBuilder

C

callback(URI) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the default callback URL used after a request token has been authorized and returns this builder to allow other attributes to be set

Check - Class in com.atlassian.oauth.util

Utility to perform checks on parameters.

Check() - Constructor for class com.atlassian.oauth.util.Check

com.atlassian.oauth - package com.atlassian.oauth

com.atlassian.oauth.event - package com.atlassian.oauth.event

com.atlassian.oauth.util - package com.atlassian.oauth.util

consumer(Consumer) - Method in class com.atlassian.oauth.Token.TokenBuilder

Sets the consumer attribute of the request Token object under construction and returns the next builder in the chain, which allows optional attributes to be set and the final request Token instance to be constructed.

Consumer - Class in com.atlassian.oauth

Immutable representation of an OAuth consumer.

Consumer.InstanceBuilder - Class in com.atlassian.oauth

Builder allowing the optional attributes of the Consumer object under construction to be set and construction of the final Consumer instance.

Consumer.SignatureMethod - Enum Class in com.atlassian.oauth

The ways in which consumers can sign requests, as per

convertFromOpenSsl(String) - Static method in class com.atlassian.oauth.util.RSAKeys

Strips standard header/footer and any newlines.

D

DELETE - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

description(String) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the description of the consumer as it would be displayed to the user and returns this builder to allow other attributes to be set

E

equals(Object) - Method in class com.atlassian.oauth.Request.Parameter

executingTwoLOUser(String) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the username for 2LO requests to be executed as this builder to allow other attributes to be set

F

fromEncodedCertificateToPublicKey(String) - Static method in class com.atlassian.oauth.util.RSAKeys

Returns the RSA PublicKey that was decoded from the encoded certificate.

fromPemEncodingToPrivateKey(String) - Static method in class com.atlassian.oauth.util.RSAKeys

Returns the RSA PrivateKey that was decoded from the encoded string.

fromPemEncodingToPublicKey(String) - Static method in class com.atlassian.oauth.util.RSAKeys

Returns the RSA PublicKey that was decoded from the encoded string.

G

generateKeyPair() - Static method in class com.atlassian.oauth.util.RSAKeys

Returns a newly created RSA public/private KeyPair.

GET - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

getAccessTokenUri() - Method in class com.atlassian.oauth.ServiceProvider

Returns the URL used to exchange the User-authorized Request Token for an Access Token, described in

getAuthorizeUri() - Method in class com.atlassian.oauth.ServiceProvider

Returns the URL used to obtain User authorization for Consumer access, described in

getCallback() - Method in class com.atlassian.oauth.Consumer

Returns the default callback URI used after a request token has been authorized if no callback URI was provided in the authorization request.

getConsumer() - Method in class com.atlassian.oauth.Token

Returns the Consumer that owns this token.

getConsumerKey() - Method in class com.atlassian.oauth.event.TokenAddedEvent

getConsumerKey() - Method in class com.atlassian.oauth.event.TokenRemovedEvent

getDescription() - Method in class com.atlassian.oauth.Consumer

Returns the optional description of the consumer as it would be displayed to the user, null if the description was not set.

getExecutingTwoLOUser() - Method in class com.atlassian.oauth.Consumer

Returns the user whose credential is used to execute 2LO requests.

getKey() - Method in class com.atlassian.oauth.Consumer

Returns the unique key used to identify the consumer in requests unauthorized OAuth request tokens.

getMethod() - Method in class com.atlassian.oauth.Request

Returns the HTTP method to use when making the request - either GET or POST.

getName() - Method in class com.atlassian.oauth.Consumer

Returns the name of the consumer as it will be displayed to the user.

getName() - Method in class com.atlassian.oauth.Request.Parameter

Returns the name of the parameter.

getOAuthConsumerKey(HttpServletRequest) - Static method in class com.atlassian.oauth.util.RequestAnnotations

Gets the consumer key that the given OAuth request has been authenticated on.

getParameter(String) - Method in class com.atlassian.oauth.Request

Returns the value of the parameter.

getParameters() - Method in class com.atlassian.oauth.Request

Returns the parameters to be sent as part of the request.

getProperties() - Method in class com.atlassian.oauth.Token

Returns an immutable map of the tokens properties.

getProperty(String) - Method in class com.atlassian.oauth.Token

Returns the value of the property, or null if the property doesn't exist.

getPropertyNames() - Method in class com.atlassian.oauth.Token

Returns the names of the properties for this token.

getPublicKey() - Method in class com.atlassian.oauth.Consumer

Returns the RSA public key for the consumer, null if the signature method is not RSA-SHA1.

getRequestTokenUri() - Method in class com.atlassian.oauth.ServiceProvider

Returns the URL used to obtain an unauthorized Request Token, described in

getSignatureMethod() - Method in class com.atlassian.oauth.Consumer

Returns the method the consumer uses to sign requests.

getThreeLOAllowed() - Method in class com.atlassian.oauth.Consumer

Returns whether 3 Legged OAuth requests are allowed for this consumer.

getToken() - Method in class com.atlassian.oauth.Token

Returns the token value used to identify this token in OAuth messages.

getTokenSecret() - Method in class com.atlassian.oauth.Token

Returns the secret used by the Consumer to establish ownership of a given Token.

getTwoLOAllowed() - Method in class com.atlassian.oauth.Consumer

Returns whether 2 Legged OAuth requests are allowed for this consumer.

getTwoLOImpersonationAllowed() - Method in class com.atlassian.oauth.Consumer

Returns whether 2 Legged OAuth with impersonation requests are allowed for this consumer.

getUri() - Method in class com.atlassian.oauth.Request

Returns the URI to make the request to.

getUsername() - Method in class com.atlassian.oauth.event.TokenAddedEvent

getUsername() - Method in class com.atlassian.oauth.event.TokenRemovedEvent

getValue() - Method in class com.atlassian.oauth.Request.Parameter

Returns the value of the parameter.

H

hashCode() - Method in class com.atlassian.oauth.Request.Parameter

hasProperty(String) - Method in class com.atlassian.oauth.Token

Returns true if this token contains the optional property, false otherwise.

HEAD - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

HMAC_SHA1 - Enum constant in enum class com.atlassian.oauth.Consumer.SignatureMethod

I

InstanceBuilder(String) - Constructor for class com.atlassian.oauth.Consumer.InstanceBuilder

isAccessToken() - Method in class com.atlassian.oauth.Token

Returns true if this is an access token, false otherwise.

isOAuthRequest(HttpServletRequest) - Static method in class com.atlassian.oauth.util.RequestAnnotations

isRequestToken() - Method in class com.atlassian.oauth.Token

Returns true if this is a request token, false otherwise.

K

key(String) - Static method in class com.atlassian.oauth.Consumer

Static factory method that starts the process of building a Consumer instance.

M

markAsOAuthRequest(HttpServletRequest) - Static method in class com.atlassian.oauth.util.RequestAnnotations

Annotates the servlet request as one having been authenticated via OAuth.

N

name(String) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the name attribute of the Consumer object under construction and returns this builder to allow other attributes to be set

notBlank(String, Object) - Static method in class com.atlassian.oauth.util.Check

Checks if the string is null, empty, or contains only whitespace.

notNull(T, Object) - Static method in class com.atlassian.oauth.util.Check

Deprecated.

use Objects.requireNonNull(T)

O

OAUTH_AUTHORIZATION_EXPIRES_IN - Static variable in class com.atlassian.oauth.Request

OAUTH_EXPIRES_IN - Static variable in class com.atlassian.oauth.Request

OAUTH_SESSION_HANDLE - Static variable in class com.atlassian.oauth.Request

OPTIONS - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

P

Parameter(String, String) - Constructor for class com.atlassian.oauth.Request.Parameter

POST - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

properties(Map<String, String>) - Method in class com.atlassian.oauth.Token.TokenBuilder

Sets the properties for the request token and returns this builder.

publicKey(PublicKey) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the publicKey attribute of the Consumer object under construction and returns this builder to allow other attributes to be set

PUT - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

R

Request - Class in com.atlassian.oauth

Represents an HTTP request.

Request(Request.HttpMethod, URI, Iterable<Request.Parameter>) - Constructor for class com.atlassian.oauth.Request

REQUEST - Enum constant in enum class com.atlassian.oauth.Token.Type

Request.HttpMethod - Enum Class in com.atlassian.oauth

Enumeration of the HTTP methods that may be used when making OAuth requests.

Request.Parameter - Class in com.atlassian.oauth

Representation of parameters that may be added to an HTTP request.

RequestAnnotations - Class in com.atlassian.oauth.util

Managed annotations on the request to mark certain information to downstream parties

RequestAnnotations() - Constructor for class com.atlassian.oauth.util.RequestAnnotations

RequestTokenAddedEvent - Class in com.atlassian.oauth.event

This event is published when a request token is added to the service provider.

RequestTokenAddedEvent(String, String) - Constructor for class com.atlassian.oauth.event.RequestTokenAddedEvent

RequestTokenRemovedEvent - Class in com.atlassian.oauth.event

This event is published when a request token is removed from the service provider.

RequestTokenRemovedEvent(String) - Constructor for class com.atlassian.oauth.event.RequestTokenRemovedEvent

Deprecated.

use RequestTokenRemovedEvent(String, String) instead

RequestTokenRemovedEvent(String, String) - Constructor for class com.atlassian.oauth.event.RequestTokenRemovedEvent

RSA_SHA1 - Enum constant in enum class com.atlassian.oauth.Consumer.SignatureMethod

RSAKeys - Class in com.atlassian.oauth.util

RSAKeys() - Constructor for class com.atlassian.oauth.util.RSAKeys

S

ServiceProvider - Class in com.atlassian.oauth

Representation of an @see OAuth Service Provider.

ServiceProvider(URI, URI, URI) - Constructor for class com.atlassian.oauth.ServiceProvider

setOAuthConsumerKey(HttpServletRequest, String) - Static method in class com.atlassian.oauth.util.RequestAnnotations

Annotates the servlet request as one having been authenticated via OAuth using the consumerKey given.

signatureMethod(Consumer.SignatureMethod) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets the signatureMethod attribute of the Consumer object under construction and returns this builder to allow other attributes to be set

T

threeLOAllowed(boolean) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets whether to allow 3LO requests from consumers this builder to allow other attributes to be set

Token - Class in com.atlassian.oauth

Base type for OAuth tokens.

Token(Token.TokenBuilder<?, ?>) - Constructor for class com.atlassian.oauth.Token

Token.TokenBuilder<T,B> - Class in com.atlassian.oauth

Base builder that can be used by Token subclasses to build token instances.

Token.Type - Enum Class in com.atlassian.oauth

TokenAddedEvent - Class in com.atlassian.oauth.event

This is an abstract base class for token addition events.

TokenAddedEvent(String, String) - Constructor for class com.atlassian.oauth.event.TokenAddedEvent

TokenBuilder(Token.Type, String) - Constructor for class com.atlassian.oauth.Token.TokenBuilder

TokenRemovedEvent - Class in com.atlassian.oauth.event

This is an abstract base class for token removal events.

TokenRemovedEvent(String, String) - Constructor for class com.atlassian.oauth.event.TokenRemovedEvent

tokenSecret(String) - Method in class com.atlassian.oauth.Token.TokenBuilder

Sets the tokenSecret attribute of the Token under construction and returns this builder to allow for other attributes to be set.

toPemEncoding(Key) - Static method in class com.atlassian.oauth.util.RSAKeys

Convert the key to the appropriate string encoding.

toString() - Method in class com.atlassian.oauth.Consumer

toString() - Method in class com.atlassian.oauth.Request.Parameter

toString() - Method in class com.atlassian.oauth.ServiceProvider

toString() - Method in class com.atlassian.oauth.Token

TRACE - Enum constant in enum class com.atlassian.oauth.Request.HttpMethod

twoLOAllowed(boolean) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets whether to allow 2LO requests from consumers this builder to allow other attributes to be set

twoLOImpersonationAllowed(boolean) - Method in class com.atlassian.oauth.Consumer.InstanceBuilder

Sets whether to allow 2LO requests to impersonate *any* user on the system Normally this option would be on only for requests from fully-trusted consumers.

V

valueOf(String) - Static method in enum class com.atlassian.oauth.Consumer.SignatureMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.oauth.Request.HttpMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.atlassian.oauth.Token.Type

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.atlassian.oauth.Consumer.SignatureMethod

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.oauth.Request.HttpMethod

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.atlassian.oauth.Token.Type

Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I K M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values