Servlet

It is technology to create dynamic WebPages. This is a Java program, which resides in a web server to process requests from the user and to provide a dynamic response to users.

Storing compilation and deployment of a servlet

  1. Store the servlet file inside the "classes" folder of the context for predefined context (root) the classes folder required to be created inside the WEB-INF folder.
  2. For the compilation of the servlet, files use servlet-api.jar in classpath option of javac command. This jar file contains the package used by the servlet files. This jar file can be found inside the installation folder of the tomcat/lib folder.
  3. Deployment: This is a process to create an URL for the servlet. The user will use the URL to access the servlet. This can be done by providing a few tags in the web.xml file. The tags are as follows:

    In web.xml file present side to classes folder:

    <servlet>
    <servlet-name>name</servlet-name>
    <servlet-class>class</servlet-class>
    </servlet>

    <servlet-mapping>
    <servlet-name>name</servlet-name>
    <url-pattern>/ url-pattern </url-pattern>
    </servlet-mapping>
Program
  1. import java.io.*;
  2. import javax.servlet.*;
  3. import javax.servlet.http.*;
  4. public class httpserv extends HttpServlet
  5. {
  6. public void doGet(HttpServletRequest req ,HttpServletResponse res)throws IOException ,ServletException
  7. {
  8. PrintWriter out = res.getWriter();
  9. res.setContentType("text/html");
  10. out.println("<html><body>");
  11. out.println("<h1> First servlet</h1>");
  12. out.println("</body></html>");
  13. }
  14. }

How to run this program


First create a folder named Servlet in any drive (here e: drive). Inside that folder create a WEB-INF folder (all letters will be capped mandatory). Copy the web.xml file from the (E:\Program Files\Apache Software Foundation\Tomcat 6.0\conf) folder. Again inside the WEB-INF folder, create a folder named classes. In the classes folder, we will store the Servlet files by their class name; here httpserv.java. Copy the servlet-api.jar (E:\Program Files\Apache Software Foundation\Tomcat 6.0\lib) file in the classes folder.

Web.xml setting:
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!--
  3. Licensed to the Apache Software Foundation (ASF) under one or more
  4. contributor license agreements. See the NOTICE file distributed with
  5. this work for additional information regarding copyright ownership.
  6. The ASF licenses this file to You under the Apache License, Version 2.0
  7. (the "License"); you may not use this file except in compliance with
  8. the License. You may obtain a copy of the License at
  9. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing, software
  11. distributed under the License is distributed on an "AS IS" BASIS,
  12. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. See the License for the specific language governing permissions and
  14. limitations under the License.
  15. -->
  16. <web-app xmlns="http://java.sun.com/xml/ns/javaee"
  17. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  18. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  19. version="2.5">
  20. <servlet>
  21. <servlet-name>httpserv</servlet-name>
  22. <servlet-class>httpserv</servlet-class>
  23. </servlet>
  24. <servlet-mapping>
  25. <servlet-name>httpserv</servlet-name>
  26. <url-pattern>/httpserv</url-pattern>
  27. </servlet-mapping
  28. </web-app>
Context path setting: Move to (E:\Program Files\Apache Software Foundation\Tomcat 6.0\conf) folder and open server.xml file. Create a context path (any name) and docBase="E:\Servlet" (this is the folder path where we are storing the (WEB-INF\classes) servlet files).
  1. <Context path="/javaservlet" docBase="E:\Servlet" reloadable="true" debug="0" />
  2. <?xml version='1.0' encoding='utf-8'?>
  3. <!--
  4. Licensed to the Apache Software Foundation (ASF) under one or more
  5. contributor license agreements. See the NOTICE file distributed with
  6. this work for additional information regarding copyright ownership.
  7. The ASF licenses this file to You under the Apache License, Version 2.0
  8. (the "License"); you may not use this file except in compliance with
  9. the License. You may obtain a copy of the License at
  10. http://www.apache.org/licenses/LICENSE-2.0
  11. Unless required by applicable law or agreed to in writing, software
  12. distributed under the License is distributed on an "AS IS" BASIS,
  13. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. See the License for the specific language governing permissions and
  15. limitations under the License.
  16. -->
  17. <!-- Note: A "Server" is not itself a "Container", so you may not
  18. define subcomponents such as "Valves" at this level.
  19. Documentation at /docs/config/server.html
  20. -->
  21. <Server port="8005" shutdown="SHUTDOWN">
  22. <!--APR library loader. Documentation at /docs/apr.html -->
  23. <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  24. <!--Initialize Jasper prior to webapps are loaded. Documentation at /docs/jasper-howto.html -->
  25. <Listener className="org.apache.catalina.core.JasperListener" />
  26. <!-- JMX Support for the Tomcat server. Documentation at /docs/non-existent.html -->
  27. <Listener className="org.apache.catalina.mbeans.ServerLifecycleListener" />
  28. <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
  29. <!-- Global JNDI resources
  30. Documentation at /docs/jndi-resources-howto.html
  31. -->
  32. <GlobalNamingResources>
  33. <!-- Editable user database that can also be used by
  34. UserDatabaseRealm to authenticate users
  35. -->
  36. <Resource name="UserDatabase" auth="Container"
  37. type="org.apache.catalina.UserDatabase"
  38. description="User database that can be updated and saved"
  39. factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
  40. pathname="conf/tomcat-users.xml" />
  41. </GlobalNamingResources>
  42. <!-- A "Service" is a collection of one or more "Connectors" that share
  43. a single "Container" Note: A "Service" is not itself a "Container",
  44. so you may not define subcomponents such as "Valves" at this level.
  45. Documentation at /docs/config/service.html
  46. -->
  47. <Service name="Catalina">
  48. <!--The connectors can use a shared executor, you can define one or more named thread pools-->
  49. <!--
  50. <Executor name="tomcatThreadPool" namePrefix="catalina-exec-"
  51. maxThreads="150" minSpareThreads="4"/>
  52. -->
  53. <!-- A "Connector" represents an endpoint by which requests are received
  54. and responses are returned. Documentation at :
  55. Java HTTP Connector: /docs/config/http.html (blocking & non-blocking)
  56. Java AJP Connector: /docs/config/ajp.html
  57. APR (HTTP/AJP) Connector: /docs/apr.html
  58. Define a non-SSL HTTP/1.1 Connector on port 8080
  59. -->
  60. <Connector port="8081" protocol="HTTP/1.1"
  61. connectionTimeout="20000"
  62. redirectPort="8443" />
  63. <!-- A "Connector" using the shared thread pool-->
  64. <!--
  65. <Connector executor="tomcatThreadPool"
  66. port="8080" protocol="HTTP/1.1"
  67. connectionTimeout="20000"
  68. redirectPort="8443" />
  69. -->
  70. <!-- Define a SSL HTTP/1.1 Connector on port 8443
  71. This connector uses the JSSE configuration, when using APR, the
  72. connector should be using the OpenSSL style configuration
  73. described in the APR documentation -->
  74. <!--
  75. <Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true"
  76. maxThreads="150" scheme="https" secure="true"
  77. clientAuth="false" sslProtocol="TLS" />
  78. -->
  79. <!-- Define an AJP 1.3 Connector on port 8009 -->
  80. <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
  81. <!-- An Engine represents the entry point (within Catalina) that processes
  82. every request. The Engine implementation for Tomcat stand alone
  83. analyzes the HTTP headers included with the request, and passes them
  84. on to the appropriate Host (virtual host).
  85. Documentation at /docs/config/engine.html -->
  86. <!-- You should set jvmRoute to support load-balancing via AJP ie :
  87. <Engine name="Standalone" defaultHost="localhost" jvmRoute="jvm1">
  88. -->
  89. <Engine name="Catalina" defaultHost="localhost">
  90. <!--For clustering, please take a look at documentation at:
  91. /docs/cluster-howto.html (simple how to)
  92. /docs/config/cluster.html (reference documentation) -->
  93. <!--
  94. <Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster"/>
  95. -->
  96. <!-- The request dumper valve dumps useful debugging information about
  97. the request and response data received and sent by Tomcat.
  98. Documentation at: /docs/config/valve.html -->
  99. <!--
  100. <Valve className="org.apache.catalina.valves.RequestDumperValve"/>
  101. -->
  102. <!-- This Realm uses the UserDatabase configured in the global JNDI
  103. resources under the key "UserDatabase". Any edits
  104. that are performed against this UserDatabase are immediately
  105. available for use by the Realm. -->
  106. <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
  107. resourceName="UserDatabase"/>
  108. <!-- Define the default virtual host
  109. Note: XML Schema validation will not work with Xerces 2.2.
  110. -->
  111. <Host name="localhost" appBase="webapps"
  112. unpackWARs="true" autoDeploy="true"
  113. xmlValidation="false" xmlNamespaceAware="false">
  114. <!-- SingleSignOn valve, share authentication between web applications
  115. Documentation at: /docs/config/valve.html -->
  116. <!--
  117. <Valve className="org.apache.catalina.authenticator.SingleSignOn" />
  118. -->
  119. <!-- Access log processes all example.
  120. Documentation at: /docs/config/valve.html -->
  121. <!--
  122. <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
  123. prefix="localhost_access_log." suffix=".txt" pattern="common" resolveHosts="false"/>
  124. -->
  125. <Context path="/javaservlet" docBase="E:\Servlet" reloadable="true" debug="0" />
  126. </Host>
  127. </Engine>
  128. </Service>
  129. </Server>

Compiling


javac -cp servlet.jar httpserv.java (for tomcat 4.0)
javac -cp servlet-api.jar httpserv.java (for tomcat 6.0)

cp means classpath

Servlet

Running the servlet in a web browser


First, run the tomcat 6.0

http://localhost:8081/ javaservlet /httpserv