/*
* Copyright 2003 Federal Chancellery Austria
*
* 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 at.gv.egovernment.moa.id.auth.builder;

import java.text.MessageFormat;

import at.gv.egovernment.moa.util.Constants;
import at.gv.egovernment.moa.util.StringUtils;

/**
 * Builder for the <code>&lt;CreateXMLSignatureRequest&gt;</code> structure
 * used for requesting a signature under the authentication block from the 
 * security layer implementation.
 *
 * @author Paul Ivancsics
 * @version $Id$
 */
public class CreateXMLSignatureRequestBuilder implements Constants {
  /** private static String nl contains the NewLine representation in Java*/
  private static final String nl = "\n";
    /**
   * XML template for the <code>&lt;moa:CreateXMLSignatureRequest&gt;</code> to be built
   */     
	private static final String CREATE_XML_SIGNATURE_REQUEST = 
    "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" + nl +
    "<{3}:CreateXMLSignatureRequest xmlns:dsig=''" + DSIG_NS_URI + "'' {5}>" + nl +
    " <{3}:KeyboxIdentifier>{1}</{3}:KeyboxIdentifier>" + nl +
    " <{3}:DataObjectInfo Structure=''detached''>" + nl +
    "  <{4}:DataObject Reference=''''/>" + nl +
    "{2}" +
    " </{3}:DataObjectInfo>" + nl +
    " <{3}:SignatureInfo>" + nl +
    "  <{3}:SignatureEnvironment>" + nl +
    "   <{4}:XMLContent>{0}</{4}:XMLContent>" + nl +
    "  </{3}:SignatureEnvironment>" + nl +
    "  <{3}:SignatureLocation Index=''2''>/saml:Assertion</{3}:SignatureLocation>" + nl +
    " </{3}:SignatureInfo>" + nl +
    "</{3}:CreateXMLSignatureRequest>";
  

  /**
   * Constructor for CreateXMLSignatureRequestBuilder.
   */
  public CreateXMLSignatureRequestBuilder() {
    super();
  }

	/**
	 * Builds the <code>&lt;CreateXMLSignatureRequest&gt;</code>.
	 * 
	 * @param authBlock String representation of XML authentication block
	 * @param keyBoxIdentifier the key box identifier which will be used (e.g. CertifiedKeypair)
   * @param slVersion12 specifies whether the Security Layer version number is 1.2 or not
	 * @return String representation of <code>&lt;CreateXMLSignatureRequest&gt;</code>
	 */
	public String build(String authBlock, String keyBoxIdentifier, String[] dsigTransformInfos, boolean slVersion12) {
		
    String sl10Prefix;
    String sl11Prefix;
    String slNsDeclaration;
    
    String dsigTransformInfosString = "";
		for (int i = 0; i < dsigTransformInfos.length; i++) {
      dsigTransformInfosString += dsigTransformInfos[i];
    }
    
    if (slVersion12) {
      
      // replace the SecurityLayer namespace prefixes and URIs within the transforms
      dsigTransformInfosString = StringUtils.changeSLVersion(dsigTransformInfosString,
                                                             SL10_PREFIX, SL12_PREFIX,
                                                             SL10_NS_URI, SL12_NS_URI);
      sl10Prefix = SL12_PREFIX;
      sl11Prefix = SL12_PREFIX;
      slNsDeclaration = "xmlns:" + SL12_PREFIX + "='" + SL12_NS_URI + "'";
      
    } else {
      
      sl10Prefix = SL10_PREFIX;
      sl11Prefix = SL11_PREFIX;
      slNsDeclaration = "xmlns:" + sl10Prefix + "='" + SL10_NS_URI + "' xmlns:" + sl11Prefix + "='" + SL11_NS_URI + "'";
      
    }
      
		String request = MessageFormat.format(
			CREATE_XML_SIGNATURE_REQUEST, new Object[] { authBlock, 
                                                   keyBoxIdentifier, 
                                                   dsigTransformInfosString, 
                                                   sl11Prefix, 
                                                   sl10Prefix, 
                                                   slNsDeclaration });
    
		return request;
	}
}