/* 
    * Copyright (c) 2005-2011, Fraunhofer-Gesellschaft
    * 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 disclaimer at the end.
   *     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.
   * 
   * (2) Neither the name of Fraunhofer nor the names of its
   *     contributors may be used to endorse or promote products derived
   *     from this software without specific prior written permission.
   * 
   * DISCLAIMER
   * 
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
   * OWNER OR 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.ogf.graap.wsag.client.wsrf;
  
  import java.util.Properties;
  
  import org.apache.xmlbeans.XmlObject;
  import org.ogf.graap.wsag.api.exceptions.ResourceUnavailableException;
  import org.ogf.graap.wsag.api.exceptions.ResourceUnknownException;
  import org.ogf.graap.wsag.api.security.ISecurityProperties;
  import org.ogf.graap.wsag.client.api.AgreementClient;
  import org.ogf.graap.wsag.client.api.impl.AgreementClientImpl;
  import org.ogf.graap.wsag.client.wsrf.impl.WsrfAgreementService;
  import org.ogf.graap.wsag.client.wsrf.impl.WsrfResourceClient;
  import org.ogf.schemas.graap.wsAgreement.AgreementContextType;
  import org.ogf.schemas.graap.wsAgreement.AgreementPropertiesDocument;
  import org.ogf.schemas.graap.wsAgreement.AgreementPropertiesType;
  import org.ogf.schemas.graap.wsAgreement.AgreementStateType;
  import org.ogf.schemas.graap.wsAgreement.GuaranteeTermStateType;
  import org.ogf.schemas.graap.wsAgreement.ServiceTermStateType;
  import org.ogf.schemas.graap.wsAgreement.TermTreeType;
  import org.ogf.schemas.graap.wsAgreement.TerminateInputType;
  import org.w3.x2005.x08.addressing.EndpointReferenceType;
  import org.w3c.dom.Element;
  
  /**
   * AgreementImpl
   * 
   * @author Oliver Waeldrich
   * 
   */
  public class WsrfAgreementClient extends AgreementClientImpl
  {
  
      private final WsrfResourceClient client;
  
      private final WsrfAgreementService agreementClient;
  
      /**
       * Instantiates a new agreement client for the given EPR.
       * 
       * @param epr
       *            the agreement endpoint reference.
       * 
       * @param securityProperties
       *            the security properties
       */
      public WsrfAgreementClient( EndpointReferenceType epr, Properties properties,
                                  ISecurityProperties securityProperties )
      {
          this( new WsrfResourceClient( epr, properties, securityProperties ) );
      }
  
      private WsrfAgreementClient( WsrfResourceClient client )
      {
          this.client = client;
          agreementClient = new WsrfAgreementService( client );
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public AgreementClient clone() throws CloneNotSupportedException
      {
          ISecurityProperties securityProperties = client.getSecurityProperties().clone();
          return new WsrfAgreementClient( client.getEndpoint(), getProperties(), securityProperties );
     }
 
     /*
      * (non-Javadoc)
      * 
      * @see org.ogf.graap.wsag.client.api.impl.AbstractClient#getRemoteClient()
      */
     @Override
     public WsrfResourceClient getRemoteClient()
     {
         return client;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AgreementContextType getContext() throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getContext();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public GuaranteeTermStateType[] getGuaranteeTermStates()
         throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getGuaranteeTermStates();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public GuaranteeTermStateType getGuaranteeTermState( String name )
         throws ResourceUnknownException, ResourceUnavailableException
     {
 
         GuaranteeTermStateType[] states = getGuaranteeTermStates();
         for ( int i = 0; i < states.length; i++ )
         {
             GuaranteeTermStateType state = states[i];
             if ( name.equals( state.getTermName() ) )
             {
                 return state;
             }
         }
 
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getAgreementId() throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getAgreementId();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getName() throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getName();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public ServiceTermStateType[] getServiceTermStates()
         throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getServiceTermStates();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public ServiceTermStateType getServiceTermState( String name )
         throws ResourceUnknownException, ResourceUnavailableException
     {
 
         ServiceTermStateType[] states = getServiceTermStates();
         for ( int i = 0; i < states.length; i++ )
         {
             ServiceTermStateType state = states[i];
             if ( name.equals( state.getTermName() ) )
             {
                 return state;
             }
         }
 
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AgreementStateType getState() throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getState();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public TermTreeType getTerms() throws ResourceUnknownException, ResourceUnavailableException
     {
         return agreementClient.getTerms();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void terminate() throws ResourceUnknownException, ResourceUnavailableException
     {
         terminate( TerminateInputType.Factory.newInstance() );
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void terminate( TerminateInputType reason )
         throws ResourceUnknownException, ResourceUnavailableException
     {
         agreementClient.terminate( reason );
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void destroy() throws ResourceUnknownException, ResourceUnavailableException
     {
         agreementClient.destroy();
     }
 
     /**
      * {@inheritDoc}
      */
     public EndpointReferenceType getEndpoint()
     {
         return agreementClient.getWebServiceClient().getEndpoint();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Properties getProperties()
     {
         return agreementClient.getWebServiceClient().getProperties();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void setProperties( Properties properties )
     {
         agreementClient.getWebServiceClient().setProperties( properties );
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isUsingTrace()
     {
         return agreementClient.getWebServiceClient().isUsingTrace();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void setTrace( boolean trace )
     {
         agreementClient.getWebServiceClient().setTrace( trace );
     }
 
     /**
      * {@inheritDoc}
      * 
      * @return the security properties for this client
      * @see org.ogf.graap.wsag.client.wsrf.impl.WsrfResourceClient#getSecurityProperties()
      */
     @Override
     public ISecurityProperties getSecurityProperties()
     {
         return agreementClient.getWebServiceClient().getSecurityProperties();
     }
 
     /**
      * {@inheritDoc}
      * 
      * @see org.ogf.graap.wsag.client.api.impl.AgreementClientImpl#getResourceProperties()
      */
     @Override
     public AgreementPropertiesType getResourceProperties()
         throws ResourceUnknownException, ResourceUnavailableException
     {
         try
         {
             WsrfResourceClient wsrf = agreementClient.getWebServiceClient();
             Element doc = wsrf.getResourcePropertyDocument();
             AgreementPropertiesDocument propertiesDoc =
                 (AgreementPropertiesDocument) XmlObject.Factory.parse( doc );
             return propertiesDoc.getAgreementProperties();
         }
         catch ( Exception e )
         {
             throw new ResourceUnavailableException( "Failed to parse server response.", e );
         }
     }
 
 }