A

access_token - Variable in class com.oracle.oauth2.AccessToken

The access token issued by the authorization server (Read only)

AccessToken - Class in com.oracle.oauth2

The AccessToken class is an OAuth v2 implementation of Token interface.

AccessToken(DataInputStream) - Constructor for class com.oracle.oauth2.AccessToken

creates a token that was serialized before into a stream.

AccessTokenMAC - Class in com.oracle.oauth2

Access token used to sign requests with MAC algorithm.

AccessTokenMAC(DataInputStream) - Constructor for class com.oracle.oauth2.AccessTokenMAC

creates a token that was serialized before into a stream.

AccessTokenRefreshRequest - Class in com.oracle.oauth2

This class is used to obtain an AccessToken using a "refresh token" of the previous access token.

AccessTokenRefreshRequest(OAuth2, String, String) - Constructor for class com.oracle.oauth2.AccessTokenRefreshRequest

Creates the AccessTokenRefreshRequest object

AccessTokenRequest - Class in com.oracle.oauth2

this class is used to get AccessToken instance via AccessTokenRequest.getAccessToken().

addParam(String, String) - Method in class com.oracle.oauth2.AccessTokenRequest

Adds a parameter to the AccessTokenRequest body

addParameter(String, String) - Method in class com.oracle.oauth2.Request

Adds a parameter to the query part of the base URL.

addParameter(String, int) - Method in class com.oracle.oauth2.Request

Adds a parameter with an integer value to the query part of base URL.

addProperty(String, String) - Method in class com.oracle.oauth2.Request

Adds a field to the request message headers: general-header, or request-header, or entity-header.

C

checkToken(Token) - Method in class com.oracle.oauth2.Signer.Basic

 

checkToken(Token) - Method in interface com.oracle.oauth2.Signer

Checks if the token is appropriate for this signer.

close() - Method in interface com.oracle.oauth2.IResponse

Close the connection

close() - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

 

code - Variable in class com.oracle.oauth2.GTAuthorizationCode.Authorization

The authorization code generated by the authorization server

com.oracle.oauth2 - package com.oracle.oauth2

 

contentType() - Method in interface com.oracle.oauth2.IResponse

Gets the Content-Type for this response.

contentType() - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

 

createAccessTokenRequest(OAuth2, String, String) - Static method in class com.oracle.oauth2.GTAuthorizationCode

creates an 'access token request'.

createAccessTokenRequest(OAuth2, String) - Static method in class com.oracle.oauth2.GTClientCredentials

creates an 'access token request'

createAccessTokenRequest(OAuth2, String, String, String) - Static method in class com.oracle.oauth2.GTResourceOwnerPasswordCredentials

creates 'access token request'

createAuthorizationRequest(OAuth2, String, String, String) - Static method in class com.oracle.oauth2.GTAuthorizationCode

Creates an authorization request as required by the specification.

createAuthorizationRequest(OAuth2, String, String, String) - Static method in class com.oracle.oauth2.GTImplicit

creates an authorization request A successful response to this request should have result code 302 and 'Location' field with an URI that the user should visit to grant requested permissions.

createHttpConnection(String) - Method in class com.oracle.oauth2.Request

Creates a HTTP connection for the request

createRequest(String) - Method in interface com.oracle.oauth2.Request.Factory

Creates new request for the specified URL

CT_URLENCODED - Static variable in class com.oracle.oauth2.Request

The application/x-www-form-urlencoded content type

D

description - Variable in exception com.oracle.oauth2.OAuth2Exception

Text providing additional information about the error

E

error - Variable in exception com.oracle.oauth2.OAuth2Exception

Error code

ERROR_EXTERNAL - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the OAuth2 external error

ERROR_INVALID_CLIENT - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the invalid_client error

ERROR_INVALID_GRANT - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the invalid_grant error

ERROR_INVALID_REQUEST - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the invalid_request error

ERROR_INVALID_SCOPE - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the invalid_scope error

ERROR_UNAUTHORIZED_CLIENT - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the unauthorized_client error

ERROR_UNSUPPORTED_GRANT_TYPE - Static variable in exception com.oracle.oauth2.OAuth2Exception

Code for the unsupported_grant_type error

execute() - Method in class com.oracle.oauth2.Request

The method creates a HttpConnection object, sets request's parameters and sends the request to the specified server.

expires_in - Variable in class com.oracle.oauth2.AccessToken

The lifetime in seconds of the access token (Read only)

G

getAccessToken() - Method in class com.oracle.oauth2.AccessTokenRequest

Executes the Access Token Request, receives a response from the server, parses it and returns the AccessToken object

getAccessToken(IResponse) - Static method in class com.oracle.oauth2.GTImplicit

Extracts an access token from a response from the server

getAuthorization(IResponse) - Static method in class com.oracle.oauth2.GTAuthorizationCode

Extracts authorization data from an authorization server's response.

getAuthorizationEndpoint() - Method in class com.oracle.oauth2.OAuth2

 

getAuthorizationSign(Request) - Method in class com.oracle.oauth2.OAuth2

Get AuthorizationSign.

getBody() - Method in class com.oracle.oauth2.Request

Returns body of this request

getBodyOutputStream() - Method in class com.oracle.oauth2.Request

Returns OutputStream that should be used to form request body.

getClientId() - Method in class com.oracle.oauth2.OAuth2

 

getField(String) - Method in interface com.oracle.oauth2.IResponse

Gets the named header field for this response.

getField(String) - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

 

getMethod() - Method in class com.oracle.oauth2.Request

Returns the method of this request

getProperty(String) - Method in class com.oracle.oauth2.Request

Returns value of the required property of this request

getPropertyName() - Method in class com.oracle.oauth2.OAuth2

Get Property name for sign

getSign(Request, Token) - Method in class com.oracle.oauth2.Signer.Basic

 

getSign(Request, Token) - Method in interface com.oracle.oauth2.Signer

Signs a request

getSigner(AccessToken) - Method in class com.oracle.oauth2.OAuth2

redefinition of this method allows a user of the API to provide his own RequestSigner for the token passed as a parameter.

getTokenEndpoint() - Method in class com.oracle.oauth2.OAuth2

 

getURI() - Method in class com.oracle.oauth2.Request

Returns URI of this request

GTAuthorizationCode - Class in com.oracle.oauth2

The GTAuthorizationCode supports authorization code grant type flow Authorization Code Grant

GTAuthorizationCode.Authorization - Class in com.oracle.oauth2

This class contains data returned by an authorization server when a user grants access to data.

GTClientCredentials - Class in com.oracle.oauth2

The GTClientCredentials supports client credentials grant type flow Client Credentials Grant

GTImplicit - Class in com.oracle.oauth2

The GTImplicit supports implicit grant type flow Implicit Grant

GTResourceOwnerPasswordCredentials - Class in com.oracle.oauth2

The GTResourceOwnerPasswordCredentials supports resource owner password credentials grant type flow Resource Owner Password Credentials Grant

I

IResponse - Interface in com.oracle.oauth2

An interface that represents the HTTP response from server.

IResponse.OnHttpConnection - Class in com.oracle.oauth2

An implementation of the Response interface for the HttpConnection

IResponse.OnHttpConnection(HttpConnection) - Constructor for class com.oracle.oauth2.IResponse.OnHttpConnection

Creates an OnHttpConnection for the HttpConnection

M

mac_algorithm - Variable in class com.oracle.oauth2.AccessTokenMAC

The MAC algorithm used to calculate the request MAC.

mac_key - Variable in class com.oracle.oauth2.AccessTokenMAC

The MAC key

O

OAuth2 - Class in com.oracle.oauth2

The OAuth2 class contains information required for authorization on a server.

OAuth2(String, String, String) - Constructor for class com.oracle.oauth2.OAuth2

Constructor.

OAuth2Exception - Exception in com.oracle.oauth2

failure information container.

OAuth2Exception(String) - Constructor for exception com.oracle.oauth2.OAuth2Exception

Creates the Exception object with the ERROR_EXTERNAL error code

OAuth2Exception(String, String, String, String) - Constructor for exception com.oracle.oauth2.OAuth2Exception

Creates the Exception object

OAuth2Exception(Hashtable) - Constructor for exception com.oracle.oauth2.OAuth2Exception

Creates the Exception object

openInputStream() - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

 

openInputStream() - Method in interface com.oracle.oauth2.IResponse

Opens the input stream if it has not already been opened.

P

password - Variable in class com.oracle.oauth2.Signer.Basic.UserPass

Field for the password parameter keeping

PROPNM_ACCEPT - Static variable in class com.oracle.oauth2.Request

The Accept request-header field

PROPNM_AUTHORIZATION - Static variable in class com.oracle.oauth2.Request

The Authorization request-header field

PROPNM_CONTENT_TYPE - Static variable in class com.oracle.oauth2.Request

The Content-Type Entity-header field

R

refresh_token - Variable in class com.oracle.oauth2.AccessToken

The refresh token which can be used to obtain new access tokens (Read only)

Request - Class in com.oracle.oauth2

This class provides an implementation of a HTTP request message from a client to a server.

Request(String) - Constructor for class com.oracle.oauth2.Request

Creates the request object for required URL.

Request.Factory - Interface in com.oracle.oauth2

An Interface that represents creating of a request to a server.

resultCode() - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

 

resultCode() - Method in interface com.oracle.oauth2.IResponse

Returns the HTTP response status code.

S

scope - Variable in class com.oracle.oauth2.AccessToken

The scope of the access token (Read only)

serialize(DataOutputStream) - Method in class com.oracle.oauth2.AccessToken

 

serialize(DataOutputStream) - Method in class com.oracle.oauth2.AccessTokenMAC

 

serialize(DataOutputStream) - Method in class com.oracle.oauth2.Signer.Basic.UserPass

 

serialize(DataOutputStream) - Method in interface com.oracle.oauth2.Token

The method allows user to save a token in some storage

setMethod(String) - Method in class com.oracle.oauth2.Request

Sets request's method ('GET', 'POST', 'PUT', etc.).

setToken(AccessToken) - Method in class com.oracle.oauth2.OAuth2

this method sets AccessToken for signing all subsequent requests created by create() method.

Signer - Interface in com.oracle.oauth2

An interface that represents a HTTP request signer

Signer.Basic - Class in com.oracle.oauth2

An implementation of the Basic Access Authentication.

Signer.Basic() - Constructor for class com.oracle.oauth2.Signer.Basic

 

Signer.Basic.UserPass - Class in com.oracle.oauth2

An implementation of the Token interface.

Signer.Basic.UserPass(String, String) - Constructor for class com.oracle.oauth2.Signer.Basic.UserPass

Creates the UserPass object with the following parameters:

state - Variable in class com.oracle.oauth2.GTAuthorizationCode.Authorization

The "state" parameter

state - Variable in exception com.oracle.oauth2.OAuth2Exception

The state value.

std - Static variable in interface com.oracle.oauth2.Request.Factory

Standard factory implementation.

T

timestamp - Variable in class com.oracle.oauth2.AccessTokenMAC

The time when the credentials were issued

Token - Interface in com.oracle.oauth2

All OAuth tokens should implement this interface.

token_type - Variable in class com.oracle.oauth2.AccessToken

The type of the token issued by the authorization server (Read only)

toString() - Method in class com.oracle.oauth2.AccessToken

Returns a string representation of this AccessToken.

toString() - Method in class com.oracle.oauth2.GTAuthorizationCode.Authorization

Returns a string representation of this Authorization.

toString() - Method in class com.oracle.oauth2.IResponse.OnHttpConnection

Returns a string representation of this OnHttpConnection.

toString() - Method in class com.oracle.oauth2.Request

Returns a string representation of this request.

U

uri - Variable in exception com.oracle.oauth2.OAuth2Exception

A URI identifying a web page with information about the error

userid - Variable in class com.oracle.oauth2.Signer.Basic.UserPass

Field for the username parameter keeping

W

writeStringOrNull(DataOutputStream, String) - Method in class com.oracle.oauth2.AccessToken

Writes string in the output stream in the following format: <true><string> or <false> in case <string> is null