ApiKeyAuth (docusign-esign-java 3.18.0 API)

java.lang.Object
- com.docusign.esign.client.auth.ApiKeyAuth

All Implemented Interfaces:: Authentication

public class ApiKeyAuth
extends java.lang.Object
implements Authentication

ApiKeyAuth class.

Constructor Summary

Constructors
Constructor Description

ApiKeyAuth(java.lang.String location, java.lang.String paramName)
ApiKeyAuth constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`applyToParams(java.util.List<Pair> queryParams, java.util.Map<java.lang.String,java.lang.String> headerParams)`	applyToParams method.
`java.lang.String`	`getApiKey()`	getApiKey method.
`java.lang.String`	`getApiKeyPrefix()`	getApiKeyPrefix method.
`java.lang.String`	`getLocation()`	getLocation method.
`java.lang.String`	`getParamName()`	getParamName method.
`void`	`setApiKey(java.lang.String apiKey)`	setApiKey method.
`void`	`setApiKeyPrefix(java.lang.String apiKeyPrefix)`	setApiKeyPrefix method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiKeyAuth
```
public ApiKeyAuth(java.lang.String location,
                  java.lang.String paramName)
```
    ApiKeyAuth constructor.
    
    Parameters:
    
    location - Sets location
    
    paramName - Sets paramName
- Method Detail
  - getLocation
```
public java.lang.String getLocation()
```
    getLocation method.
    
    Returns:
    
    String
  - getParamName
```
public java.lang.String getParamName()
```
    getParamName method.
    
    Returns:
    
    String
  - getApiKey
```
public java.lang.String getApiKey()
```
    getApiKey method.
    
    Returns:
    
    String
  - setApiKey
```
public void setApiKey(java.lang.String apiKey)
```
    setApiKey method.
    
    Parameters:
    
    apiKey - The apiKey
  - getApiKeyPrefix
```
public java.lang.String getApiKeyPrefix()
```
    getApiKeyPrefix method.
    
    Returns:
    
    String
  - setApiKeyPrefix
```
public void setApiKeyPrefix(java.lang.String apiKeyPrefix)
```
    setApiKeyPrefix method.
    
    Parameters:
    
    apiKeyPrefix - The apiKeyPrefix
  - applyToParams
```
public void applyToParams(java.util.List<Pair> queryParams,
                          java.util.Map<java.lang.String,java.lang.String> headerParams)
```
    applyToParams method.
    
    Specified by:
    
    applyToParams in interface Authentication
    
    Parameters:
    
    queryParams - The query params
    
    headerParams - The header params