8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: ClientDetectionDefaultImpl.java,v 1.5 2008/06/25 05:41:32 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The <code>ClientDetectionInterface</code> interface needs to be implemented
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * by services and applications serving multiple clients, to determine the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * client from which the request has originated. This interface detects the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * client type from the client request.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.all.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic class ClientDetectionDefaultImpl implements ClientDetectionInterface {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster protected static Debug debug = Debug.getInstance("amClientDetection");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster protected static DefaultClientTypesManager defCTM =
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster AMClientDetector.getClientTypesManagerInstance();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Creates a client detection default implementation instance.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This is the method used by the interface to set the client-type.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>ClientDetectionDefaultImpl</code> currently uses the following
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * algorithm.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if userAgent equals a known user-agent then
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compare userAgent length and store the longest match
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if clientType not found
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * return the default clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param request
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The calling object passes in the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>HTTPServletRequest</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return The string corresponding to the client type.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws ClientDetectionException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if a default client type cannot be found
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public String getClientType(HttpServletRequest request)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String httpUA = request.getHeader("user-agent");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("UserAgent : httpUA is : " + httpUA);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Looking in UA/PartialMatch Maps");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if ((clientInstance = defCTM.getFromUserAgentMap(httpUA)) != null) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // Perf: We wont have to iterate thro' all clients
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Perf: from UA Map: " + clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if ((clientType = defCTM.getPartiallyMatchedClient(httpUA)) != null)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Perf: from PartialMatch Map: " + clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // Iterate through Clients, find and save the longest match
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Iterator knownClients = ClientsManager.getAllInstances();
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String curClientUA = clientInstance.getProperty("userAgent");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("(" + i + ") Client user-agent = "
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // We have a match
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // Check length
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Longest user-agent match client " +
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // If we don't have a single match, get the default clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster clientType = Client.getDefaultInstance().getProperty("clientType");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Default client type = " + clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // Found a partial map - add it so our Map,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // so our next search is faster
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster defCTM.addToPartialMatchMap(httpUA, clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // If we can't get the default clientType
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Unable to obtain default client type");
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster debug.message("Returning client type : " + clientType);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method contains the algorithm used to compare the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <CODE>HTTPServletRequest</CODE>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * user-agent versus the <CODE>Client</CODE> user-agent.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param httpUA
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The HTTPServletRequest user-agent
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param clientUA
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The Client userAgent
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return True or false if they match
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster protected boolean userAgentCheck(String httpUA, String clientUA) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return false;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return true;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster return false;