public class HomePage extends ForwardResource
Write the content of the TAP service's home page.
Note:
This class is using the two following TAP attributes in order to display the home page:
TAP.homePageURI and TAP.homePageMimeType. The MIME type is used only for the third case below (local file).
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).
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
RESOURCE_NAME
Name of this TAP resource.
|
protected TAP |
tap
TAP service owning this resource.
|
logger| 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.
|
forward, logErrorpublic static final java.lang.String RESOURCE_NAME
protected final TAP tap
public HomePage(TAP tap)
public void init(javax.servlet.ServletConfig config)
throws javax.servlet.ServletException
TAPResourceconfig - Servlet configuration. (may be useful for the configuration of this resource)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.public void destroy()
TAPResourcepublic void setTAPBaseURL(java.lang.String baseURL)
TAPResourceLet 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).
baseURL - Common URL/URI used in all requests sent by any user to the TAP service.public final java.lang.String getName()
TAPResourceGet the name of this TAP resource.
Important note: This name MUST NOT be NULL and SHOULD NEVER change.
public boolean executeResource(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException,
TAPException
TAPResourceInterpret 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).
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.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.