com.box.boxjavalibv2.authorization

Class SharedLinkAuthorization

java.lang.Object

com.box.restclientv2.authorization.DefaultRequestAuth

com.box.boxjavalibv2.authorization.SharedLinkAuthorization

All Implemented Interfaces:

IOAuthAuthorization, IBoxRequestAuth

public class SharedLinkAuthorization
extends DefaultRequestAuth
implements IOAuthAuthorization

Shared link authorization. This authorization can be used in addition to other authorization(currently only OAuth) to support authorization to access a shared link.

Field Summary

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

AUTH_HEADER_NAME

Constructor Summary

Constructors

Constructor and Description
SharedLinkAuthorization(OAuthAuthorization oauth, java.lang.String sharedLink, java.lang.String password) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.StringBuilder	getAuthString() Get auth header value string.
void	initOAuthForRequest() Initialize this auth.
void	refresh() Refresh the OAuth token.
void	setAuth(IBoxRequest request) Set Auth into the API request.
void	setOAuthData(BoxOAuthToken data)
void	setPassword(java.lang.String password) Set password for the shared link auth, this is needed if a shared file is password protected.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedLinkAuthorization

public SharedLinkAuthorization(OAuthAuthorization oauth,
                       java.lang.String sharedLink,
                       java.lang.String password)

Constructor.

Parameters:

sharedLink - shared link

Method Detail

setPassword

public void setPassword(java.lang.String password)

Set password for the shared link auth, this is needed if a shared file is password protected.

Parameters:

password - password

setOAuthData

public void setOAuthData(BoxOAuthToken data)

Specified by:

setOAuthData in interface IOAuthAuthorization

refresh

public void refresh()
             throws AuthFatalFailureException

Description copied from interface: IOAuthAuthorization

Refresh the OAuth token.

Specified by:

refresh in interface IOAuthAuthorization

Throws:

AuthFatalFailureException - exception

initOAuthForRequest

public void initOAuthForRequest()

Description copied from interface: IOAuthAuthorization

Initialize this auth. This need to be called before making an API request using this auth.

Specified by:

initOAuthForRequest in interface IOAuthAuthorization

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 IOAuthAuthorization

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.