001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.jsp.util;
029
030import java.util.List;
031
032import javax.servlet.http.HttpServletRequest;
033
034/**
035 * This interface supports the basic functionality for the device detection.<p>
036 *
037 * @since 8.0.0
038 */
039public interface I_CmsJspDeviceSelector {
040
041    /** Request parameter to force device selection. */
042    String REQUEST_ATTRIBUTE_DEVICE = "__device";
043
044    /**
045     * Returns the name of the device type.<p>
046     *
047     * This will be one option in {@link #getDeviceTypes()}.<p>
048     *
049     * @param req the HTTP servlet request to process
050     *
051     * @return the name of the device type
052     */
053    String getDeviceType(HttpServletRequest req);
054
055    /**
056     * Returns an array of device types that can be detected.<p>
057     *
058     * @return an array of device types that can be detected
059     */
060    List<String> getDeviceTypes();
061}