View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 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 java.io.IOException;
22  
23  import org.eclipse.jetty.server.handler.ContextHandler;
24  import org.eclipse.jetty.util.component.LifeCycle;
25  
26  /**
27   * Object responsible for providing {@link App}s to the {@link DeploymentManager}
28   */
29  public interface AppProvider extends LifeCycle
30  {
31      /**
32       * Set the Deployment Manager
33       * 
34       * @param deploymentManager the deployment manager
35       * @throws IllegalStateException
36       *             if the provider {@link #isRunning()}.
37       */
38      void setDeploymentManager(DeploymentManager deploymentManager);
39      
40      /* ------------------------------------------------------------ */
41      /** Create a ContextHandler for an App
42       * @param app The App
43       * @return A ContextHandler
44       * @throws IOException if unable to create context
45       * @throws Exception if unable to create context
46       */
47      ContextHandler createContextHandler(App app) throws Exception;
48  }