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:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class ParamHTTP
extends ServiceInterface
implements 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>
 

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

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)
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)
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	withAccessURLs(Collection<AccessURL> values)
ParamHTTP	withAccessURLs(AccessURL... values)
ParamHTTP	withMirrorURLs(Collection<MirrorURL> values)
ParamHTTP	withMirrorURLs(MirrorURL... values)
ParamHTTP	withParams(Collection<InputParam> values)
ParamHTTP	withParams(InputParam... values)
ParamHTTP	withQueryTypes(Collection<HTTPQueryType> values)
ParamHTTP	withQueryTypes(HTTPQueryType... values)
ParamHTTP	withResultType(String value)
ParamHTTP	withRole(String value)
ParamHTTP	withSecurityMethod(SecurityMethod value)
ParamHTTP	withTestQuery(String value)
ParamHTTP	withTestQueryString(String value)
ParamHTTP	withVersion(String value)

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

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

Methods inherited from class java.lang.Object

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

Field Details

queryTypes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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

withQueryTypes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withQueryTypes(HTTPQueryType... values)

withQueryTypes

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withQueryTypes(Collection<HTTPQueryType> values)

withResultType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withResultType(String value)

withParams

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withParams(InputParam... values)

withParams

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withParams(Collection<InputParam> values)

withTestQuery

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withTestQuery(String value)

withAccessURLs

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withAccessURLs(AccessURL... values)

Overrides:

withAccessURLs in class ServiceInterface

withAccessURLs

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withAccessURLs(Collection<AccessURL> values)

Overrides:

withAccessURLs in class ServiceInterface

withMirrorURLs

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withMirrorURLs(MirrorURL... values)

Overrides:

withMirrorURLs in class ServiceInterface

withMirrorURLs

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withMirrorURLs(Collection<MirrorURL> values)

Overrides:

withMirrorURLs in class ServiceInterface

withSecurityMethod

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withSecurityMethod(SecurityMethod value)

Overrides:

withSecurityMethod in class ServiceInterface

withTestQueryString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withTestQueryString(String value)

Overrides:

withTestQueryString in class ServiceInterface

withVersion

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withVersion(String value)

Overrides:

withVersion in class ServiceInterface

withRole

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ParamHTTP withRole(String value)

Overrides:

withRole in class ServiceInterface

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+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="2024-08-01T13:15:43+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="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

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