root/trunk/src/java/org/jcoderz/commons/connector/http/transport/HttpInvalidResponseHeaderException.java

/*
 * $Id$
 *
 * Copyright 2006, The jCoderZ.org Project. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * 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.
 *    * Neither the name of the jCoderZ.org Project nor the names of
 *      its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written
 *      permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS 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 REGENTS AND 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.
 */
package org.jcoderz.commons.connector.http.transport;

import java.util.HashMap;
import java.util.Map;

/**
 * HttpConnectionException indicates one or more invalid
 * http header received in response.
 *
 */
public class HttpInvalidResponseHeaderException
      extends HttpConnectionException
{
   static final long serialVersionUID = -8809116333732118663L;
   private final Map mInvalidHeader;

   /**
    * Constructor.
    *
    * @param message describing the HTTP error
    */
   public HttpInvalidResponseHeaderException (String message)
   {
      super(message, null);
      mInvalidHeader = new HashMap();
   }

   /**
    * Constructor.
    *
    * @param message describing the HTTP error
    * @param invalidHeader the invalid header parmeter received
    */
   public HttpInvalidResponseHeaderException (
         String message, Map invalidHeader)
   {
      super(message, null);
      mInvalidHeader = invalidHeader;
   }

   /**
    * Gets the invalid header parameters received in response.
    * @return Map a map of invalid header key value pairs
    */
   public Map getInvalidParameter ()
   {
      return mInvalidHeader;
   }
}