org.vx68k.bitbucket.api.client.oauth

Class OAuthClient

java.lang.Object

org.vx68k.bitbucket.api.client.Client

org.vx68k.bitbucket.api.client.oauth.OAuthClient

All Implemented Interfaces:

Serializable

public class OAuthClient
extends Client

Bitbucket client that supports OAuth authorization.

Since:

4.0

Author:

Kaz Nishimura

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.vx68k.bitbucket.api.client.Client

Client.RestService

Constructor Summary

Constructors

Constructor and Description
OAuthClient() Constructs this object with no property values.
OAuthClient(OAuthCredentials credentials) Constructs this object with client credntials.
OAuthClient(String clientId, String clientSecret) Constructs this object with a client identifier and a client secret.

Method Summary

Methods

Modifier and Type	Method and Description
protected AuthorizationCodeFlow	getAuthorizationCodeFlow(boolean forTokenRequest) Returns a authorization code flow for OAuth requests.
URI	getAuthorizationEndpoint(URI redirectionEndpoint, String state) Returns the authorization endpoint URI for this object.
protected HttpExecuteInterceptor	getBasicAuthentication() Returns a HTTP execute interceptor with the client identifier and the client secret for Basic authentication.
protected HttpExecuteInterceptor	getClientParameters() Returns a HTTP execute interceptor with only the client identifier as a request parameter.
OAuthCredentials	getCredentials() Returns the OAuth client credentials of this object.
Service	getService(String authorizationCode, URI redirectionEndpoint) Returns an authorized Bitbucket API service.
void	setCredentials(OAuthCredentials credentials) Sets the OAuth client credentials of this object.

Methods inherited from class org.vx68k.bitbucket.api.client.Client

getHttpTransport, getPassword, getService, getService, getUser, setPassword, setUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthClient

public OAuthClient()

Constructs this object with no property values.

OAuthClient

public OAuthClient(String clientId,
           String clientSecret)

Constructs this object with a client identifier and a client secret. This constructor is equivalent to OAuthClient(OAuthCredentials) called with a newly created OAuthCredentials object.

Parameters:

clientId - client identifier

clientSecret - client secret

OAuthClient

public OAuthClient(OAuthCredentials credentials)

Constructs this object with client credntials. This constructor is equivalent to the default one followed by a call to setCredentials(org.vx68k.bitbucket.api.client.oauth.OAuthCredentials).

Parameters:

credentials - client credentials

Method Detail

getCredentials

public OAuthCredentials getCredentials()

Returns the OAuth client credentials of this object.

Returns:

OAuth client credentials, or null if this object has no credentials

setCredentials

public void setCredentials(OAuthCredentials credentials)

Sets the OAuth client credentials of this object.

Parameters:

credentials - OAuth client credentials; if this value is null, this object shall not have any credentials

getAuthorizationEndpoint

public URI getAuthorizationEndpoint(URI redirectionEndpoint,
                           String state)
                             throws URISyntaxException

Returns the authorization endpoint URI for this object.

Parameters:

redirectionEndpoint - redirection endpoint URI for the authorization request; if this argument is null, the redirect_uri parameter shall not be used.

state - opaque state string for the authorization request; if this argument is null, the state parameter shall not be used

Returns:

authorization endpoint URI

Throws:

URISyntaxException - if the authorization endpoint URI could not be constructed

NullPointerException - if this object has no client credentials

getService

public Service getService(String authorizationCode,
                 URI redirectionEndpoint)
                   throws IOException

Returns an authorized Bitbucket API service.

Parameters:

authorizationCode - authorization code received by the redirection endpoint

redirectionEndpoint - redirection endpoint URI that was used in the authorization request; if this argument is null, the redirect_uri parameter shall not be used.

Returns:

authorized Bitbucket REST API service

Throws:

IOException - if an I/O exception has occurred

NullPointerException - if this object has no client credentials

getAuthorizationCodeFlow

protected AuthorizationCodeFlow getAuthorizationCodeFlow(boolean forTokenRequest)

Returns a authorization code flow for OAuth requests.

Parameters:

forTokenRequest - true for token requests, or false for authorization requests

Returns:

AuthorizationCodeFlow object

Throws:

NullPointerException - if this object has no client credentials

getClientParameters

protected HttpExecuteInterceptor getClientParameters()

Returns a HTTP execute interceptor with only the client identifier as a request parameter.

Returns:

HTTP execute interceptor

getBasicAuthentication

protected HttpExecuteInterceptor getBasicAuthentication()

Returns a HTTP execute interceptor with the client identifier and the client secret for Basic authentication.

Returns:

HTTP execute interceptor