Package org.opendatadiscovery.client.auth

Class ApiKeyAuth

  • All Implemented Interfaces:
    Authentication
    @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-27T13:53:41.971284Z[Etc/UTC]")
public class ApiKeyAuth
extends java.lang.Object
implements Authentication

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void applyToParams​(org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> queryParams, org.springframework.http.HttpHeaders headerParams, org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> cookieParams)
      Apply authentication settings to header and / or query parameters.
      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​(org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> queryParams,
                          org.springframework.http.HttpHeaders headerParams,
                          org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> cookieParams)
        Description copied from interface: Authentication
        Apply authentication settings to header and / or query parameters.
        Specified by:
        applyToParams in interface Authentication
        Parameters:
        queryParams - The query parameters for the request
        headerParams - The header parameters for the request
        cookieParams - The cookie parameters for the request