Package org.javastro.ivoa.entities.resource

Class ServiceInterface

java.lang.Object
org.javastro.ivoa.entities.resource.ServiceInterface
All Implemented Interfaces:
com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
Direct Known Subclasses:
OAIHTTP, ParamHTTP, WebBrowser, WebService
@Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public abstract class ServiceInterface extends Object implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
Additional interface subtypes (beyond WebService and WebBrowser) are defined in the VODataService schema.

Java class for Interface complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="Interface">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="accessURL" type="{http://www.ivoa.net/xml/VOResource/v1.0}AccessURL" maxOccurs="unbounded"/>
         <element name="mirrorURL" type="{http://www.ivoa.net/xml/VOResource/v1.0}MirrorURL" maxOccurs="unbounded" minOccurs="0"/>
         <element name="securityMethod" type="{http://www.ivoa.net/xml/VOResource/v1.0}SecurityMethod" minOccurs="0"/>
         <element name="testQueryString" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
       </sequence>
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="role" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • accessURLs

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected List<AccessURL> accessURLs
      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.

    • mirrorURLs

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected List<MirrorURL> mirrorURLs
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected SecurityMethod securityMethod
      Services not requiring authentication must provide at least one interface definition without a securityMethod defined.

    • testQueryString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected String testQueryString
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected 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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected String role
      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.

    • __cachedModifier__

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") protected transient ServiceInterface.Modifier __cachedModifier__

  • Constructor Details

    • ServiceInterface

      public ServiceInterface()
      Default no-arg constructor

    • ServiceInterface

      public ServiceInterface(List<AccessURL> accessURLs, List<MirrorURL> mirrorURLs, SecurityMethod securityMethod, String testQueryString, String version, String role)
      Fully-initialising value constructor

  • Method Details

    • getAccessURLs

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public List<AccessURL> getAccessURLs()
      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. Gets the value of the accessURLs property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the accessURLs property.

      For example, to add a new item, do as follows: 

       getAccessURLs().add(newItem);

      Objects of the following type(s) are allowed in the list AccessURL

      Returns:
      The value of the accessURLs property.

    • getMirrorURLs

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public List<MirrorURL> getMirrorURLs()
      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. Gets the value of the mirrorURLs property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mirrorURLs property.

      For example, to add a new item, do as follows: 

       getMirrorURLs().add(newItem);

      Objects of the following type(s) are allowed in the list MirrorURL

      Returns:
      The value of the mirrorURLs property.

    • getSecurityMethod

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public SecurityMethod getSecurityMethod()
      Services not requiring authentication must provide at least one interface definition without a securityMethod defined.
      Returns:
      possible object is SecurityMethod

    • setSecurityMethod

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void setSecurityMethod(SecurityMethod value)
      Sets the value of the securityMethod property.
      Parameters:
      value - allowed object is SecurityMethod
      See Also:

    • getTestQueryString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public String getTestQueryString()
      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).
      Returns:
      possible object is String

    • setTestQueryString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void setTestQueryString(String value)
      Sets the value of the testQueryString property.
      Parameters:
      value - allowed object is String
      See Also:

    • getVersion

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public String getVersion()
      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.
      Returns:
      possible object is String

    • setVersion

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void setVersion(String value)
      Sets the value of the version property.
      Parameters:
      value - allowed object is String
      See Also:

    • getRole

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public String getRole()
      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.
      Returns:
      possible object is String

    • setRole

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void setRole(String value)
      Sets the value of the role property.
      Parameters:
      value - allowed object is String
      See Also:

    • equals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public String toString()
      Overrides:
      toString in class Object

    • append

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      append in interface org.jvnet.jaxb.lang.ToString

    • appendFields

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb.lang.ToString

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void mergeFrom(Object left, Object right)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • clone

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface clone()
      Overrides:
      clone in class Object

    • createCopy

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface createCopy()
      Specified by:
      createCopy in interface com.kscs.util.jaxb.Copyable

    • createCopy

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Specified by:
      createCopy in interface com.kscs.util.jaxb.PartialCopyable

    • copyExcept

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
      Specified by:
      copyExcept in interface com.kscs.util.jaxb.PartialCopyable

    • copyOnly

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
      Specified by:
      copyOnly in interface com.kscs.util.jaxb.PartialCopyable

    • modifier

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface.Modifier modifier()

    • copyTo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public <_B> void copyTo(ServiceInterface.Builder<_B> _other)
      Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.
      Parameters:
      _other - A builder instance to which the state of this object will be copied.

    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public abstract <_B> ServiceInterface.Builder<_B> newCopyBuilder(_B _parentBuilder)

    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public abstract ServiceInterface.Builder<Void> newCopyBuilder()

    • copyTo

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public <_B> void copyTo(ServiceInterface.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
      Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.
      Parameters:
      _other - A builder instance to which the state of this object will be copied.

    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public abstract <_B> ServiceInterface.Builder<_B> newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

    • newCopyBuilder

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public abstract ServiceInterface.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

    • visit

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2025-06-24T19:08:06+01:00") public ServiceInterface visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)