org.restlet.ext.xdb
Class XdbServerServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.restlet.ext.servlet.ServerServlet
              org.restlet.ext.xdb.XdbServerServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class XdbServerServlet
extends ServerServlet

Servlet acting like an HTTP server connector. Here is a sample configuration for your Restlet webapp:

 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE web-app PUBLIC
       "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
       "http://java.sun.com/dtd/web-app_2_3.dtd">
 <web-app>
         <display-name>Restlet adapter</display-name>
 
 
       <!-- Restlet adapter -->
       <servlet>
        <servlet-name>XdbServerServlet</servlet-name>
          <servlet-class>
              org.restlet.ext.xdb.XdbServerServlet
          </servlet-class>
          <!-- Your application class name -->
          <init-param
            xmlns="http://xmlns.oracle.com/xdb/xdbconfig.xsd">
            <param-name>org.restlet.application</param-name>
            <param-value>
               SCOTT:org.restlet.example.tutorial.Part12
            </param-value>
            <description>REST Application</description>
          </init-param>
       </servlet>
 
       <!-- Catch all requests -->
       <servlet-mapping>
         <servlet-name>XdbServerServlet</servlet-name>
         <url-pattern>/userapp/*</url-pattern>
       </servlet-mapping>
 </web-app>
 

The enumeration of initParameters of your Servlet will be copied to the "context.parameters" property of your application. This way, you can pass additional initialization parameters to your Restlet application, and share them with existing Servlets.

Author:

Marcelo F. Ochoa (mochoa@ieee.org)

See Also:

J2EE home page, Serialized Form

Constructor Summary

XdbServerServlet()
Constructor.

Method Summary

static void	closeDbResources(Statement statement, ResultSet resultSet) Closes JDBC resources
protected ServerCall	createCall(Server server, HttpServletRequest request, HttpServletResponse response) Creates a new Servlet call wrapping a Servlet request/response couple and a Server connector.
protected Client	createWarClient(Context appCtx, ServletConfig config) Creates a new client for the WAR protocol.
void	destroy()
static Connection	getConnection() Returns a JDBC connection.
protected String	getContextPath(HttpServletRequest request) Intercepter method need for subclasses such as XdbServerServlet.
String	getInitParameter(String name, String defaultValue) Returns the value of a given initialization parameter, first from the Servlet configuration, then from the Web Application context.
protected String	getLocalAddr(HttpServletRequest request) Intercepter method need for subclasses such as XdbServerServlet.
protected int	getLocalPort(HttpServletRequest request) Intercepter method need for subclasses such as XdbServerServlet.
void	init()
protected Class<?>	loadClass(String className) Returns a class for a given qualified class name.

Methods inherited from class org.restlet.ext.servlet.ServerServlet

createApplication, createComponent, createServer, getApplication, getComponent, getServer, init, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XdbServerServlet

public XdbServerServlet()

Constructor.

Method Detail

closeDbResources

public static void closeDbResources(Statement statement,
                                    ResultSet resultSet)

Closes JDBC resources

Parameters:

statement - Any statement.

resultSet - Any result set.

getConnection

public static Connection getConnection()
                                throws ServletException

Returns a JDBC connection. Works inside or outside the OJVM. outside the it uses db.str, db.usr and db.pwd System's properties

Returns:

A JDBC connection.

Throws:

ServletException

createCall

protected ServerCall createCall(Server server,
                                HttpServletRequest request,
                                HttpServletResponse response)

Description copied from class: ServerServlet

Creates a new Servlet call wrapping a Servlet request/response couple and a Server connector.

Overrides:

createCall in class ServerServlet

Parameters:

server - The Server connector.

request - The Servlet request.

response - The Servlet response.

Returns:

The new ServletCall instance.

createWarClient

protected Client createWarClient(Context appCtx,
                                 ServletConfig config)

Description copied from class: ServerServlet

Creates a new client for the WAR protocol.

Overrides:

createWarClient in class ServerServlet

Parameters:

appCtx - The parent context.

config - The Servlet config.

Returns:

The new WAR client instance.

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class ServerServlet

getContextPath

protected String getContextPath(HttpServletRequest request)

Description copied from class: ServerServlet

Intercepter method need for subclasses such as XdbServerServlet.

Overrides:

getContextPath in class ServerServlet

Parameters:

request - The Servlet request.

Returns:

The portion of the request URI that indicates the context of the request.

getInitParameter

public String getInitParameter(String name,
                               String defaultValue)

Description copied from class: ServerServlet

Returns the value of a given initialization parameter, first from the Servlet configuration, then from the Web Application context.

Overrides:

getInitParameter in class ServerServlet

Parameters:

name - The parameter name.

defaultValue - The default to use in case the parameter is not found.

Returns:

The value of the parameter or null.

getLocalAddr

protected String getLocalAddr(HttpServletRequest request)

Description copied from class: ServerServlet

Intercepter method need for subclasses such as XdbServerServlet.

Overrides:

getLocalAddr in class ServerServlet

Parameters:

request - The Servlet request.

Returns:

The Internet Protocol (IP) address of the interface on which the request was received.

getLocalPort

protected int getLocalPort(HttpServletRequest request)

Description copied from class: ServerServlet

Intercepter method need for subclasses such as XdbServerServlet.

Overrides:

getLocalPort in class ServerServlet

Parameters:

request - The Servlet request.

Returns:

The Internet Protocol (IP) port number of the interface on which the request was received

init

public void init()
          throws ServletException

Overrides:

init in class ServerServlet

Throws:

ServletException

loadClass

protected Class<?> loadClass(String className)
                      throws ClassNotFoundException

Description copied from class: ServerServlet

Returns a class for a given qualified class name.

Overrides:

loadClass in class ServerServlet

Parameters:

className - The class name to lookup.

Returns:

The class object.

Throws:

ClassNotFoundException