Package org.ivoa.dm.registry.voresource

Class WebService

java.lang.Object
org.ivoa.dm.registry.voresource.Interface
org.ivoa.dm.registry.voresource.WebService
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="VOResource:WebService", role=objectType) public class WebService extends Interface implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
A Web Service that is describable by a WSDL document. The accessURL element gives the Web Service's endpoint URL. objectType: WebService

  • Field Details

    • wsdlURL

      @VoDml(id="VOResource:WebService.wsdlURL", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected List<String> wsdlURL
      The location of the WSDL that describes this Web Service. If not provided, the location is assumed to be the accessURL with '?wsdl' appended. Multiple occurrences should represent mirror copies of the same WSDL file. : Attribute wsdlURL : multiplicity 0..*

  • Constructor Details

    • WebService

      public WebService()
      Creates a new WebService

    • WebService

      public WebService(List<String> wsdlURL, List<AccessURL> accessURL, List<MirrorURL> mirrorURL, List<SecurityMethod> securityMethod, String testQueryString, String version, String role)
      full parameter constructor.
      Parameters:
      wsdlURL - The location of the WSDL that describes this Web Service. If not provided, the location is assumed to be the accessURL with '?wsdl' appended. Multiple occurrences should represent mirror copies of the same WSDL file.
      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 - 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 - 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 - 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 - 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 - 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.

    • WebService

      public WebService(WebService other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • WebService

      public WebService(Interface superinstance, List<String> wsdlURL)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      wsdlURL - The location of the WSDL that describes this Web Service. If not provided, the location is assumed to be the accessURL with '?wsdl' appended. Multiple occurrences should represent mirror copies of the same WSDL file.

  • Method Details

    • copyMe

      public Interface copyMe()
      make a clone of the object taking into account current polymorhic type.
      Specified by:
      copyMe in class Interface
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(WebService other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getWsdlURL

      public List<String> getWsdlURL()
      Returns wsdlURL Attribute.
      Returns:
      wsdlURL Attribute

    • setWsdlURL

      public void setWsdlURL(List<String> pWsdlURL)
      Set wsdlURL Attribute.
      Parameters:
      pWsdlURL - value to set

    • withWsdlURL

      public WebService withWsdlURL(List<String> pWsdlURL)
      fluent setter for wsdlURL Attribute.
      Parameters:
      pWsdlURL - value to set
      Returns:
      WebService

    • createWebService

      public static WebService createWebService(Consumer<WebService.WebServiceBuilder> f)
      create a WebService in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations
      Overrides:
      forceLoad in class Interface

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>