OAuthClient (Oracle Fusion Middleware Java API Reference)

Class

Use

Tree

Help

Oracle Fusion Middleware Java API Reference for the Oracle Access Management OAuth Service
11g Release 2 Patch Set 3 (11.1.2.3)
E59498-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.idaas.oauth.sdk
Interface OAuthClient

All Known Implementing Classes:: JerseyClient, OAuthRestClient

public interface OAuthClient

Client interface to the OAuth server.

It defines 3 main methods:

createToken: shall be used to obtain a token.
validateToken: shall be used to validate a previously obtained token.
terminateToken: shall be used to end a token.

The createToken() method is using a request/response pair. For any class extending OAuthTokenRequest:

the request class name shall end by "Request" and the package name shall contain "request" in the package name.
the response class name shall end by "Response" and the package name shall contain "response" in the package name.
it shall exist a class extending OAuthTokenResponse for any class extending OAuthTokenRequest. The response class name shall be build by replacing the word "request" in the package name by "response" and the trailing "Request" by "Response" from the request class name.

Method Summary


`OAuthTokenResponse`	`createToken(OAuthTokenRequest request)` Returns a formated response including the token information or an error.
`RevocationResponse`	`terminateToken(RevocationRequest request)` Terminates a Token and returns the result.
`AccessTokenValidationResponse`	`validateToken(AccessTokenValidationRequest request)` Returns a formated response including the token validation or an error.

Method Detail

createToken

OAuthTokenResponse createToken(OAuthTokenRequest request)
                               throws OAuthSdkException

Returns a formated response including the token information or an error.

Parameters:: request - containing the header and data information
Returns:: the result of the call containing at least and access_token
Throws:: OAuthSdkException - in case of failure

validateToken

AccessTokenValidationResponse validateToken(AccessTokenValidationRequest request)
                                            throws OAuthSdkException

Returns a formated response including the token validation or an error.

Parameters:: request - containing the header and data information
Returns:: the result of the token validation
Throws:: OAuthSdkException - in case of failure

terminateToken

RevocationResponse terminateToken(RevocationRequest request)
                                  throws OAuthSdkException

Terminates a Token and returns the result.

Parameters:: request - contains the revocation token information
Returns:: the response
Throws:: OAuthSdkException - in case of failure

Overview

Package