Package 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
ApiKeyAuth class.
-
-
Constructor Summary
Constructors Constructor Description ApiKeyAuth(String location, String paramName)ApiKeyAuth constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapplyToParams(List<Pair> queryParams, Map<String,String> headerParams)applyToParams method.StringgetApiKey()getApiKey method.StringgetApiKeyPrefix()getApiKeyPrefix method.StringgetLocation()getLocation method.StringgetParamName()getParamName method.voidsetApiKey(String apiKey)setApiKey method.voidsetApiKeyPrefix(String apiKeyPrefix)setApiKeyPrefix method.
-
-
-
Method Detail
-
getLocation
public String getLocation()
getLocation method.- Returns:
- String
-
getParamName
public String getParamName()
getParamName method.- Returns:
- String
-
getApiKey
public String getApiKey()
getApiKey method.- Returns:
- String
-
setApiKey
public void setApiKey(String apiKey)
setApiKey method.- Parameters:
apiKey- The apiKey
-
getApiKeyPrefix
public String getApiKeyPrefix()
getApiKeyPrefix method.- Returns:
- String
-
setApiKeyPrefix
public void setApiKeyPrefix(String apiKeyPrefix)
setApiKeyPrefix method.- Parameters:
apiKeyPrefix- The apiKeyPrefix
-
applyToParams
public void applyToParams(List<Pair> queryParams, Map<String,String> headerParams)
applyToParams method.- Specified by:
applyToParamsin interfaceAuthentication- Parameters:
queryParams- The query paramsheaderParams- The header params
-
-