uws.service.actions
Class ShowHomePage<JL extends JobList<J>,J extends AbstractJob>

java.lang.Object
  uws.service.actions.UWSAction<JL,J>
      uws.service.actions.ShowHomePage<JL,J>

All Implemented Interfaces:

java.io.Serializable

public class ShowHomePage<JL extends JobList<J>,J extends AbstractJob>
extends UWSAction<JL,J>

The "Show UWS Home Page" action of a UWS.

Note: The corresponding name is UWSAction.HOME_PAGE.

This action displays the UWS home page.

Version:

01/2011

Author:

Grégory Mantelet (CDS)

See Also:

Serialized Form

Field Summary

Fields inherited from class uws.service.actions.UWSAction

ADD_JOB, DESTROY_JOB, GET_JOB_PARAM, HOME_PAGE, JOB_SUMMARY, LIST_JOBS, SET_JOB_PARAM, uws

Constructor Summary

ShowHomePage(AbstractUWS<JL,J> u)

Method Summary

boolean	apply(UWSUrl urlInterpreter, java.lang.String userId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Writes the UWS home page in the given HttpServletResponse. 3 cases are possible: Default home page (AbstractUWS.isDefaultHomePage() returns true): write the appropriate (considering the Accept header of the HTTP-Request) serialization of this UWS.
java.lang.String	getDescription() Gets the description of this UWS action.
java.lang.String	getName() Gets the name of this UWS action.
boolean	match(UWSUrl urlInterpreter, java.lang.String userId, javax.servlet.http.HttpServletRequest request) Checks whether there is no jobs list name.

Methods inherited from class uws.service.actions.UWSAction

equals, getJob, getJob, getJobsList, getUWS, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowHomePage

public ShowHomePage(AbstractUWS<JL,J> u)

Method Detail

getName

public java.lang.String getName()

Description copied from class: UWSAction

Gets the name of this UWS action. MUST BE UNIQUE !

Note: By default the name of the class is returned (Class.getName()).

Overrides:

getName in class UWSAction<JL extends JobList<J>,J extends AbstractJob>

Returns:

Its name.

See Also:

UWSAction.HOME_PAGE, UWSAction.getName()

getDescription

public java.lang.String getDescription()

Description copied from class: UWSAction

Gets the description of this UWS action.

Note: By default an empty string is returned.

Overrides:

getDescription in class UWSAction<JL extends JobList<J>,J extends AbstractJob>

Returns:

Its description.

match

public boolean match(UWSUrl urlInterpreter,
                     java.lang.String userId,
                     javax.servlet.http.HttpServletRequest request)
              throws UWSException

Checks whether there is no jobs list name.

Specified by:

match in class UWSAction<JL extends JobList<J>,J extends AbstractJob>

Parameters:

urlInterpreter - The UWS URL of the given request.

userId - The user who has sent the given request.

request - The received request.

Returns:

true if the given request corresponds to this UWS action, false otherwise.

Throws:

UWSException - If any error occurs during the tests.

See Also:

UWSAction.match(uws.service.UWSUrl, java.lang.String, javax.servlet.http.HttpServletRequest)

apply

public boolean apply(UWSUrl urlInterpreter,
                     java.lang.String userId,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws UWSException,
                     java.io.IOException

Writes the UWS home page in the given HttpServletResponse. 3 cases are possible:

• Default home page (AbstractUWS.isDefaultHomePage() returns true): write the appropriate (considering the Accept header of the HTTP-Request) serialization of this UWS.
• Home redirection (AbstractUWS.isHomePageRedirection() = true): call AbstractUWS.redirect(String, HttpServletRequest, HttpServletResponse) with the AbstractUWS.getHomePage() URL.
• Otherwise ((AbstractUWS.isHomePageRedirection() = false)): read the content of the resource at the AbstractUWS.getHomePage() URL and copy it in the given HttpServletResponse.

Specified by:

apply in class UWSAction<JL extends JobList<J>,J extends AbstractJob>

Parameters:

urlInterpreter - The UWS URL of the given request.

userId - The user who has sent the given request.

request - The received request.

response - The response of the given request (MUST BE UPDATED).

Returns:

true if the actions has been successfully applied, false otherwise.

Throws:

UWSException - If there is an error, mainly during the redirection.

java.io.IOException - If there is an error while reading at a custom home page URL or while writing in the given HttpServletResponse.

See Also:

UWSAction.apply(uws.service.UWSUrl, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), AbstractUWS.redirect(String, HttpServletRequest, HttpServletResponse)