tap.resource

Interface VOSIResource

All Known Implementing Classes:

Availability, Capabilities, Examples, TAP, TAPMetadata

public interface VOSIResource

VOSI - VO Support Interfaces - lets describe a minimal interface that VO web services should provide.

This interface aims to give information about the capabilities, the availability and the reliability of the service. To reach this goal the 3 following endpoints (resources) should be provided:

1. Capability metadata: list all available resources, give their access URL and a standard ID (helping to identify the type of resource). More information related to the service itself (or about the VO standard it is implementing) may be provided.
2. Availability metadata: indicate whether the service is available or not. It may also provide a note and some other information about its reliability, such as the date at which it is up, or since when it is down and when it will be back.
3. Tables metadata: since some VO services deal with tabular data (in output, in input or queriable by a language like ADQL), a VOSI-compliant service shall provide a list and a description of them.

Implementing the VOSI interface means that each service endpoint/resource must be described in the capability endpoint with an access URL and a standard VO ID.

The standard IDs of the VOSI endpoints are the following:

• Capabilities: ivo://ivoa.net/std/VOSI#capabilities
• Availability: ivo://ivoa.net/std/VOSI#availability
• Tables: ivo://ivoa.net/std/VOSI#tables

Version:

2.0 (09/2014)

Author:

Grégory Mantelet (CDS;ARI)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessURL() Get the URL which lets access this resource.
java.lang.String	getCapability() Get the capabilities of this resource.
java.lang.String	getStandardID() Get the standardID of this endpoint of the VOSI interface.

Method Detail

getCapability

java.lang.String getCapability()

Get the capabilities of this resource.

Returns:

Resource capabilities.

getAccessURL

java.lang.String getAccessURL()

Get the URL which lets access this resource.

Returns:

Access URL.

getStandardID

java.lang.String getStandardID()

Get the standardID of this endpoint of the VOSI interface.

The standard IDs of the VOSI endpoints are the following:

• Capabilities: ivo://ivoa.net/std/VOSI#capabilities
• Availability: ivo://ivoa.net/std/VOSI#availability
• Tables: ivo://ivoa.net/std/VOSI#tables

Returns:

Standard ID of this VOSI endpoint.