org.openapitools.control.client.auth

Class ApiKeyAuth

java.lang.Object

org.openapitools.control.client.auth.ApiKeyAuth

All Implemented Interfaces:

Authentication

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-07-18T20:37:01.807093Z[Etc/UTC]")
public class ApiKeyAuth
extends java.lang.Object
implements Authentication

Constructor Summary

Constructors

Constructor and Description
ApiKeyAuth(java.lang.String location, java.lang.String paramName)

Method Summary

Modifier and Type	Method and Description
void	applyToParams(java.util.List<Pair> queryParams, java.util.Map<java.lang.String,java.lang.String> headerParams, java.util.Map<java.lang.String,java.lang.String> cookieParams, java.lang.String payload, java.lang.String method, java.net.URI uri) Apply authentication settings to header and query params.
java.lang.String	getApiKey()
java.lang.String	getApiKeyPrefix()
java.lang.String	getLocation()
java.lang.String	getParamName()
void	setApiKey(java.lang.String apiKey)
void	setApiKeyPrefix(java.lang.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(java.lang.String location,
                  java.lang.String paramName)

Method Detail

getLocation

public java.lang.String getLocation()

getParamName

public java.lang.String getParamName()

getApiKey

public java.lang.String getApiKey()

setApiKey

public void setApiKey(java.lang.String apiKey)

getApiKeyPrefix

public java.lang.String getApiKeyPrefix()

setApiKeyPrefix

public void setApiKeyPrefix(java.lang.String apiKeyPrefix)

applyToParams

public void applyToParams(java.util.List<Pair> queryParams,
                          java.util.Map<java.lang.String,java.lang.String> headerParams,
                          java.util.Map<java.lang.String,java.lang.String> cookieParams,
                          java.lang.String payload,
                          java.lang.String method,
                          java.net.URI uri)
                   throws ApiException

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

cookieParams - Map of cookie parameters

payload - HTTP request body

method - HTTP method

uri - URI

Throws:

ApiException - if failed to update the parameters