/*
    * Copyright 2010 Fraunhofer Gesellschaft, Munich, Germany,
    * for its Fraunhofer Institute for Computer Architecture and Software
    * Technology (FIRST), Berlin, Germany. All rights reserved.
    * http://www.first.fraunhofer.de/
    */
   
   package net.kwfgrid.gwes;
   
  import net.kwfgrid.gworkflowdl.structure.Token;
  import net.kwfgrid.gworkflowdl.structure.Factory;
  import net.kwfgrid.gworkflowdl.structure.WorkflowFormatException;
  import net.kwfgrid.gworkflowdl.structure.Data;
  import net.kwfgrid.gwes.util.HTMLFilter;
  
  import org.apache.log4j.Logger;
  
  /**
   * @author Andreas Hoheisel
   *         (<a href="http://www.andreas-hoheisel.de">www.andreas-hoheisel.de</a>)
   * @version $Id: SOAPFault.java 1452 2010-12-22 16:09:58Z hoheisel $
   */
  public class SOAPFault {
  
      /**
       * log4j logger.
       */
      final static Logger logger = Logger.getLogger(SOAPFault.class);
  
      /**
       * mandatory Code.Value element information item
       */
      String codeValue;
  
      /**
       * mandatory Reason element information item
       */
      String reason;
  
      /**
       * optional Node element information item
       */
      String node;
  
      /**
       * optional Role element information item
       */
      String role;
  
      /**
       * optional Detail element information item
       */
      String detail;
      
      /**
       *  exit Code of program which caused soap fault
       */
      Integer exitCode;
      
      private static final String ELEMENT_DATA_BEGIN = "<data xmlns=\"http://www.gridworkflow.org/gworkflowdl\">";
      private static final String ELEMENT_FAULT_BEGIN = "<soapenv:Fault xmlns:soapenv=\"http://www.w3.org/2003/05/soap-envelope\">";
      private static final String ELEMENT_CODE_BEGIN = "<soapenv:Code>";
      private static final String ELEMENT_VALUE_BEGIN = "<soapenv:Value>";
      private static final String ELEMENT_VALUE_END = "</soapenv:Value>";
      private static final String ELEMENT_CODE_END = "</soapenv:Code>";
      private static final String ELEMENT_REASON_TEXT_BEGIN = "<soapenv:Reason><soapenv:Text xml:lang=\"en\">";
      private static final String ELEMENT_REASON_TEXT_END = "</soapenv:Text></soapenv:Reason>";
      private static final String ELEMENT_NODE_BEGIN = "<soapenv:Node>";
      private static final String ELEMENT_NODE_END = "</soapenv:Node>";
      private static final String ELEMENT_ROLE_BEGIN = "<soapenv:Role>";
      private static final String ELEMENT_ROLE_END = "</soapenv:Role>";
      private static final String ELEMENT_DETAIL_BEGIN = "<soapenv:Detail>";
      private static final String ELEMENT_EXIT_CODE_BEGIN = "<exitCode>";
      private static final String ELEMENT_EXIT_CODE_END = "</exitCode>";
      private static final String ELEMENT_DETAIL_END = "</soapenv:Detail>";
      private static final String ELEMENT_FAULT_END = "</soapenv:Fault>";
      private static final String ELEMENT_DATA_END = "</data>";
  
  
      public SOAPFault(String codeValue, String reason) {
          this.codeValue = HTMLFilter.filter(codeValue);
          this.reason = HTMLFilter.filter(reason);
      }
  
      public SOAPFault(String codeValue, String reason, int exitCode) {
          this.codeValue = HTMLFilter.filter(codeValue);
          this.reason = HTMLFilter.filter(reason);
      	this.exitCode = exitCode;
      }
  
      /**
       * Converts this SOAPFault into a Token object.
       * @return The corresponding Token.
       */
      public Token toToken() throws WorkflowFormatException {
          Data data = Factory.newData();
          data.fromXML(toTokenString());
          Token token = Factory.newToken(data);
          return token;
     }
 
     /**
      * Converts this SOAPFault into a token String, beginning with "&lt;data ..."
      * @return The corresponding fault token as string.
      */
     public String toTokenString() {
         StringBuffer xml = new StringBuffer()
                 .append(ELEMENT_DATA_BEGIN)
                 .append(ELEMENT_FAULT_BEGIN)
                 .append(ELEMENT_CODE_BEGIN)
                 .append(ELEMENT_VALUE_BEGIN)
                 .append(codeValue)
                 .append(ELEMENT_VALUE_END)
                 .append(ELEMENT_CODE_END)
                 .append(ELEMENT_REASON_TEXT_BEGIN)
                 .append(reason)
                 .append(ELEMENT_REASON_TEXT_END);
         if (node!=null) {
             xml.append(ELEMENT_NODE_BEGIN)
                 .append(node)
                 .append(ELEMENT_NODE_END);
         }
         if (role!=null) {
             xml.append(ELEMENT_ROLE_BEGIN)
                 .append(role)
                 .append(ELEMENT_ROLE_END);
         }
         if (detail!=null) {
             xml.append(ELEMENT_DETAIL_BEGIN)
                 .append(detail);
             if (exitCode != null) {
             	xml.append(ELEMENT_EXIT_CODE_BEGIN)
                 .append(exitCode.intValue())
                 .append(ELEMENT_EXIT_CODE_END);
             }
                 xml.append(ELEMENT_DETAIL_END);
         }
         xml.append(ELEMENT_FAULT_END);
         xml.append(ELEMENT_DATA_END);
 
         return xml.toString();
     }
 
     public String getCodeValue() {
         return codeValue;
     }
 
     public void setCodeValue(String codeValue) {
         this.codeValue = HTMLFilter.filter(codeValue);
     }
 
     public String getReason() {
         return reason;
     }
 
     public void setReason(String reason) {
         this.reason = HTMLFilter.filter(reason);
     }
 
     public String getNode() {
         return node;
     }
 
     public void setNode(String node) {
         this.node = HTMLFilter.filter(node);
     }
 
     public String getRole() {
         return role;
     }
 
     public void setRole(String role) {
         this.role = HTMLFilter.filter(role);
     }
 
     public String getDetail() {
         return detail;
     }
 
     public void setDetail(String detail) {
         this.detail = detail;
     }
 
     public void setExitCode(int exitCode) {
     	this.exitCode = exitCode;
     }
     
     public int getExitCode() {
     	return this.exitCode;
     }
 }