Package org.odpi.openmetadata.adapters.connectors.wso2mi.properties

Class APIInfo

java.lang.Object
org.odpi.openmetadata.adapters.connectors.wso2mi.properties.APIInfo
public class APIInfo extends Object
APIInfo describes a single REST API deployed on a WSO2 Micro Integrator, as returned by the Management API's GET /management/apis resource. Only the fields needed to catalog the API as an open metadata asset are modelled here; unknown fields returned by newer WSO2 versions are ignored.

  • Constructor Summary

    Constructors
    Constructor
    Description
    APIInfo()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getName()
    Return the name of the API.
    String
    getStats()
    Return whether statistics collection is enabled for the API ("enabled" / "disabled").
    String
    getTracing()
    Return whether message tracing is enabled for the API ("enabled" / "disabled").
    String
    getUrl()
    Return the invocation URL for the API (the context path exposed by the Micro Integrator).
    String
    getVersion()
    Return the API version, if the Micro Integrator reports one.
    int
    hashCode()
    Return a hash code based on the values of this object.
    void
    setName(String name)
    Set up the name of the API.
    void
    setStats(String stats)
    Set up whether statistics collection is enabled for the API.
    void
    setTracing(String tracing)
    Set up whether message tracing is enabled for the API.
    void
    setUrl(String url)
    Set up the invocation URL for the API.
    void
    setVersion(String version)
    Set up the API version.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • APIInfo

      public APIInfo()
      Default constructor.

  • Method Details

    • getName

      public String getName()
      Return the name of the API. This is the unique identifier of the API within the Micro Integrator.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the name of the API.
      Parameters:
      name - string name

    • getUrl

      public String getUrl()
      Return the invocation URL for the API (the context path exposed by the Micro Integrator).
      Returns:
      string URL

    • setUrl

      public void setUrl(String url)
      Set up the invocation URL for the API.
      Parameters:
      url - string URL

    • getVersion

      public String getVersion()
      Return the API version, if the Micro Integrator reports one.
      Returns:
      string version

    • setVersion

      public void setVersion(String version)
      Set up the API version.
      Parameters:
      version - string version

    • getTracing

      public String getTracing()
      Return whether message tracing is enabled for the API ("enabled" / "disabled").
      Returns:
      string flag

    • setTracing

      public void setTracing(String tracing)
      Set up whether message tracing is enabled for the API.
      Parameters:
      tracing - string flag

    • getStats

      public String getStats()
      Return whether statistics collection is enabled for the API ("enabled" / "disabled").
      Returns:
      string flag

    • setStats

      public void setStats(String stats)
      Set up whether statistics collection is enabled for the API.
      Parameters:
      stats - string flag

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class Object
      Returns:
      string with the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code