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

import at.gv.egovernment.moa.id.config.OAParameter;

/**
 * Configuration parameters belonging to an online application,
 * to use with the MOA ID Auth component.
 *
 * @author Stefan Knirsch
 * @version $Id$
 */
/**
 * 
 * 
 * @author Harald Bratko
 */
public class OAAuthParameter extends OAParameter {
  /**
   * Sercurity Layer version
   */
  private String slVersion;
  /**
   * true, if the Security Layer version is version 1.2, otherwise false
   */
  private boolean slVersion12;
  /**
   * identityLinkDomainIdentifier 
   * (e.g <code>urn:publicid:gv.at+wbpk+FN468i</code> for a "Firmenbuchnummer") 
   * <br>
   * only used within a business application context for providing it to the  
   * security layer as input for wbPK computation
   */
  private String identityLinkDomainIdentifier;  
	/**
	 * key box Identifier (e.g. CertifiedKeypair, SecureSignatureKeypair)
	 */  
  private String keyBoxIdentifier;
  /**
   * transformations for rendering in the secure viewer of the security layer 
   * implementation; multiple transformation can be given for different mime types
   */  
  private String[] transformsInfos;
	/**
	 * determines whether "Stammzahl" is to be included in the authentication data
	 */
  private boolean provideStammzahl;
	/**
	 * determines whether AUTH block is to be included in the authentication data
	 */
  private boolean provideAuthBlock;
	/**
	 * determines whether identity link is to be included in the authentication data
	 */
  private boolean provideIdentityLink;
  /**
   * determines whether the certificate is to be included in the authentication data
   */
  private boolean provideCertificate;
  /**
   * url to a template for web page "Auswahl der B&uuml;rgerkartenumgebung"
   */
  private String bkuSelectionTemplateURL;
  /**
   * template for web page "Anmeldung mit B&uuml;rgerkarte"
   */
  private String templateURL;
  
  /**
   * Returns <code>true</code> if the Security Layer version is version 1.2,
   * otherwise <code>false</code>.
   * @return <code>true</code> if the Security Layer version is version 1.2,
   * otherwise <code>false</code>
   */
  public boolean getSlVersion12() {
    return slVersion12;
  }
  
  /**
   * Returns the security layer version.
   * @return the security layer version.
   */
  public String getSlVersion() {
    return slVersion;
  }
  
  /**
   * Returns the identityLinkDomainIdentifier.
   * @return the identityLinkDomainIdentifier.
   */
  public String getIdentityLinkDomainIdentifier() {
    return identityLinkDomainIdentifier;
  }
  
  /**
   * Returns the transformsInfos.
   * @return the transformsInfos.
   */
  public String[] getTransformsInfos() {
    return transformsInfos;
  }
  
  /**
   * Returns the provideAuthBlock.
   * @return String
   */
  public boolean getProvideAuthBlock() {
    return provideAuthBlock;
  }

  /**
   * Returns the provideIdentityLink.
   * @return String
   */
  public boolean getProvideIdentityLink() {
    return provideIdentityLink;
  }

  /**
   * Returns the provideStammzahl.
   * @return String
   */
  public boolean getProvideStammzahl() {
    return provideStammzahl;
  }
  
  /**
   * Returns <code>true</code> if the certificate should be provided within the
   * authentication data, otherwise <code>false</code>.
   * @return <code>true</code> if the certificate should be provided, 
   *         otherwise <code>false</code>
   */
  public boolean getProvideCertifcate() {
    return provideCertificate;
  }
  
	/**
		* Returns the key box identifier.
		* @return String
		*/
	 public String getKeyBoxIdentifier() {
		 return keyBoxIdentifier;
	 }
   
   /**
   * Returns the BkuSelectionTemplate url.
   * @return The BkuSelectionTemplate url or <code>null</code> if no url for
   *         a BkuSelectionTemplate is set.
   */
  public String getBkuSelectionTemplateURL() {
    return bkuSelectionTemplateURL;
  }
  
  /**
   * Returns the TemplateURL url.
   * @return The TemplateURL url or <code>null</code> if no url for
   *         a Template is set.
   */
  public String getTemplateURL() {
    return templateURL;
  }  
   
  /**
   * Sets the security layer version.
   * Also sets {@link slVersion12} to <code>true</code> if the Security Layer
   * version is 1.2.
   * @param the security layer version to be used.
   */
  public void setSlVersion(String slVersion) {
    this.slVersion = slVersion;
    if ("1.2".equals(slVersion)) {
      this.slVersion12 = true;
    }
  }
  /**
   * Sets the IdentityLinkDomainIdentifier.
   * @param the IdentityLinkDomainIdentifiern number of the online application.
   */
  public void setIdentityLinkDomainIdentifier(String identityLinkDomainIdentifier) {
    this.identityLinkDomainIdentifier = identityLinkDomainIdentifier;
  }
  /**
   * Sets the transformsInfos.
   * @param the transformsInfos to be used.
   */
  public void setTransformsInfos(String[] transformsInfos) {
    this.transformsInfos = transformsInfos;
  }
  /**
   * Sets the provideAuthBlock.
   * @param provideAuthBlock The provideAuthBlock to set
   */
  public void setProvideAuthBlock(boolean provideAuthBlock) {
    this.provideAuthBlock = provideAuthBlock;
  }

  /**
   * Sets the provideIdentityLink.
   * @param provideIdentityLink The provideIdentityLink to set
   */
  public void setProvideIdentityLink(boolean provideIdentityLink) {
    this.provideIdentityLink = provideIdentityLink;
  }

  /**
   * Sets the provideStammzahl.
   * @param provideStammzahl The provideStammzahl to set
   */
  public void setProvideStammzahl(boolean provideStammzahl) {
    this.provideStammzahl = provideStammzahl;
  }
  
  /**
   * Sets the provideCertificate variable.
   * @param provideCertificate The provideCertificate value to set
   */
  public void setProvideCertificate(boolean provideCertificate) {
    this.provideCertificate = provideCertificate;
  }

	/**
	 * Sets the key box identifier.
	 * @param keyBoxIdentifier to set
	 */
	public void setKeyBoxIdentier(String keyBoxIdentifier) {
		this.keyBoxIdentifier = keyBoxIdentifier;
	}
  
  /**
   * Sets the BkuSelectionTemplate url.
   * @param bkuSelectionTemplateURL The url string specifying the location
   *        of a BkuSelectionTemplate.
   */
	public void setBkuSelectionTemplateURL(String bkuSelectionTemplateURL) {
		this.bkuSelectionTemplateURL = bkuSelectionTemplateURL;
	}
  
  /**
   * Sets the Template url.
   * @param templateURL The url string specifying the location
   *        of a Template.
   */
	public void setTemplateURL(String templateURL) {
		this.templateURL = templateURL;
	}
}