Package org.ivoa.dm.registry.vodataservice

Class ParamHTTP.ParamHTTPBuilder

java.lang.Object
org.ivoa.dm.registry.vodataservice.ParamHTTP.ParamHTTPBuilder
Enclosing class:
ParamHTTP
public static class ParamHTTP.ParamHTTPBuilder extends Object
A builder class for ParamHTTP, mainly for use in the functional builder pattern.

  • Field Details

    • queryType

      public HTTPQueryType[] queryType
      The type of HTTP request, either GET or POST. The service may indicate support for both GET and POST by providing 2 queryType elements, one with GET and one with POST. Since the IVOA standard DALI requires standard services to support both GET and POST, this piece of metadata is not useful in the description of standard DAL services and does not need to be given for those.

    • resultType

      public String resultType
      The MIME media type of a document returned in the HTTP response.

    • param

      public List<InputParam> param
      A description of a input parameter that can be provided as a name=value argument to the service.

    • testQuery

      public String testQuery
      An ampersand-delimited list of arguments that can be used to test this service interface; when provided as the input to this interface, it will produce a legal, non-null response. When the interface supports GET, then the full query URL is formed by the concatenation of the base URL (given by the accessURL) and the value given by this testQuery element.

    • accessURL

      public List<AccessURL> accessURL
      The URL (or base URL) that a client uses to access the service. How this URL is to be interpreted and used depends on the specific Interface subclass Although the schema allows multiple occurrences of accessURL, multiple accessURLs are deprecated. Each interface should have exactly one access URL. Where an interface has several mirrors, the accessURL should reflect the “primary” (fastest, best-connected, best-maintained) site, the one that non-sophisticated clients will go to. Additional accessURLs should be put into mirrorURLs. Advanced clients can retrieve the mirrorURLs and empirically determine interfaces closer to their network location.

    • mirrorURL

      public List<MirrorURL> mirrorURL
      A (base) URL of a mirror of this interface. As with accessURL, how this URL is to be interpreted and used depends on the specific Interface subclass This is intended exclusively for true mirrors, i.e., interfaces that are functionally identical to the original interface and that are operated by the same publisher. Other arrangements should be represented as separate services linked by mirror-of relationships.

    • securityMethod

      public List<SecurityMethod> securityMethod
      The mechanism the client must employ to authenticate to the service. Services not requiring authentication must provide at least one interface definition without a securityMethod defined.

    • testQueryString

      public String testQueryString
      Test data for exercising the service. This contains data that can be passed to the interface to retrieve a non-empty result. This can be used by validators within test suites. Exactly how agents should use the data contained in the testQueryString depends on the concrete interface class. For interfaces employing the HTTP GET method, however, this will typically be urlencoded parameters (as for the application/x-www-form-urlencoded media type).

    • version

      public String version
      The version of a standard interface specification that this interface complies with. Most VO standards indicate the version in the standardID attribute of the capability. For these standards, the version attribute should not be used.

    • role

      public String role
      A tag name that identifies the role the interface plays in the particular capability. If the value is equal to 'std' or begins with 'std:', then the interface refers to a standard interface defined by the standard referred to by the capability's standardID attribute. For an interface complying with some registered standard (i.e. has a legal standardID), the role can be matched against interface roles enumerated in standard resource record. The interface descriptions in the standard record can provide default descriptions so that such details need not be repeated here.

  • Constructor Details

    • ParamHTTPBuilder

      public ParamHTTPBuilder()

  • Method Details

    • create

      public ParamHTTP create()
      create a ParamHTTP from this builder.
      Returns:
      an object initialized from the builder.