{"id":23996,"date":"2015-06-10T11:00:34","date_gmt":"2015-06-10T08:00:34","guid":{"rendered":"http:\/\/examples.javacodegeeks.com\/?p=23996"},"modified":"2019-04-10T13:15:32","modified_gmt":"2019-04-10T10:15:32","slug":"jetty-tutorial-beginners","status":"publish","type":"post","link":"https:\/\/examples.javacodegeeks.com\/java-development\/enterprise-java\/jetty\/jetty-tutorial-beginners\/","title":{"rendered":"Jetty Tutorial for Beginners"},"content":{"rendered":"

In this article, we will give brief information about Jetty and provide examples of   Java application deployment on Jetty. Our examples will consist of both standalone and Embedded modes of Jetty.<\/p>\n

Jetty is a Servlet container and  Web Server which is known to be  portable, lightweight, robust, flexible, extensible and easy to integrate.<\/p>\n

Jetty can be deployed as a standalone server and also can be embedded in an existing application. In addition to these, a  Maven Jetty  plugin is available in order to run applications in your development environment.<\/p>\n

SPDY, WebSocket, OSGi, JMX, JNDI, JAAS are some of the technologies that Jetty integrates nicely.<\/p>\n

Today, Jetty is widely used in many platforms both for development and production. Small to large enterprise applications. SaaS (such as Zimbra), Cloud Applications( such as Google AppEngine), Applications Servers(such as Apache Geronimo) and tools (such as SoapUI) are powered by Jetty.<\/p>\n

Jetty is open source, hosted by Eclipse Foundation.  Current version (as of June 2015) is 9.2.x.  You can more detailed information on Jetty Home Page<\/a>.\n<\/p>\n

1.Jetty as a Standalone server<\/h2>\n

In the first part, we will configure Jetty as a Standalone Server.<\/p>\n

1.1 Downloading  and Installing Jetty<\/h3>\n

You can visit the downloads<\/a> page and download the latest version (v9.2.11 currently) as an archive file in zip or tar.gz format. Size is about 13 MBs.<\/p>\n

There is no installation procedure for Jetty. Just drop it to a folder as you wish and uncompress the downloaded archive file.<\/p>\n

1.2 Prerequisites<\/h3>\n

The only prerequisite for Jetty 9 is having installed Java 7 in your environment. You can downgrade to Jetty 8 if you have Java 6.  A complete Jetty-Java compatibility information can be viewed here<\/a>.<\/p>\n

1.3 Running Jetty<\/h3>\n

Running Jetty on the default configuration is as simple as following two steps:<\/p>\n

    \n
  1. Navigate to the directory where you unpacked the downloaded archive. I will call it JETTY_HOME <\/i><\/b>from now on.<\/li>\n
  2. Run the following command:\n
    java -jar start.jar<\/pre>\n<\/li>\n<\/ol>\n
    When Jetty starts running successfully; it produces the a line in the log similar to the following:<\/p>\n
    2015-06-04 14:27:27.555:INFO:oejs.Server:main: Started @11245ms\n<\/pre>\n
    By default, Jetty runs on port 8080, but we will see how to configure it in the next sections of this tutorial.<\/p>\n
    You can also check via the browser typing http:\/\/localhost:8080<\/a> as the URL. You will see a 404 error, since no application is deployed in the root context.<\/p>\n
    The response is as below:<\/p>\n
    \"Server<\/a>
    Server response when Jetty runs successfully<\/figcaption><\/figure><\/p>\n
    1.4 Changing the server port<\/h3>\n
    As mentioned above, default port jetty is 8080. If you need to change it, you can apply following steps:<\/p>\n
      \n
    1. Navigate to the JETTY_HOME<\/i><\/b>.<\/li>\n
    2. Open the start.ini<\/em> file with a text editor.<\/li>\n
    3. Navigate to the line where the parameter jetty.port<\/em> is configured.<\/li>\n
    4. Change the parameter to the desired port number.<\/li>\n
    5. Start Jetty again.<\/li>\n<\/ol>\n
      In the following segment,  we set the Jetty port to 7070 instead of 8080
       
      <\/div> <\/div><\/p>\n
      ## HTTP port to listen on\njetty.port=7070\n<\/pre>\n
      After we restart  our server will run on port 7070<\/em>.<\/p>\n
      1.5 Deploying Web Applications on Jetty<\/h3>\n
      The procedure to deploy web applications on Jetty is  as follows:<\/p>\n
        \n
      1. Navigate to your JETTY_HOME<\/i> folder.<\/li>\n
      2. There is a directory named as webapps <\/i><\/b>under JETTY_HOME.  <\/strong><\/em>Navigate there.<\/strong><\/em><\/li>\n
      3. Drop your WAR file in that folder.<\/li>\n<\/ol>\n
        The application is initialized immediately, you do not need to restart Jetty since the webapps<\/strong><\/em> directory is continuously monitored by the server.<\/p>\n
        There are a sample web applications under JETTY_HOME\/demo-base\/webapps\/<\/strong>. <\/i>You can pick one of them(for<\/i> example async-rest.war<\/strong>) and copy to the webapps directory. As you copy the WAR file, the application will be initialized.<\/p>\n
        When you type http:\/\/localhost:7070\/async-rest<\/a> , you can see the application initialized.<\/p>\n
        \"The<\/a>
        The application async-rest deployed on Jetty<\/figcaption><\/figure><\/p>\n
        1.6 Changing Webapps Directory<\/h3>\n
        JETTY_HOME\/webapps<\/strong> <\/i>is the default directory to deploy your applications. But there are cases that you need to change the deployment directory. In order to do that, you should proceed as follows:<\/p>\n
          \n
        1. Open the start.ini<\/em> file under JETTY_HOME<\/strong><\/em>.<\/li>\n
        2. Remove the comment before the parameter jetty.deploy.monitoredDirName.<\/i><\/li>\n
        3. Change this parameter as you wish. Remember that the path should be relative to JETTY_HOME<\/strong><\/em> directory.<\/li>\n<\/ol>\n
          jetty.deploy.monitoredDirName=..\/jcgwebapps<\/pre>\n
          Now we can put our WARS in the jcgwebapps<\/i> directory, which is at the same level as our JETTY_HOME.<\/strong><\/em><\/p>\n
          2. Embedding Jetty in Your Application<\/h2>\n
          Until now, we have skimmed through Jetty as a standalone server. However Jetty provides another great feature. Motto of Jetty is : \u201cDon’t deploy your application in Jetty, deploy Jetty in your application\u201d<\/em>. It means that, you can embed jetty in your existing (most probably non-web) applications easily. On this purpose a very convenient API is provided to the developers. In the following sections, we will see how we can accomplish this.<\/p>\n
          2.1 Environment<\/h3>\n
          In this example, following programming environment is used:<\/p>\n