com.docusign.esign.client.auth

Class ApiKeyAuth

java.lang.Object

com.docusign.esign.client.auth.ApiKeyAuth

All Implemented Interfaces:

Authentication

public class ApiKeyAuth
extends Object
implements Authentication

Constructor Summary

Constructors

Constructor and Description
ApiKeyAuth(String location, String paramName)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToParams(List<Pair> queryParams, Map<String,String> headerParams) Apply authentication settings to header and query params.
String	getApiKey()
String	getApiKeyPrefix()
String	getLocation()
String	getParamName()
void	setApiKey(String apiKey)
void	setApiKeyPrefix(String apiKeyPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKeyAuth

public ApiKeyAuth(String location,
          String paramName)

Method Detail

getLocation

public String getLocation()

getParamName

public String getParamName()

getApiKey

public String getApiKey()

setApiKey

public void setApiKey(String apiKey)

getApiKeyPrefix

public String getApiKeyPrefix()

setApiKeyPrefix

public void setApiKeyPrefix(String apiKeyPrefix)

applyToParams

public void applyToParams(List<Pair> queryParams,
                 Map<String,String> headerParams)

Description copied from interface: Authentication

Apply authentication settings to header and query params.

Specified by:

applyToParams in interface Authentication

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters