/*******************************************************************************
 * Copyright 2014 Federal Chancellery Austria
 * MOA-ID has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, and Graz University of Technology.
 * 
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 * 
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 ******************************************************************************/
/*
 * Copyright 2003 Federal Chancellery Austria
 * MOA-ID has been developed in a cooperation between BRZ, the Federal
 * Chancellery Austria - ICT staff unit, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */


package at.gv.egovernment.moa.id.auth.builder;

import java.text.MessageFormat;

import org.w3c.dom.Element;

import at.gv.egovernment.moa.id.auth.exception.BuildException;
import at.gv.egovernment.moa.util.Constants;
import at.gv.egovernment.moa.util.DOMUtils;
import at.gv.egovernment.moa.util.StringUtils;

/**
 * Builder for the <code>lt;samlp:Response&gt;</code> used for passing
 * result and status information from the <code>GetAuthenticationData</code>
 * web service.
 * 
 * @author Paul Ivancsics
 * @version $Id$
 */
public class SAMLResponseBuilder implements Constants {
	/** XML - Template for samlp:Response */
	private static final String RESPONSE = 
    "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" +
    "<samlp:Response xmlns:samlp=\"" + SAMLP_NS_URI + "\" xmlns:saml=\"" + SAML_NS_URI + "\"" +
    " ResponseID=\"{0}\" InResponseTo=\"{1}\" MajorVersion=\"1\" MinorVersion=\"0\" IssueInstant=\"{2}\">" +
    "  <samlp:Status>" +
    "    <samlp:StatusCode Value=\"{3}\">" +
    "      {4}" +
    "    </samlp:StatusCode>" +
    "    <samlp:StatusMessage>{5}</samlp:StatusMessage>" +
    "  </samlp:Status>" +
    "  {6}" +
    "</samlp:Response>";
  /** XML - Template for samlp:StatusCode */  
  private static final String SUB_STATUS_CODE = 
    "<samlp:StatusCode Value=\"{0}\"></samlp:StatusCode>";
	
  /**
   * Constructor for SAMLResponseBuilder.
   */
  public SAMLResponseBuilder() {
    super();
  }
  /**
   * Builds the SAML response.
   * @param responseID response ID
   * @param inResponseTo request ID of <code>lt;samlp:Request&gt;</code> responded to
   * @param issueInstant current timestamp
   * @param statusCode status code
   * @param subStatusCode sub-status code refining the status code; may be <code>null</code>
   * @param statusMessage status message
   * @param samlAssertion SAML assertion representing authentication data
   * @return SAML response as a DOM element
	 */
  public Element build(
  	String responseID, 
  	String inResponseTo, 
  	String issueInstant, 
  	String statusCode, 
  	String subStatusCode, 
  	String statusMessage, 
  	String samlAssertion)
  	throws BuildException {
  	
  	try {
	  	String xmlSubStatusCode = 
	  		subStatusCode == null ? 
	  		"" : 
	  		MessageFormat.format(SUB_STATUS_CODE, new Object[] {subStatusCode});
	  	
	  	String xmlResponse = MessageFormat.format(RESPONSE, new Object[] {
  			responseID, 
        inResponseTo, 
        issueInstant, 
        statusCode, 
        xmlSubStatusCode, 
        statusMessage, 
        StringUtils.removeXMLDeclaration(samlAssertion) });
  		Element domResponse = DOMUtils.parseDocument(xmlResponse, false, ALL_SCHEMA_LOCATIONS, null).getDocumentElement();
		return domResponse;
		
  	}
  	catch (Throwable ex) {
  		throw new BuildException(
  			"builder.00",
  			new Object[] { "samlp:Response", ex.toString() },
  			ex);
  	}
  }


}