Package com.mulesoft.connectors.a2a.api.model.card.security

Class ApiKeySecurityScheme

java.lang.Object
com.mulesoft.connectors.a2a.api.model.card.SecurityScheme
com.mulesoft.connectors.a2a.api.model.card.security.ApiKeySecurityScheme
public class ApiKeySecurityScheme extends SecurityScheme
Represents an API Key security scheme following OpenAPI 3.0 specification. The API key can be passed in the request in different ways: - As a header parameter - As a query parameter - As a cookie parameter
Since:
1.0.0

  • Constructor Details

    • ApiKeySecurityScheme

      public ApiKeySecurityScheme()

  • Method Details

    • copy

      public ApiKeySecurityScheme copy()
      Creates a copy of this ApiKeySecurityScheme.
      Specified by:
      copy in class SecurityScheme
      Returns:
      A new ApiKeySecurityScheme instance with the same values as this one

    • getType

      public String getType()
      Description copied from class: SecurityScheme
      Gets the type of the security scheme.
      Specified by:
      getType in class SecurityScheme
      Returns:
      The security scheme type (e.g., "http", "apiKey")

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getIn

      public ApiKeyLocation getIn()

    • setIn

      public void setIn(ApiKeyLocation in)

    • getInJson

      public String getInJson()
      Gets the location as a string value for backward compatibility.
      Returns:
      The location string value, or null if location is null

    • setInJson

      public void setInJson(String inValue)
      Sets the location from a string value for backward compatibility.
      Parameters:
      inValue - The location string value

    • setInValue

      public void setInValue(String inValue)
      Sets the location from a string value for backward compatibility.
      Parameters:
      inValue - The location string value

    • getInValue

      public String getInValue()

    • getInValueForDataWeave

      public String getInValueForDataWeave()
      Gets the 'in' value for DataWeave serialization. This method exposes the enum value (e.g., "header") for use in DataWeave scripts.
      Returns:
      The 'in' value as a string, or null if 'in' is not set

    • equals

      public boolean equals(Object object)
      Compares this ApiKeySecurityScheme with another object for equality.
      Overrides:
      equals in class SecurityScheme
      Parameters:
      object - The object to compare with
      Returns:
      true if the objects are equal, false otherwise

    • hashCode

      public int hashCode()
      Generates a hash code for this ApiKeySecurityScheme.
      Overrides:
      hashCode in class SecurityScheme
      Returns:
      A hash code value for this object