com.buglabs.bug.service
Class AbstractWSServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.buglabs.bug.service.AbstractWSServlet

All Implemented Interfaces:

java.io.Serializable, Servlet, ServletConfig

Direct Known Subclasses:

WSHtmlServlet, WSServlet

public abstract class AbstractWSServlet
extends HttpServlet

Abstract class to hold common functionality for different Service views currently extended by WSServlet (default, xml view) and WSHtmlServlet (html view)

See Also:

Serialized Form

Constructor Summary

AbstractWSServlet(BundleContext context, java.util.Hashtable serviceMap, ConfigurationAdmin configAdmin)

AbstractWSServlet(BundleContext context, java.util.Map serviceMap)

Method Summary

void	addPublicService(PublicWSProvider provider)
protected void	doDelete(HttpServletRequest req, HttpServletResponse resp) Called by the server (via the service method) to allow a servlet to handle a DELETE request.
protected void	doGet(HttpServletRequest req, HttpServletResponse resp) all the main entry points by default call executeHttpMethod, but these methods can be overridden in the implementor if a different behavior is desired
protected void	doPost(HttpServletRequest req, HttpServletResponse resp) Called by the server (via the service method) to allow a servlet to handle a POST request.
protected void	doPut(HttpServletRequest req, HttpServletResponse resp) Called by the server (via the service method) to allow a servlet to handle a PUT request.
protected abstract void	executeHttpMethod(HttpServletRequest req, HttpServletResponse resp, int reqMethod) override this method to handle all default requests
protected ConfigurationAdmin	getConfigurationAdmin() Use in child class to get a reference to the current ConfigurationAdmin
protected java.util.Map	getServiceMap() Use in child class to get list of services available
void	removePublicService(PublicWSProvider provider)
void	serviceChanged(ServiceEvent event)

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWSServlet

public AbstractWSServlet(BundleContext context,
                         java.util.Map serviceMap)

AbstractWSServlet

public AbstractWSServlet(BundleContext context,
                         java.util.Hashtable serviceMap,
                         ConfigurationAdmin configAdmin)

Method Detail

executeHttpMethod

protected abstract void executeHttpMethod(HttpServletRequest req,
                                          HttpServletResponse resp,
                                          int reqMethod)
                                   throws java.io.IOException,
                                          ServletException

override this method to handle all default requests

Parameters:

req -

resp -

reqMethod -

Throws:

java.io.IOException

ServletException

doGet

protected void doGet(HttpServletRequest req,
                     HttpServletResponse resp)
              throws ServletException,
                     java.io.IOException

all the main entry points by default call executeHttpMethod, but these methods can be overridden in the implementor if a different behavior is desired

Overrides:

doGet in class HttpServlet

Parameters:

req - an HttpServletRequest object that contains the request the client has made of the servlet

resp - an HttpServletResponse object that contains the response the servlet sends to the client

Throws:

ServletException - if the request for the GET could not be handled

java.io.IOException - if an input or output error is detected when the servlet handles the GET request

See Also:

ServletResponse.setContentType(java.lang.String)

doDelete

protected void doDelete(HttpServletRequest req,
                        HttpServletResponse resp)
                 throws ServletException,
                        java.io.IOException

Description copied from class: HttpServlet

Called by the server (via the service method) to allow a servlet to handle a DELETE request. The DELETE operation allows a client to remove a document or Web page from the server.

This method does not need to be either safe or idempotent. Operations requested through DELETE can have side effects for which users can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

If the HTTP DELETE request is incorrectly formatted, doDelete returns an HTTP "Bad Request" message.

Overrides:

doDelete in class HttpServlet

Parameters:

req - the HttpServletRequest object that contains the request the client made of the servlet

resp - the HttpServletResponse object that contains the response the servlet returns to the client

Throws:

ServletException - if the request for the DELETE cannot be handled

java.io.IOException - if an input or output error occurs while the servlet is handling the DELETE request

doPost

protected void doPost(HttpServletRequest req,
                      HttpServletResponse resp)
               throws ServletException,
                      java.io.IOException

Description copied from class: HttpServlet

Called by the server (via the service method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the ServletResponse.setContentLength(int) method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online.

If the HTTP POST request is incorrectly formatted, doPost returns an HTTP "Bad Request" message.

Overrides:

doPost in class HttpServlet

Parameters:

req - an HttpServletRequest object that contains the request the client has made of the servlet

resp - an HttpServletResponse object that contains the response the servlet sends to the client

Throws:

ServletException - if the request for the POST could not be handled

java.io.IOException - if an input or output error is detected when the servlet handles the request

See Also:

ServletOutputStream, ServletResponse.setContentType(java.lang.String)

doPut

protected void doPut(HttpServletRequest req,
                     HttpServletResponse resp)
              throws ServletException,
                     java.io.IOException

Description copied from class: HttpServlet

Called by the server (via the service method) to allow a servlet to handle a PUT request. The PUT operation allows a client to place a file on the server and is similar to sending a file by FTP.

When overriding this method, leave intact any content headers sent with the request (including Content-Length, Content-Type, Content-Transfer-Encoding, Content-Encoding, Content-Base, Content-Language, Content-Location, Content-MD5, and Content-Range). If your method cannot handle a content header, it must issue an error message (HTTP 501 - Not Implemented) and discard the request. For more information on HTTP 1.1, see RFC 2068 .

This method does not need to be either safe or idempotent. Operations that doPut performs can have side effects for which the user can be held accountable. When using this method, it may be useful to save a copy of the affected URL in temporary storage.

If the HTTP PUT request is incorrectly formatted, doPut returns an HTTP "Bad Request" message.

Overrides:

doPut in class HttpServlet

Parameters:

req - the HttpServletRequest object that contains the request the client made of the servlet

resp - the HttpServletResponse object that contains the response the servlet returns to the client

Throws:

ServletException - if the request for the PUT cannot be handled

java.io.IOException - if an input or output error occurs while the servlet is handling the PUT request

addPublicService

public void addPublicService(PublicWSProvider provider)

removePublicService

public void removePublicService(PublicWSProvider provider)

getServiceMap

protected java.util.Map getServiceMap()

Use in child class to get list of services available

Returns:

getConfigurationAdmin

protected ConfigurationAdmin getConfigurationAdmin()

Use in child class to get a reference to the current ConfigurationAdmin

Returns:

serviceChanged

public void serviceChanged(ServiceEvent event)