com.hellosign.sdk.http

Class Authentication

java.lang.Object

com.hellosign.sdk.http.Authentication

public class Authentication
extends Object

This class provides convenience methods for handling authentication information for a HelloSignClient instance. We usually only want to use one of these methods, but don't necessarily want to have to pass around all of the information in method parameters.

Author:

Chris Paul ([email protected])

Constructor Summary

Constructors

Constructor and Description
Authentication()
Authentication(Authentication clone)

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(HttpURLConnection httpConn, String url) Authorizes the HTTP connection using this instance's credentials.
String	getAccessToken() Returns a protected copy of the access token.
String	getAccessTokenType() Returns a protected copy of the access token type string.
String	getApiKey() Returns a protected copy of the API key String.
String	getEmail() Returns the email address for this client.
String	getPassword() Returns the password for this client.
boolean	hasAccessToken() Returns true if an access token and token type have been provided.
boolean	hasApiKey() Returns true if the API Key has been set.
boolean	hasWebsiteCredentials() Returns true if an email and password have been set.
void	setAccessToken(String accessToken, String tokenType) Sets the access token for the HelloSign client authentication.
void	setApiKey(String apiKey) Sets the API key to use for authenticating this client.
void	setWebsiteCredentials(String email, String password) Sets the email and password to use for authenticating the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Authentication

public Authentication()

Authentication

public Authentication(Authentication clone)
               throws HelloSignException

Throws:

HelloSignException

Method Detail

setWebsiteCredentials

public void setWebsiteCredentials(String email,
                         String password)
                           throws HelloSignException

Sets the email and password to use for authenticating the client.

Parameters:

email - String email address

password - String password

Throws:

HelloSignException - thrown if either the email or password are null

getEmail

public String getEmail()

Returns the email address for this client.

Returns:

String email

getPassword

public String getPassword()

Returns the password for this client.

Returns:

String password

hasWebsiteCredentials

public boolean hasWebsiteCredentials()

Returns true if an email and password have been set.

Returns:

true, or false if either are empty

getApiKey

public String getApiKey()

Returns a protected copy of the API key String.

Returns:

String API key

setApiKey

public void setApiKey(String apiKey)

Sets the API key to use for authenticating this client.

Parameters:

apiKey - String API Key

hasApiKey

public boolean hasApiKey()

Returns true if the API Key has been set.

Returns:

true, or false if the key is empty

getAccessToken

public String getAccessToken()

Returns a protected copy of the access token.

Returns:

String access token

getAccessTokenType

public String getAccessTokenType()

Returns a protected copy of the access token type string.

Returns:

String access token type

setAccessToken

public void setAccessToken(String accessToken,
                  String tokenType)
                    throws HelloSignException

Sets the access token for the HelloSign client authentication.

Parameters:

accessToken - String

tokenType - String

Throws:

HelloSignException - if either the accessToken or tokenType are null

hasAccessToken

public boolean hasAccessToken()

Returns true if an access token and token type have been provided.

Returns:

true or false if either are not set

authenticate

public void authenticate(HttpURLConnection httpConn,
                String url)

Authorizes the HTTP connection using this instance's credentials.

Parameters:

httpConn - HttpURLConnection to be authenticated

url - String URL against which this connection should be authorized.