/*
 * Copyright 2004,2005 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.axis2.handlers.addressing;

import java.util.ArrayList;
import java.util.Map;

import javax.xml.namespace.QName;

import org.apache.axiom.om.OMElement;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.context.MessageContext;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class AddressingFinalInHandlerTest extends AddressingInHandlerTestBase {

    private Log log = LogFactory.getLog(getClass());
   
    /**
     * @param testName
     */
    public AddressingFinalInHandlerTest(String testName) {
        super(testName);
    }

    protected void setUp() throws Exception {
        super.setUp();
        inHandler = new AddressingFinalInHandler();
        addressingNamespace = AddressingConstants.Final.WSA_NAMESPACE;
        versionDirectory = "final";
        fromAddress = "http://www.w3.org/2005/08/addressing/anonymous";
        secondRelationshipType = "http://some.custom.relationship";
    }

    public void testExtractAddressingInformationFromHeaders() {
        try {
            Options options = extractAddressingInformationFromHeaders();
            
            assertNotNull(options);
            assertNotNull(options.getTo());
   
            Map allReferenceParameters = options.getTo().getAllReferenceParameters();
            assertNotNull(allReferenceParameters);
            QName qName = new QName("http://ws.apache.org/namespaces/axis2", "ParamOne", "axis2");
            assertNotNull(allReferenceParameters.get(qName));

            assertEPRHasCorrectMetadata(options.getFrom());
            assertEPRHasCorrectMetadata(options.getFaultTo());
            assertEPRHasCorrectMetadata(options.getReplyTo());
            
        } catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());
        }
    }
    
    public void testMessageWithOmittedAction() {
        try {
            testMessageWithOmittedHeaders("noAction");
            fail("An AxisFault should have been thrown due to a missing Action header.");
        }
        catch (AxisFault af) {
            //test passed
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testMessageWithOmittedFaultTo() {
        try {
            Options options = testMessageWithOmittedHeaders("noFaultTo");
            EndpointReference epr = options.getFaultTo();
            
            assertNull("The FaultTo endpoint reference is not null.", epr);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown due to a missing FaultTo header.");
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testMessageWithOmittedFrom() {
        try {
            Options options = testMessageWithOmittedHeaders("noFrom");
            EndpointReference epr = options.getFrom();
            
            assertNull("The From endpoint reference is not null.", epr);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown due to a missing From header.");
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testMessageWithOmittedMessageID() {
        try {
            Options options = testMessageWithOmittedHeaders("noMessageID");
            String messageID = options.getMessageId();
            
            assertNull("The message id is not null.", messageID);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown due to a missing MessageID header.");
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testMessageWithOmittedReplyTo() {
        try {
            Options options = testMessageWithOmittedHeaders("noReplyTo");
            EndpointReference epr = options.getReplyTo();
            String address = epr.getAddress();
            
            assertEquals("The address of the ReplyTo endpoint reference is not the anonymous URI.", AddressingConstants.Final.WSA_ANONYMOUS_URL, address);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown due to a missing ReplyTo header.");
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testMessageWithOmittedTo() {
        try {
            Options options = testMessageWithOmittedHeaders("noTo");
            EndpointReference epr = options.getTo();
            
            assertNull("The To endpoint reference is not null.", epr);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown due to a missing To header.");
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());            
        }
    }
    
    public void testDifferentSoapActionProcessing() {
        String testfile = "valid-messages/"+versionDirectory+"/soapmessage.xml";
        MessageContext mc = new MessageContext();
        
        try {
            mc.setSoapAction("http://ws.apache.org/tests/differentAction");
            basicExtractAddressingInformationFromHeaders(testfile, mc);
            fail("An AxisFault should have been thrown due to the soapaction being different to the ws-a action.");            
        }
        catch (AxisFault af) {
            //Test passed.
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());                        
        }
    }
    
    public void testSameSoapAction() {
        String testfile = "valid-messages/"+versionDirectory+"/soapmessage.xml";
        MessageContext mc = new MessageContext();
        
        try {
            mc.setSoapAction("http://ws.apache.org/tests/action");
            basicExtractAddressingInformationFromHeaders(testfile, mc);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown while testing with a soapaction and ws-a action that are the same.");            
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());                        
        }        
    }
    
    public void testEmptySoapAction() {
        String testfile = "valid-messages/"+versionDirectory+"/soapmessage.xml";
        MessageContext mc = new MessageContext();
        
        try {
            mc.setSoapAction("");
            basicExtractAddressingInformationFromHeaders(testfile, mc);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown while testing with an empty soapaction.");            
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());                        
        }
    }
    
    public void testNullSoapAction() {
        String testfile = "valid-messages/"+versionDirectory+"/soapmessage.xml";
        MessageContext mc = new MessageContext();
        
        try {
            mc.setSoapAction(null);
            basicExtractAddressingInformationFromHeaders(testfile, mc);
        }
        catch (AxisFault af) {
            af.printStackTrace();
            log.error(af.getMessage());
            fail("An unexpected AxisFault was thrown while testing with a null soapaction.");            
        }
        catch (Exception e) {
            e.printStackTrace();
            log.error(e.getMessage());
            fail(" An Exception has occured " + e.getMessage());                        
        }
    }
    
    private void assertEPRHasCorrectMetadata(EndpointReference epr){
    	ArrayList metadata = epr.getMetaData();
    	if(metadata != null){
    		OMElement md = (OMElement)metadata.get(0);
    		assertEquals(md.getQName(),new QName("http://ws.apache.org/namespaces/axis2","MetaExt"));
    		assertEquals(md.getText(),"123456789");
    		assertEquals(md.getAttributeValue(new QName("http://ws.apache.org/namespaces/axis2","AttrExt")),"123456789");
    	}else{
    		fail("No Metadata found in EPR");
    	}
    }
}