Package de.iip_ecosphere.platform.support.semanticId.eclass.handler.auth

Class ApiKeyAuth

  • All Implemented Interfaces:
    Authentication
    @Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-02-28T18:29:16.382914+01:00[Europe/Berlin]")
public class ApiKeyAuth
extends java.lang.Object
implements Authentication

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String apiKey  
      private java.lang.String apiKeyPrefix  
      private java.lang.String location  
      private java.lang.String paramName  

    • 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​(java.util.List<Pair> queryParams, java.util.Map<java.lang.String,​java.lang.String> headerParams)
      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

    • Field Detail

      • location

        private final java.lang.String location

      • paramName

        private final java.lang.String paramName

      • apiKey

        private java.lang.String apiKey

      • apiKeyPrefix

        private java.lang.String apiKeyPrefix

    • 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)
        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