ContentTypeHandler.java

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2007, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * Portions of this software are based upon public domain software
 * originally written at the National Center for Supercomputing Applications,
 * University of Illinois, Urbana-Champaign.
 */

package servlet.tck.common.client.handler;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import servlet.tck.util.TestUtil;
import org.apache.commons.httpclient.Header;

/**
 * <PRE>
 * When invoked, the content-type header
 * will be appropriately handled.  It allows
 * flexible checking of control values against
 * the response which could be in the form of:
 *    content-type; charset
 *      -or-
 *    conent-type
 * </PRE>
 */
public class ContentTypeHandler implements Handler {

  private static final Logger LOGGER = LoggerFactory.getLogger(ContentTypeHandler.class);

  private static Handler handler = new ContentTypeHandler();

  /**
   * Creates new ContentTypeHandler
   */
  private ContentTypeHandler() {
  }

  /*
   * public methods
   * ========================================================================
   */

  /**
   * Returns an instance of this handler.
   */
  public static Handler getInstance() {
    return handler;
  }

  /**
   * Invokes handler logic.
   * 
   * @param configuredHeader
   *          the user configured header
   * @param responseHeader
   *          the response header from the server
   * @return True if the passed match, otherwise false
   */
  public boolean invoke(Header configuredHeader, Header responseHeader) {
    boolean ret = false;
    LOGGER.trace("[ContentTypeHandler] ContentTypeHandler invoked.");
    String configVal = configuredHeader.getValue().trim();
    String responseVal = responseHeader.getValue().trim();
    int colIdx = configVal.indexOf(';');
    if (colIdx < 0) {
      // Info we're interested in : type/subtype

      // check response Content-Type header to see what format
      // it's in.
      int rColIdx = responseVal.indexOf(';');
      if (rColIdx < 0) {
        // Type and subtype, i.e. type/subtype are to be compared
        // case insensitively.
        if (configVal.equalsIgnoreCase(responseVal)) {
          ret = true;
        }
      } else {
        if (configVal.equalsIgnoreCase(responseVal.substring(0, rColIdx))) {
          ret = true;
        }
      }
    } else {
      // Info we're interested in : type/subtype; parameter=value

      int rColIdx = responseVal.indexOf(';');
      if (rColIdx > -1) {
        String confTypeSubType = configVal.substring(0, colIdx).trim();
        String responseTypeSubType = responseVal.substring(0, rColIdx).trim();
        String confParameter = configVal.substring(colIdx + 1).trim();
        String responseParameter = (responseVal.substring(rColIdx + 1).trim())
            .replaceAll(" ", "");
        // compare type/subtype in a case insensitive manner
        if (confTypeSubType.equalsIgnoreCase(responseTypeSubType)) {
          // next validate the parameter in a case insensitive manner
          if (confParameter.equalsIgnoreCase(responseParameter)) {
            ret = true;
          }
        }
      }
    }
    return ret;
  }
}