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.server;
20
21 import org.eclipse.jetty.util.annotation.ManagedAttribute;
22 import org.eclipse.jetty.util.annotation.ManagedObject;
23 import org.eclipse.jetty.util.component.LifeCycle;
24
25 /**
26 * A Handler that contains other Handlers.
27 * <p>
28 * The contained handlers may be one (see @{link {@link org.eclipse.jetty.server.handler.HandlerWrapper})
29 * or many (see {@link org.eclipse.jetty.server.handler.HandlerList} or {@link org.eclipse.jetty.server.handler.HandlerCollection}.
30 *
31 */
32 @ManagedObject("Handler of Multiple Handlers")
33 public interface HandlerContainer extends LifeCycle
34 {
35 /* ------------------------------------------------------------ */
36 /**
37 * @return array of handlers directly contained by this handler.
38 */
39 @ManagedAttribute("handlers in this container")
40 public Handler[] getHandlers();
41
42 /* ------------------------------------------------------------ */
43 /**
44 * @return array of all handlers contained by this handler and it's children
45 */
46 @ManagedAttribute("all contained handlers")
47 public Handler[] getChildHandlers();
48
49 /* ------------------------------------------------------------ */
50 /**
51 * @param byclass the child handler class to get
52 * @return array of all handlers contained by this handler and it's children of the passed type.
53 */
54 public Handler[] getChildHandlersByClass(Class<?> byclass);
55
56 /* ------------------------------------------------------------ */
57 /**
58 * @param byclass the child handler class to get
59 * @return first handler of all handlers contained by this handler and it's children of the passed type.
60 * @param <T> the type of handler
61 */
62 public <T extends Handler> T getChildHandlerByClass(Class<T> byclass);
63 }