/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001 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 "Axis" 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/>.
*/
package org.apache.axis.serviceContext;
/**
 * This class serves as a simple key identifyer for the soap:header Hash in Service.java.
 * As of now, it seems that the key to a header should simply be a the part name string but, 
 * since I am unsure I leave it here for now.
 * 
 * @author Sylvain St-Germain (sylvain@macadamian.com)
 */
public class HeaderKey {
 
    private String m_messageName;
    private String m_partName;
    private HeaderLifeCycle m_lifeCycle;
    
    public HeaderKey(String messageName, String partName) {
    	m_messageName = messageName;
    	m_partName = partName;  
    }
    public HeaderKey(String partName) {
    	m_messageName = "";
    		m_partName = partName;  
    	}
    
      /**
       * Gets the messageName.
       * @return Returns a String
       */
      public String getMessageName() {
        return m_messageName;
      }
    
      /**
       * Sets the messageName.
       * @param messageName The messageName to set
       */
      public void setMessageName(String messageName) {
        m_messageName = messageName;
      }
    
      /**
       * Gets the partName.
       * @return Returns a String
       */
      public String getPartName() {
        return m_partName;
    }
    
    /**
     * Sets the partName.
     * @param partName The partName to set
     */
    public void setPartName(String partName) {
        m_partName = partName;
    }
    
   	public String toString() {
    		return "[ " + getMessageName() + ", " + getPartName() + " ]";
    }
    
    public boolean equals(Object o) {
        // Do not use the HeaderLifeCycle m_lifeCycle data member.  Since this dataMember
        // do not identify a Header object per say but rather defines the header life cycle.
        return ( o != null 
        	&& getMessageName().equals(((HeaderKey)o).getMessageName()) 
        	&& getPartName().equals(((HeaderKey)o).getPartName()) ) ;	  	
    }

    /**
     * Gets the lifeCycle.
     * @return Returns a HeaderLifeCycle
     */
    public HeaderLifeCycle getLifeCycle() {
        return m_lifeCycle;
    }

    /**
     * Sets the lifeCycle.
     * @param lifeCycle The lifeCycle to set
     */
    public void setLifeCycle(HeaderLifeCycle lifeCycle) {
        m_lifeCycle = lifeCycle;
    }

}