/*
 * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
 *
 * 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://joinup.ec.europa.eu/software/page/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.
 */
package at.asit.pdfover.gui.workflow.config;

import java.io.IOException;
import java.io.InputStream;
import java.util.Locale;

import org.eclipse.swt.graphics.Point;

import at.asit.pdfover.gui.bku.mobile.MobileBKUs;
import at.asit.pdfover.signator.BKUs;
import at.asit.pdfover.signator.SignaturePosition;

/**
 * An interface for reading the configuration
 */
public interface ConfigProvider {
	/**
	 * RegEx for parsing signature position
	 */
	public static final String SIGN_POS_REGEX = "(x=(\\d\\.?\\d?);y=(\\d\\.?\\d?);p=(\\d))|(auto)|(x=(\\d\\.?\\d?);y=(\\d\\.?\\d?))"; //$NON-NLS-1$

	/**
	 * Loads the configuration from a configuration file
	 * 
	 * @param configSource
	 *            the configuration file
	 * @throws IOException
	 */
	public void loadConfiguration(InputStream configSource) throws IOException;

	/**
	 * Gets the configuration file
	 * 
	 * @return the configuration file
	 */
	public String getConfigurationFile();

	/**
	 * Gets the configuration directory
	 * 
	 * @return the configuration directory
	 */
	public String getConfigurationDirectory();

	/**
	 * Gets the default Mobile number
	 * 
	 * @return the default mobile number
	 */
	public String getDefaultMobileNumber();

	/**
	 * Gets the password to use for Mobile BKU
	 * 
	 * @return the password
	 */
	public String getDefaultMobilePassword();

	/**
	 * Gets the filename of the default emblem
	 * 
	 * @return the emblem
	 */
	public String getDefaultEmblem();

	/**
	 * Gets the proxy host
	 * 
	 * @return the proxy hostname or ip address
	 */
	public String getProxyHost();

	/**
	 * Gets the proxy port
	 * 
	 * @return the proxy port
	 */
	public int getProxyPort();

	/**
	 * Gets the proxy username
	 * 
	 * @return the proxy username
	 */
	public String getProxyUser();

	/**
	 * Gets the proxy password
	 * 
	 * @return the proxy password
	 */
	public String getProxyPass();

	/**
	 * Get the default configured BKU
	 * 
	 * @return the default configured BKU
	 */
	public BKUs getDefaultBKU();

	/**
	 * Get the default configured SignaturePosition
	 * 
	 * @return the default configured SignaturePosition or null if not
	 *         configured
	 */
	public SignaturePosition getDefaultSignaturePosition();

	/**
	 * Get the transparency of the signature placeholder
	 * 
	 * @return the transparency of the signature placeholder
	 */
	public int getPlaceholderTransparency();

	/**
	 * Gets the default output folder for signed documents
	 * 
	 * @return the default output folder
	 */
	public String getDefaultOutputFolder();

	/**
	 * Gets the mobile BKU URL
	 * 
	 * @return the mobile BKU URL
	 */
	public String getMobileBKUURL();

	/**
	 * Gets the mobile BKU type
	 * 
	 * @return the mobile BKU type
	 */
	public MobileBKUs getMobileBKUType();

	/**
	 * Gets the mobile BKU BASE64 setting
	 * 
	 * @return the mobile BKU BASE64 setting
	 */
	public boolean getMobileBKUBase64();

	/**
	 * Get the signature note text to use
	 * 
	 * @return the signature note text
	 */
	public String getSignatureNote();

	/**
	 * Gets the configured locale
	 * 
	 * @return the configured locale
	 */
	public Locale getLocale();

	/**
	 * Gets the configured locale
	 * 
	 * @return the configured locale
	 */
	public Locale getSignatureLocale();

	/**
	 * Get the signature PDF/A compatibility setting
	 * 
	 * @return the signature PDF/A compatibility setting
	 */
	public boolean getSignaturePdfACompat();

	/**
	 * Gets whether keystore signing is enabled
	 * 
	 * @return whether keystore signing is enabled
	 */
	public Boolean getKeyStoreEnabled();

	/**
	 * Gets the keystore file
	 * 
	 * @return the keystore file
	 */
	public String getKeyStoreFile();

	/**
	 * Gets the keystore type
	 * 
	 * @return the keystore type
	 */
	public String getKeyStoreType();

	/**
	 * Gets the keystore alias
	 * 
	 * @return the keystore alias
	 */
	public String getKeyStoreAlias();

	/**
	 * Gets the keystore store password
	 * 
	 * @return the keystore store password
	 */
	public String getKeyStoreStorePass();

	/**
	 * Gets the keystore key password
	 * 
	 * @return the keystore key password
	 */
	public String getKeyStoreKeyPass();

	/**
	 * Gets whether to automatically check for application updates
	 * 
	 * @return whether to automatically check for application updates
	 */
	public boolean getUpdateCheck();

	/**
	 * Gets the configured MainWindow size
	 * 
	 * @return the configured MainWindow size
	 */
	public Point getMainWindowSize();

	/**
	 * Gets whether to skip the finish screen
	 * 
	 * @return whether to skip the finish screen
	 */
	public boolean getSkipFinish();

	/**
	 * Gets whether to use signature markers.
	 *
	 * @return whether to use a signature maker
	 */
	public boolean getUseMarker();
	
	/**
	 * Gets whether to use signature fileds instead of QR code.
	 *
	 * @return boolean
	 */
	public boolean getUseSignatureFields();
	
	/**
	 * @return
	 */
	public boolean getEnablePlaceholderUsage();

	/**
	 * @param profile
	 */
	public void setSignatureProfile(String profile);
	
	
	/**
	 * @return
	 */
	public String getSignatureProfile();

	public String getSaveFilePostFix();
}