Package ca.cdr.test.app.harness.api

Record Class HarnessContext

java.lang.Object
java.lang.Record
ca.cdr.test.app.harness.api.HarnessContext
Record Components:
protocol - The connection protocol. Values are `http` or `https`
baseUrl - The base URL of the Smile CDR instance, e.g. `127.0.0.1` or `localhost`
jsonAdminPort - The port number for the administrative JSON API. If null, will attempt to auto-discover based on the properties file.
username - The username for authentication
password - The password for authentication
public record HarnessContext(String protocol, String baseUrl, @Nullable Integer jsonAdminPort, String username, String password) extends Record
Record class that holds configuration information for connecting to a Smile CDR instance. This context can be used by SmileHarness implementations to establish connections to the CDR.

  • Constructor Details

    • HarnessContext

      public HarnessContext(String protocol, String baseUrl, @Nullable Integer jsonAdminPort, String username, String password)
      Creates an instance of a HarnessContext record class.
      Parameters:
      protocol - the value for the protocol record component
      baseUrl - the value for the baseUrl record component
      jsonAdminPort - the value for the jsonAdminPort record component
      username - the value for the username record component
      password - the value for the password record component

  • Method Details

    • oobeHarnessContext

      public static HarnessContext oobeHarnessContext()
      Factory method that creates a default HarnessContext for connecting to a local Smile CDR instance. This method provides predefined values for a standard out-of-box-experience (OOBE) setup. If you haven't provided a custom properties file, this harness context should be used. If you have customized users/endpoints, you should build your own HarnessContext.
      Returns:
      A HarnessContext configured with default values for localhost connection

    • getContextRoot

      public String getContextRoot()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • protocol

      public String protocol()
      Returns the value of the protocol record component.
      Returns:
      the value of the protocol record component

    • baseUrl

      public String baseUrl()
      Returns the value of the baseUrl record component.
      Returns:
      the value of the baseUrl record component

    • jsonAdminPort

      @Nullable public Integer jsonAdminPort()
      Returns the value of the jsonAdminPort record component.
      Returns:
      the value of the jsonAdminPort record component

    • username

      public String username()
      Returns the value of the username record component.
      Returns:
      the value of the username record component

    • password

      public String password()
      Returns the value of the password record component.
      Returns:
      the value of the password record component