package at.gv.egovernment.moa.spss.server.invoke;

import java.util.ArrayList;
import java.util.List;

import org.w3c.dom.Element;

import at.gv.egovernment.moa.spss.api.SPSSFactory;
import at.gv.egovernment.moa.spss.api.xmlsign.CreateXMLSignatureResponse;
import at.gv.egovernment.moa.spss.api.xmlsign.ErrorResponse;
import at.gv.egovernment.moa.spss.api.xmlsign.SignatureEnvironmentResponse;

/**
 * A class to build a <code>CreateXMLSignatureResponse</code>.
 * 
 * <p>The methods <code>addSignature()</code> and <code>addError()</code> may be
 * called in any combination to add <code>SignatureEnvironment</code> and
 * <code>ErrorResponse</code> elements to the response. One of these functions
 * must be called at least once to produce a 
 * <code>CreateXMLSignatureResponse</code>.</p>
 * 
 * <p>The <code>getResponseElement()</code> method then returns the
 * <code>CreateXMLSignatureResponse</code> built so far.</p>
 * 
 * @author Patrick Peck
 * @version $Id$
 */
public class CreateXMLSignatureResponseBuilder {

  /** The <code>SPSSFactory</code> for creating API objects. */
  private SPSSFactory factory = SPSSFactory.getInstance();
  /** The elements to add to the response. */
  private List responseElements = new ArrayList();

  /**
   * Get the <code>CreateXMLSignatureResponse</code> built so far.
   * 
   * @return The <code>CreateXMLSignatureResponse</code> built so far.
   */
  public CreateXMLSignatureResponse getResponse() {
    return factory.createCreateXMLSignatureResponse(responseElements);
  }

  /**
   * Add a <code>SignatureEnvironment</code> element to the response.
   * 
   * @param signatureEnvironment The content to put under the
   * <code>SignatureEnvironment</code> element. This should either be a
   * <code>dsig:Signature</code> element (in case of a detached signature) or
   * the signature environment containing the signature (in case of
   * an enveloping signature).
   */
  public void addSignatureEnvironment(Element signatureEnvironment) {
    SignatureEnvironmentResponse responseElement = 
      factory.createSignatureEnvironmentResponse(signatureEnvironment);
    responseElements.add(responseElement);
  }

  /**
   * Add a <code>ErrorResponse</code> element to the response.
   *  
   * @param errorCode The error code.
   * @param info Additional information about the error.
   */
  public void addError(String errorCode, String info) {
    ErrorResponse errorResponse = 
      factory.createErrorResponse(Integer.parseInt(errorCode), info);
    responseElements.add(errorResponse);
  }

}