tap.resource

Class Sync

java.lang.Object

tap.resource.Sync

All Implemented Interfaces:

TAPResource

public class Sync
extends java.lang.Object
implements TAPResource

Synchronous resource of a TAP service.

Requests sent to this resource can be either to get the capabilities of the TAP service (which should actually be accessed with the resource /capabilities) or to execute synchronously an ADQL query. For the second case, "synchronously" means that result or error is returned immediately when the execution ends. Besides, generally, the execution time is much more limited than an asynchronous query.

Version:

2.1 (01/2016)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected Capabilities	capabilities List of all capabilities of the TAP service.
static java.lang.String	RESOURCE_NAME Name of this TAP resource.
protected ServiceConnection	service Description of the TAP service owning this resource.

Constructor Summary

Constructors

Constructor and Description
Sync(ServiceConnection service, Capabilities capabilities) Build a synchronous resource for the TAP service whose the description and the capabilities are provided in parameters.

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	getName() Get the name of this TAP resource.
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 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

service

protected final ServiceConnection service

Description of the TAP service owning this resource.

capabilities

protected final Capabilities capabilities

List of all capabilities of the TAP service.

Constructor Detail

Sync

public Sync(ServiceConnection service,
            Capabilities capabilities)

Build a synchronous resource for the TAP service whose the description and the capabilities are provided in parameters.

Parameters:

service - Description of the TAP service which will own this resource.

capabilities - Capabilities of the TAP service.

Method Detail

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.

setTAPBaseURL

public 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.

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

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.