tap.resource

Class Examples

java.lang.Object

tap.resource.ForwardResource

tap.resource.Examples

All Implemented Interfaces:

TAPResource, VOSIResource

public class Examples
extends ForwardResource
implements VOSIResource

Additional TAP endpoint: /examples. Then, this TAPResource writes a list of TAP examples.

The returned document MUST be a RDFa document as requested by the IVOA documents: TAPNote 1.0 or DALI 1.0. The syntax used in the returned document is thus expected to be one of those described by the two IVOA documents ; for now no particular syntax has been fixed by the IVOA community.

This TAP endpoint is also a VOSI resource. A capability is then provided thanks to the function getCapability(). The returned capability is the following:

<capability standardID="ivo://ivoa.net/std/DALI#examples>
     <interface xsi:type="vr:WebBrowser" role="std">
               <accessURL use="full">
             <-- Full URL of the TAP service suffixed by "/examples" -->
               </accessURL>
           </interface>
  </capability>

The home page URI is expected to be either relative/absolute path (both related to the Web Application directory, NOT the local file system), a file: URI (pointing toward a local file system file) or a URL (basically any URI whose the scheme is not file:).

To read/write the specified file, this class extends ForwardResource in order to use its function ForwardResource.forward(String, String, HttpServletRequest, HttpServletResponse).

Since:

2.1

Version:

2.1 (11/2015)

Author:

Grégory Mantelet (ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accessURL URL toward this TAP resource.
java.lang.String	examplesFile File containing the /examples endpoint content.
static java.lang.String	MIME_TYPE MIME type of this resource.
static java.lang.String	RESOURCE_NAME Name of this TAP resource.
static java.lang.String	STANDARD_ID Standard ID of this VOSI resource.

Fields inherited from class tap.resource.ForwardResource

logger

Constructor Summary

Constructors

Constructor and Description
Examples(TAP tap, java.lang.String file) Build an /examples endpoint whose the content is provided by the specified file.

Method Summary

Modifier and Type	Method and Description
void	destroy() Let free properly all system/file/DB resources kept opened by this TAP resource.
boolean	executeResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Interpret the given request, execute the appropriate action and finally return a result or display information to the user.
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	getName() Get the name of this TAP resource.
java.lang.String	getStandardID() Get the standardID of this endpoint of the VOSI interface.
void	init(javax.servlet.ServletConfig config) Let initialize this TAP resource.
void	setTAPBaseURL(java.lang.String baseURL) Let diffuse the base URL of the TAP service to all its TAP resources.

Methods inherited from class tap.resource.ForwardResource

forward, logError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

Name of this TAP resource.

See Also:

Constant Field Values

STANDARD_ID

public static final java.lang.String STANDARD_ID

Standard ID of this VOSI resource.

See Also:

Constant Field Values

MIME_TYPE

public static final java.lang.String MIME_TYPE

MIME type of this resource.

See Also:

Constant Field Values

examplesFile

public final java.lang.String examplesFile

File containing the /examples endpoint content.

accessURL

protected java.lang.String accessURL

URL toward this TAP resource. This URL is particularly important for its declaration in the capabilities of the TAP service.

Note: By default, it is just the name of this resource. It is updated after initialization of the service when the TAP service base URL is communicated to its resources. Then, it is: baseTAPURL + "/" + RESOURCE_NAME.

Constructor Detail

Examples

public Examples(TAP tap,
                java.lang.String file)
         throws java.lang.NullPointerException

Build an /examples endpoint whose the content is provided by the specified file.

Parameters:

tap - The TAP service whose the logger must be used.

file - The file containing the content of this endpoint. It must be a URI with no scheme to reference a file inside the Web Application directory, with the scheme file: to reference a local system file or with another scheme to make an explicit redirection toward the specified URL.

Throws:

java.lang.NullPointerException - If at least one of the parameters is missing.

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Description copied from interface: TAPResource

Let initialize this TAP resource.

Specified by:

init in interface TAPResource

Parameters:

config - Servlet configuration. (may be useful for the configuration of this resource)

Throws:

javax.servlet.ServletException - If any error prevent the initialization of this TAP resource. In case a such exception is thrown, the service should stop immediately.

destroy

public void destroy()

Description copied from interface: TAPResource

Let free properly all system/file/DB resources kept opened by this TAP resource.

Specified by:

destroy in interface TAPResource

setTAPBaseURL

public final void setTAPBaseURL(java.lang.String baseURL)

Description copied from interface: TAPResource

Let diffuse the base URL of the TAP service to all its TAP resources.

Important note: This function should be called just once: either at the creation of the service or when the first request is sent to the TAP service (in this case, the request is also used to finish the initialization of the TAP service, and of all its resources).

Specified by:

setTAPBaseURL in interface TAPResource

Parameters:

baseURL - Common URL/URI used in all requests sent by any user to the TAP service.

getName

public java.lang.String getName()

Description copied from interface: TAPResource

Get the name of this TAP resource.

Important note: This name MUST NOT be NULL and SHOULD NEVER change.

Specified by:

getName in interface TAPResource

Returns:

Name of this TAP resource.

getCapability

public java.lang.String getCapability()

Description copied from interface: VOSIResource

Get the capabilities of this resource.

Specified by:

getCapability in interface VOSIResource

Returns:

Resource capabilities.

getAccessURL

public java.lang.String getAccessURL()

Description copied from interface: VOSIResource

Get the URL which lets access this resource.

Specified by:

getAccessURL in interface VOSIResource

Returns:

Access URL.

getStandardID

public final java.lang.String getStandardID()

Description copied from interface: VOSIResource

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

Specified by:

getStandardID in interface VOSIResource

Returns:

Standard ID of this VOSI endpoint.

executeResource

public boolean executeResource(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.io.IOException,
                               TAPException

Description copied from interface: TAPResource

Interpret the given request, execute the appropriate action and finally return a result or display information to the user.

IMPORTANT: "TAP resources can not take the law in their own hands!" :-) Errors that could occur inside this function should not be written directly in the given HttpServletResponse. They should be thrown to the resources executor: an instance of TAP, which will fill the HttpServletResponse with the error in the format described by the IVOA standard - VOTable. Besides, TAP may also add more information and may log the error (in function of this type).

Specified by:

executeResource in interface TAPResource

Parameters:

request - Request sent by the user and which should be interpreted/executed here.

response - Response in which the result of the request must be written.

Returns:

true if the request has been successfully executed, false otherwise (but generally an exception will be sent if the request can't be executed).

Throws:

java.io.IOException - If any error occurs while writing the result of the given request.

TAPException - If any other error occurs while interpreting and executing the request or by formating and writing its result.