001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: ClientDetectionInterface.java,v 1.3 2008/06/25 05:41:32 qcheng Exp $
026 *
027 */
028
029package com.iplanet.services.cdm;
030
031import javax.servlet.http.HttpServletRequest;
032
033/**
034 * The <code>ClientDetectionInterface</code> interface needs to be implemented
035 * by services and applications serving multiple clients, to determine the
036 * client from which the request has originated. This interface detects the
037 * client type from the client request.
038 * @supported.all.api
039 */
040public interface ClientDetectionInterface {
041    /**
042     * Detects the client type based on the request object.
043     * 
044     * @param request
045     *            HTTP Servlet Request
046     * @return a String representing the client type.
047     * @exception ClientDetectionException
048     *                when there is an error retrieving client data
049     */
050    public String getClientType(HttpServletRequest request)
051            throws ClientDetectionException;
052}