com.xero.api

Class OAuthParameters

java.lang.Object

com.xero.api.OAuthParameters

All Implemented Interfaces:

com.google.api.client.http.HttpExecuteInterceptor, com.google.api.client.http.HttpRequestInitializer

public class OAuthParameters
extends Object
implements com.google.api.client.http.HttpExecuteInterceptor, com.google.api.client.http.HttpRequestInitializer

Field Summary

Fields

Modifier and Type	Field and Description
String	appFirewallHostname The hostname used for communicating through the application firewall.
String	appFirewallUrlPrefix The prefix the application firewall uses to identify mappings for it's own URL rewriting.
String	callback Absolute URI back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed.
String	consumerKey Required identifier portion of the client credentials (equivalent to a username).
String	nonce Required nonce value.
String	realm Realm.
String	sessionHandle Session handle.
String	signature Signature.
String	signatureMethod Name of the signature method used by the client to sign the request.
com.google.api.client.auth.oauth.OAuthSigner	signer Required OAuth signature algorithm.
String	timestamp Required timestamp value.
String	token Token value used to associate the request with the resource owner or null if the request is not associated with a resource owner.
boolean	usingAppFirewall A value of true indicates that server is sitting behind and application firewall (e.g.
String	verifier The verification code received from the server.
String	version Must either be "1.0" or null to skip.

Constructor Summary

Constructors

Constructor and Description
OAuthParameters()

Method Summary

Modifier and Type	Method and Description
void	computeNonce() Computes a nonce based on the hex string of a random non-negative long, setting the value of the nonce field.
void	computeSignature(String requestMethod, com.google.api.client.http.GenericUrl requestUrl) Computes a new signature based on the fields and the given request method and URL, setting the values of the signature and signatureMethod fields.
void	computeTimestamp() Computes a timestamp based on the current system time, setting the value of the timestamp field.
static String	escape(String value) Returns the escaped form of the given value using OAuth escaping rules.
String	getAuthorizationHeader() Returns the Authorization header value to use with the OAuth parameter values found in the fields.
void	initialize(com.google.api.client.http.HttpRequest request)
void	intercept(org.apache.http.client.methods.HttpDelete request, com.google.api.client.http.GenericUrl url)
void	intercept(org.apache.http.client.methods.HttpGet request, com.google.api.client.http.GenericUrl url)
void	intercept(org.apache.http.client.methods.HttpPost request, com.google.api.client.http.GenericUrl url)
void	intercept(org.apache.http.client.methods.HttpPut request, com.google.api.client.http.GenericUrl url)
void	intercept(com.google.api.client.http.HttpRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

signer

public com.google.api.client.auth.oauth.OAuthSigner signer

Required OAuth signature algorithm.

callback

public String callback

Absolute URI back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed.

consumerKey

public String consumerKey

Required identifier portion of the client credentials (equivalent to a username).

nonce

public String nonce

Required nonce value. Should be computed using computeNonce().

realm

public String realm

Realm.

signature

public String signature

Signature. Required but normally computed using computeSignature(java.lang.String, com.google.api.client.http.GenericUrl).

signatureMethod

public String signatureMethod

Name of the signature method used by the client to sign the request. Required, but normally computed using computeSignature(java.lang.String, com.google.api.client.http.GenericUrl).

timestamp

public String timestamp

Required timestamp value. Should be computed using computeTimestamp().

token

public String token

Token value used to associate the request with the resource owner or null if the request is not associated with a resource owner.

sessionHandle

public String sessionHandle

Session handle.

verifier

public String verifier

The verification code received from the server.

version

public String version

Must either be "1.0" or null to skip. Provides the version of the authentication process as defined in this specification.

usingAppFirewall

public boolean usingAppFirewall

A value of true indicates that server is sitting behind and application firewall (e.g. L7) Values for hostname and URL's will be adjusted when calculating oauth signatures as the application firewall will be changing the request

appFirewallHostname

public String appFirewallHostname

The hostname used for communicating through the application firewall. If the url hostname matches this, the value of "api.xero.com" will be used instead when calculating the oauth signature.

appFirewallUrlPrefix

public String appFirewallUrlPrefix

The prefix the application firewall uses to identify mappings for it's own URL rewriting. The value of the prefix will be stripped from the URL when calculating the oauth signature.

Constructor Detail

OAuthParameters

public OAuthParameters()

Method Detail

computeNonce

public void computeNonce()

Computes a nonce based on the hex string of a random non-negative long, setting the value of the nonce field.

computeTimestamp

public void computeTimestamp()

Computes a timestamp based on the current system time, setting the value of the timestamp field.

computeSignature

public void computeSignature(String requestMethod,
                             com.google.api.client.http.GenericUrl requestUrl)
                      throws GeneralSecurityException

Computes a new signature based on the fields and the given request method and URL, setting the values of the signature and signatureMethod fields.

Parameters:

requestUrl - The full URL including paramters

requestMethod - The REST verb GET, PUT, POST, DELETE

Throws:

GeneralSecurityException - general security exception

getAuthorizationHeader

public String getAuthorizationHeader()

Returns the Authorization header value to use with the OAuth parameter values found in the fields.

Returns:

String

escape

public static String escape(String value)

Returns the escaped form of the given value using OAuth escaping rules.

Parameters:

value - The string value you wish to escape

Returns:

String

initialize

public void initialize(com.google.api.client.http.HttpRequest request)
                throws IOException

Specified by:

initialize in interface com.google.api.client.http.HttpRequestInitializer

Throws:

IOException

intercept

public void intercept(com.google.api.client.http.HttpRequest request)
               throws IOException

Specified by:

intercept in interface com.google.api.client.http.HttpExecuteInterceptor

Throws:

IOException

intercept

public void intercept(org.apache.http.client.methods.HttpGet request,
                      com.google.api.client.http.GenericUrl url)
               throws IOException

Throws:

IOException

intercept

public void intercept(org.apache.http.client.methods.HttpPost request,
                      com.google.api.client.http.GenericUrl url)
               throws IOException

Throws:

IOException

intercept

public void intercept(org.apache.http.client.methods.HttpPut request,
                      com.google.api.client.http.GenericUrl url)
               throws IOException

Throws:

IOException

intercept

public void intercept(org.apache.http.client.methods.HttpDelete request,
                      com.google.api.client.http.GenericUrl url)
               throws IOException

Throws:

IOException