View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.deploy;
20  
21  import org.eclipse.jetty.server.handler.ContextHandler;
22  import org.eclipse.jetty.util.component.LifeCycle;
23  
24  /**
25   * Object responsible for providing {@link App}s to the {@link DeploymentManager}
26   */
27  public interface AppProvider extends LifeCycle
28  {
29      /**
30       * Set the Deployment Manager
31       * 
32       * @param deploymentManager
33       * @throws IllegalStateException
34       *             if the provider {@link #isRunning()}.
35       */
36      void setDeploymentManager(DeploymentManager deploymentManager);
37      
38      /* ------------------------------------------------------------ */
39      /** Create a ContextHandler for an App
40       * @param app The App
41       * @return A ContextHandler
42       * @throws IOException
43       * @throws Exception 
44       */
45      ContextHandler createContextHandler(App app) throws Exception;
46  }