View Javadoc
1   /**
2    * This file Copyright (c) 2011-2015 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.channel;
35  
36  import javax.servlet.http.HttpServletRequest;
37  
38  
39  /**
40   * Defines a type that can resolve what channel is to be used.
41   */
42  public interface ChannelResolver {
43      /**
44       * Default Channel to use in case none of the ChannelResolver could successfully resolve.
45       */
46      public static final String ALL = "all";
47  
48      /**
49       * Constant indicating that no channel was resolved.
50       */
51      public static final String UNRESOLVED = "<unresolved>";
52  
53      /**
54       * @param request to retrieve channel from.
55       *
56       * @return name of the resolved channel or {@link info.magnolia.channel.ChannelResolver#UNRESOLVED} if it could not be resolved.
57       */
58      String resolveChannel(HttpServletRequest request);
59  }