/*
    * Copyright  2004 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.axis.message.addressing.handler;
  
  import org.apache.axis.AxisFault;
  import org.apache.axis.Handler;
  import org.apache.axis.Message;
  import org.apache.axis.MessageContext;
  import org.apache.axis.message.addressing.AddressingHeaders;
  import org.apache.axis.message.addressing.Constants;
  import org.apache.axis.message.addressing.EndpointReference;
  import org.apache.ws.addressing.handler.ServerSideAddressingHandler;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import javax.xml.namespace.QName;
  import javax.xml.rpc.Call;
  import javax.xml.rpc.JAXRPCException;
  import javax.xml.rpc.Service;
  import javax.xml.rpc.handler.soap.SOAPMessageContext;
  import javax.xml.soap.SOAPBody;
  import java.util.Hashtable;
  import java.util.List;
  
  /***
   * Axis-specific server-side WS-Addressing handler.
   *
   * @author Davanum Srinivas (dims@yahoo.com)
   * @author Ian P. Springer
   */
  public class AxisServerSideAddressingHandler extends ServerSideAddressingHandler implements Handler
  {
  
      private GenericAxisHandler axisHelperHandler = new GenericAxisHandler( this );
  
      /***
       * @see org.apache.axis.Handler#init()
       */
      public void init()
      {
          axisHelperHandler.init();
      }
  
      /***
       * @see org.apache.axis.Handler#cleanup()
       */
      public void cleanup()
      {
          axisHelperHandler.cleanup();
      }
  
      /***
       * @see org.apache.axis.Handler#canHandleBlock(javax.xml.namespace.QName)
       */
      public boolean canHandleBlock( QName qname )
      {
          return ( axisHelperHandler.canHandleBlock( qname ) );
      }
  
      /***
       * @see org.apache.axis.Handler#setOption(java.lang.String, java.lang.Object)
       */
      public void setOption( String name,
                             Object value )
      {
          axisHelperHandler.setOption( name, value );
      }
  
      /***
       * Set a default value for the given option:
       * if the option is not already set, then set it.
       * if the option is already set, then do not set it.
       * <p/>
       * If this is called multiple times, the first with a non-null value
       * if 'value' will set the default, remaining calls will be ignored.
       * <p/>
       * Returns true if value set (by this call), otherwise false;
       */
      public boolean setOptionDefault( String name,
                                       Object value )
      {
          return axisHelperHandler.setOptionDefault( name, value );
      }
  
      /***
      * @see org.apache.axis.Handler#getOption(java.lang.String)
      */
     public Object getOption( String name )
     {
         return axisHelperHandler.getOption( name );
     }
 
     /***
      * @see org.apache.axis.Handler#getOptions()
      */
     public Hashtable getOptions()
     {
         return axisHelperHandler.getOptions();
     }
 
     /***
      * @see org.apache.axis.Handler#setOptions(java.util.Hashtable)
      */
     public void setOptions( Hashtable opts )
     {
         axisHelperHandler.setOptions( opts );
     }
 
     /***
      * @see org.apache.axis.Handler#setName(java.lang.String)
      */
     public void setName( String name )
     {
         axisHelperHandler.setName( name );
     }
 
     /***
      * @see org.apache.axis.Handler#getName()
      */
     public String getName()
     {
         return axisHelperHandler.getName();
     }
 
     /***
      * @see org.apache.axis.Handler#getDeploymentData(org.w3c.dom.Document)
      */
     public Element getDeploymentData( Document doc )
     {
         return axisHelperHandler.getDeploymentData( doc );
     }
 
     /***
      * @see org.apache.axis.Handler#getUnderstoodHeaders()
      */
     public List getUnderstoodHeaders()
     {
         return axisHelperHandler.getUnderstoodHeaders();
     }
 
     /***
      * @see org.apache.axis.Handler#generateWSDL(org.apache.axis.MessageContext)
      */
     public void generateWSDL( MessageContext msgContext ) throws AxisFault
     {
         axisHelperHandler.generateWSDL( msgContext );
     }
 
     /***
      * @see org.apache.axis.Handler#invoke(org.apache.axis.MessageContext)
      */
     public void invoke( MessageContext msgContext ) throws AxisFault
     {
         axisHelperHandler.invoke( msgContext );
     }
 
     /***
      * @see org.apache.axis.Handler#onFault(org.apache.axis.MessageContext)
      */
     public void onFault( MessageContext msgContext )
     {
         axisHelperHandler.onFault( msgContext );
     }
 
     /***
      * Use the UUID generator that comes with Axis.
      *
      * @return a UUID
      */
     protected String generateUUId()
     {
         return axisHelperHandler.generateUUId();
     }
 
     // TODO: not sure if overriding this method is even necessary.
     protected void forwardMessage( SOAPMessageContext soapMsgContext, EndpointReference endpointRef )
     {
         try
         {
             Service service = getService( soapMsgContext );
             Call call = service.createCall();
             call.setTargetEndpointAddress( endpointRef.getAddress().toString() );
             ( (org.apache.axis.client.Call) call ).setRequestMessage( (Message) soapMsgContext.getMessage() );
             AddressingHeaders addrHeaders = buildAddressingHeadersForMessageForward( soapMsgContext, endpointRef );
             call.setProperty( Constants.ENV_ADDRESSING_REQUEST_HEADERS, addrHeaders );
             configureCall( call, soapMsgContext );
             call.invoke( new Object[0] );
             SOAPBody responseBody = soapMsgContext.getMessage().getSOAPPart().getEnvelope().getBody();
             removeAllChildElements( responseBody );
         }
         catch ( Exception e )
         {
             throw new JAXRPCException( "Failed to forward SOAP message." );
         }
 
     }
 
     protected void setTargetService( SOAPMessageContext soapMsgContext, AddressingHeaders headers )
             throws Exception
     {
         org.apache.axis.MessageContext axisMsgContext = (org.apache.axis.MessageContext) soapMsgContext;
         // TODO: why is the below code necessary? - add comments
         if ( axisMsgContext.getService() == null &&
                 axisMsgContext.getTargetService() == null )
         {
             axisMsgContext.setTargetService( getTargetServiceName( headers ) );
             // This is to ensure the SOAPEnvelope is rebuilt with the right type mappings and
             // MessageContext is set with the right properties.
             if ( axisMsgContext.getTargetService() != null )
             {
                 ( (Message) axisMsgContext.getMessage() ).getSOAPPartAsString();
             }
         }
     }
 
     private AddressingHeaders buildAddressingHeadersForMessageForward( SOAPMessageContext soapMsgContext, EndpointReference endpointRef )
     {
         AddressingHeaders headers = null;
         if ( soapMsgContext != null )
         {
             headers = (AddressingHeaders) soapMsgContext.getProperty( Constants.ENV_ADDRESSING_RESPONSE_HEADERS );
         }
         if ( headers == null )
         {
             headers = new AddressingHeaders( endpointRef );
         }
         return headers;
     }
 
 }