Package org.javastro.ivoa.entities.resource.dataservice

Class ParamHTTP

java.lang.Object

org.javastro.ivoa.entities.resource.ServiceInterface

org.javastro.ivoa.entities.resource.dataservice.ParamHTTP

All Implemented Interfaces:

com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public class ParamHTTP
extends ServiceInterface
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

Note that the URL for help with this service can be put into the service/referenceURL element.

Java class for ParamHTTP complex type

.

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

 <complexType name="ParamHTTP">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VOResource/v1.0}Interface">
       <sequence>
         <element name="queryType" type="{http://www.ivoa.net/xml/VODataService/v1.1}HTTPQueryType" maxOccurs="2" minOccurs="0"/>
         <element name="resultType" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="param" type="{http://www.ivoa.net/xml/VODataService/v1.1}InputParam" maxOccurs="unbounded" minOccurs="0"/>
         <element name="testQuery" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParamHTTP.Builder<_B>
class	ParamHTTP.Modifier
static class	ParamHTTP.PropInfo
static class	ParamHTTP.Select
static class	ParamHTTP.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<InputParam>	params	A description of a input parameter that can be provided as a name=value argument to the service.
protected List<HTTPQueryType>	queryTypes	The service may indicate support for both GET and POST by providing 2 queryType elements, one with GET and one with POST.
protected String	resultType	The MIME media type of a document returned in the HTTP response.
protected String	testQuery	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.

Fields inherited from class org.javastro.ivoa.entities.resource.ServiceInterface

__cachedModifier__, accessURLs, mirrorURLs, role, securityMethod, testQueryString, version

Constructor Summary

Constructors

Constructor	Description
ParamHTTP()	Default no-arg constructor
ParamHTTP(List<AccessURL> accessURLs, List<MirrorURL> mirrorURLs, SecurityMethod securityMethod, String testQueryString, String version, String role, List<HTTPQueryType> queryTypes, String resultType, List<InputParam> params, String testQuery)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
static ParamHTTP.Builder<Void>	builder()
ParamHTTP	clone()
ParamHTTP	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ParamHTTP.Builder<Void>	copyExcept(ParamHTTP _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ParamHTTP.Builder<Void>	copyExcept(ServiceInterface _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> ParamHTTP.Builder<_B>	copyOf(ParamHTTP _other)
static <_B> ParamHTTP.Builder<_B>	copyOf(ParamHTTP _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> ParamHTTP.Builder<_B>	copyOf(ServiceInterface _other)
static <_B> ParamHTTP.Builder<_B>	copyOf(ServiceInterface _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ParamHTTP	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static ParamHTTP.Builder<Void>	copyOnly(ParamHTTP _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static ParamHTTP.Builder<Void>	copyOnly(ServiceInterface _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(ParamHTTP.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(ParamHTTP.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
ParamHTTP	createCopy()
ParamHTTP	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
List<InputParam>	getParams()	A description of a input parameter that can be provided as a name=value argument to the service.
List<HTTPQueryType>	getQueryTypes()	The service may indicate support for both GET and POST by providing 2 queryType elements, one with GET and one with POST.
String	getResultType()	The MIME media type of a document returned in the HTTP response.
String	getTestQuery()	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.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
ParamHTTP.Modifier	modifier()
ParamHTTP.Builder<Void>	newCopyBuilder()
<_B> ParamHTTP.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> ParamHTTP.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
ParamHTTP.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setResultType(String value)	Sets the value of the resultType property.
void	setTestQuery(String value)	Sets the value of the testQuery property.
String	toString()
ParamHTTP	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class org.javastro.ivoa.entities.resource.ServiceInterface

copyTo, copyTo, getAccessURLs, getMirrorURLs, getRole, getSecurityMethod, getTestQueryString, getVersion, setRole, setSecurityMethod, setTestQueryString, setVersion

Methods inherited from class java.lang.Object

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

Field Details

queryTypes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
protected List<HTTPQueryType> queryTypes

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

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
protected String resultType

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

params

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
protected List<InputParam> params

A description of a input parameter that can be provided as a name=value argument to the service.

testQuery

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
protected String testQuery

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.

Constructor Details

ParamHTTP

public ParamHTTP()

Default no-arg constructor

ParamHTTP

public ParamHTTP(List<AccessURL> accessURLs,
 List<MirrorURL> mirrorURLs,
 SecurityMethod securityMethod,
 String testQueryString,
 String version,
 String role,
 List<HTTPQueryType> queryTypes,
 String resultType,
 List<InputParam> params,
 String testQuery)

Fully-initialising value constructor

Method Details

getQueryTypes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public List<HTTPQueryType> getQueryTypes()

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. Gets the value of the queryTypes 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 queryTypes property.

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

 getQueryTypes().add(newItem);
 

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

Returns:

The value of the queryTypes property.

getResultType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public String getResultType()

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

Returns:

possible object is String

setResultType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public void setResultType(String value)

Sets the value of the resultType property.

Parameters:

value - allowed object is String

See Also:

• getResultType()

getParams

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public List<InputParam> getParams()

A description of a input parameter that can be provided as a name=value argument to the service. Gets the value of the params 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 params property.

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

 getParams().add(newItem);
 

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

Returns:

The value of the params property.

getTestQuery

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public String getTestQuery()

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.

Returns:

possible object is String

setTestQuery

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public void setTestQuery(String value)

Sets the value of the testQuery property.

Parameters:

value - allowed object is String

See Also:

• getTestQuery()

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public boolean equals(Object object)

Overrides:

equals in class ServiceInterface

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public int hashCode()

Overrides:

hashCode in class ServiceInterface

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public String toString()

Overrides:

toString in class ServiceInterface

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+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

Overrides:

append in class ServiceInterface

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+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

Overrides:

appendFields in class ServiceInterface

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class ServiceInterface

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+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

Overrides:

mergeFrom in class ServiceInterface

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

clone

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP clone()

Overrides:

clone in class ServiceInterface

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP createCopy()

Specified by:

createCopy in interface com.kscs.util.jaxb.Copyable

Overrides:

createCopy in class ServiceInterface

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

createCopy in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

createCopy in class ServiceInterface

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyExcept in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

copyExcept in class ServiceInterface

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyOnly in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

copyOnly in class ServiceInterface

modifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP.Modifier modifier()

Overrides:

modifier in class ServiceInterface

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public <_B> void copyTo(ParamHTTP.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-08-12T08:31:32+01:00")
public <_B> ParamHTTP.Builder<_B> newCopyBuilder(_B _parentBuilder)

Specified by:

newCopyBuilder in class ServiceInterface

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP.Builder<Void> newCopyBuilder()

Specified by:

newCopyBuilder in class ServiceInterface

builder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static ParamHTTP.Builder<Void> builder()

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static <_B> ParamHTTP.Builder<_B> copyOf(ServiceInterface _other)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static <_B> ParamHTTP.Builder<_B> copyOf(ParamHTTP _other)

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public <_B> void copyTo(ParamHTTP.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-08-12T08:31:32+01:00")
public <_B> ParamHTTP.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

newCopyBuilder in class ServiceInterface

newCopyBuilder

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

Specified by:

newCopyBuilder in class ServiceInterface

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static <_B> ParamHTTP.Builder<_B> copyOf(ServiceInterface _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static <_B> ParamHTTP.Builder<_B> copyOf(ParamHTTP _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static ParamHTTP.Builder<Void> copyExcept(ServiceInterface _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static ParamHTTP.Builder<Void> copyExcept(ParamHTTP _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static ParamHTTP.Builder<Void> copyOnly(ServiceInterface _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public static ParamHTTP.Builder<Void> copyOnly(ParamHTTP _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

visit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-08-12T08:31:32+01:00")
public ParamHTTP visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Overrides:

visit in class ServiceInterface