com.box.restclientv2.authorization

Class DefaultAuthHeaderAuth

java.lang.Object

com.box.restclientv2.authorization.DefaultRequestAuth

com.box.restclientv2.authorization.DefaultAuthHeaderAuth

All Implemented Interfaces:

IBoxRequestAuth

Direct Known Subclasses:

SharedItemAuth

public class DefaultAuthHeaderAuth
extends DefaultRequestAuth

Auth to be set in http request header.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mDeviceId
protected java.lang.String	mDeviceName

Fields inherited from class com.box.restclientv2.authorization.DefaultRequestAuth

AUTH_HEADER_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultAuthHeaderAuth(java.lang.String authToken, java.lang.String apiKey, java.lang.String deviceId, java.lang.String deviceName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.StringBuilder	getAuthString() Get auth header value string.
void	setAuth(IBoxRequest request) Set Auth into the API request.

Methods inherited from class java.lang.Object

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

Field Detail

mDeviceId

protected final java.lang.String mDeviceId

mDeviceName

protected final java.lang.String mDeviceName

Constructor Detail

DefaultAuthHeaderAuth

public DefaultAuthHeaderAuth(java.lang.String authToken,
                     java.lang.String apiKey,
                     java.lang.String deviceId,
                     java.lang.String deviceName)

Constructor.

Parameters:

authToken - auth token.

apiKey - api key

deviceId - Device ID.

deviceName - Device name.

Method Detail

setAuth

public void setAuth(IBoxRequest request)
             throws BoxRestException,
                    AuthFatalFailureException

Description copied from interface: IBoxRequestAuth

Set Auth into the API request.

Specified by:

setAuth in interface IBoxRequestAuth

Overrides:

setAuth in class DefaultRequestAuth

Parameters:

request - IBoxRequest

Throws:

BoxRestException - Exception.

AuthFatalFailureException - exception

getAuthString

public java.lang.StringBuilder getAuthString()

Get auth header value string.

Returns:

auth header value string.