signatureproperties.java

eclipseme的最新版本的source,欢迎j2me程序员使用

/*  
 ********************************************************************
 * 
 *	File    	:   SignatureProperties.java
 *  Package     :   eclipseme.core.model.impl
 *	System      :   eclipseme.core
 *	Author      :   Kevin Hunter
 *	Description :   This is a simple container class designed to
 *					hold the various project-specific properties
 *					relating to potential signing operations. 
 *	                
 * Copyright (c) 2004 Kevin Hunter
 * All Rights Reserved.
 * Licensed under the Eclipse Public License - v 1.0
 * For more information see http://www.eclipse.org/legal/epl-v10.html
 *
 *  CVS
 *	$$Source: /cvsroot/eclipseme/eclipseme.core/src/eclipseme/core/signing/SignatureProperties.java,v $$
 *	$$Author: setera $$
 *	$$Date: 2006/11/12 01:11:01 $$
 *	$$Revision: 1.5 $$
 *
 ********************************************************************
 */

package eclipseme.core.signing;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;

import eclipseme.core.model.ISignatureProperties;

/**
 * This is a simple container class (bean) designed to
 * hold the various project-specific properties
 * relating to potential signing operations.
 * It is used by the dialog class that allows the
 * user to manipulate the settings, as well as
 * the project properties persistance stuff.
 * <p>
 * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
 * change before reaching stability. It is being made available at this early stage to solicit feedback
 * from pioneering adopters on the understanding that any code that uses this API will almost 
 * certainly be broken as the API evolves.
 * </p>
 */
public class SignatureProperties implements ISignatureProperties
{
	private boolean	m_bSignProject;				// true if user wants project signed
	private String	m_strKeyStoreDisplayPath;	// display path to the keystore
	private String	m_strKeyAlias;				// alias that identifies signing key
	private int		m_nPasswordStorageMethod;	// how passwords are stored
	private String	m_strKeyStorePassword;		// keystore password
	private String	m_strKeyPassword;			// key password
	private String	m_strKeyStoreType;			// optional type of the keystore
	private String	m_strKeyStoreProvider;		// optional provider of the crypto classes

	/**
	 * Standard constructor
	 *
	 */
	public SignatureProperties()
	{
	}

	/**
	 * Indicates whether or not the project is to be signed.
	 * 
	 * @return	<code>true</code> if the project is to be signed, <code>false</code> otherwise
	 */
	public void copy(ISignatureProperties other)
	{
		m_bSignProject			= other.getSignProject();
		m_strKeyStoreDisplayPath= other.getKeyStoreDisplayPath();
		m_strKeyAlias			= other.getKeyAlias();
		m_nPasswordStorageMethod= other.getPasswordStorageMethod();
		m_strKeyStorePassword	= other.getKeyStorePassword();
		m_strKeyPassword		= other.getKeyPassword();
		m_strKeyStoreType		= other.getKeyStoreType();
		m_strKeyStoreProvider	= other.getKeyStoreProvider();
	}
	
	/**
	 * Resets the class to its default values
	 *
	 */
	public void clear()
	{
		m_bSignProject = false;
		m_strKeyStoreDisplayPath = null;
		m_strKeyAlias = null;
		m_nPasswordStorageMethod = PASSMETHOD_PROMPT;
		m_strKeyStorePassword = null;
		m_strKeyPassword = null;
		m_strKeyStoreType = null;
		m_strKeyStoreProvider = null;
	}
	
	/**
	 * Indicates whether or not the project is to be signed.
	 * 
	 * @return	<code>true</code> if the project is to be signed, <code>false</code> otherwise
	 */
	public boolean getSignProject()
	{
		return(m_bSignProject);
	}
	
	/**
	 * Indicates whether or not the project is to be signed.
	 * 
	 * @param bValue	<code>true</code> if the project is to be signed, <code>false</code> otherwise.
	 */
	public void setSignProject(boolean bValue)
	{
		m_bSignProject = bValue;
	}
	
	/**
	 * Returns the password storage method.
	 * 
	 * @return	One of <code>PASSMETHOD_PROMPT</code>, <code>PASSMETHOD_IN_KEYRING</code> or
	 * 			<code>PASSMETHOD_IN_PROJECT</code>.
	 */
	public int getPasswordStorageMethod()
	{
		return(m_nPasswordStorageMethod);
	}
	
	/**
	 * Sets the password storage method.
	 * 
	 * @param nMethod	One of <code>PASSMETHOD_PROMPT</code>, <code>PASSMETHOD_IN_KEYRING</code> or
	 */
	public void setPasswordStorageMethod(int nMethod)
	{
		m_nPasswordStorageMethod = nMethod;
	}
	
	/**
	 * Type of the keystore file.  <code>null</code> indicates
	 * the system standard type.  This string is passed to
	 * <code>KeyStore.getInstance</code> as part of loading the
	 * keystore.
	 * 
	 * @return	<code>String</code> indicating keystore file type.
	 * 
	 * @see java.security.KeyStore#getInstance(java.lang.String)
	 * @see java.security.KeyStore#getInstance(java.lang.String, java.lang.String)
	 */
	public String getKeyStoreType()
	{
		return(m_strKeyStoreType);
	}
	
	/**
	 * Type of the keystore file.  <code>null</code> indicates
	 * the system standard type.  This string is passed to
	 * <code>KeyStore.getInstance</code> as part of loading the
	 * keystore.
	 * 
	 * @param strValue	KeyStore type string, or <code>null</code> to
	 * 					use the system default type.
	 * 
	 * @see java.security.KeyStore#getInstance(java.lang.String)
	 * @see java.security.KeyStore#getInstance(java.lang.String, java.lang.String)
	 */
	public void setKeyStoreType(String strValue)
	{
		m_strKeyStoreType = strValue;
	}
	
	/**
	 * Returns the crypto provider string.  <code>null</code> indicates the system
	 * standard type.  This string is passed to
	 * <code>KeyStore.getInstance</code> as part of loading the
	 * keystore.
	 * 
	 * @return	KeyStore provider string, or <code>null</code> to use
	 * 			the system default provider.
	 * @see java.security.KeyStore#getInstance(java.lang.String, java.lang.String)
	 */
	public String getKeyStoreProvider()
	{
		return(m_strKeyStoreProvider);
	}
	
	/**
	 * Sets the crypto provider string.  <code>null</code> indicates the system
	 * standard type.
	 * 
	 * @param strValue	KeyStore provider string, or <code>null</code> to use
	 * 					the system default provider.
	 * 
	 * @see java.security.KeyStore#getInstance(java.lang.String, java.lang.String)
	 */
	public void setKeyStoreProvider(String strValue)
	{
		m_strKeyStoreProvider = strValue;
	}
	
	/**
	 * Returns the password for the keystore file, if passwords are being saved.
	 * 
	 * @return	<code>String</code> containing keystore password.
	 */
	public String getKeyStorePassword()
	{
		return(m_strKeyStorePassword);
	}
	
	/**
	 * Sets the password for the keystore file.
	 * 
	 * @param strValue	<code>String</code> containing keystore password.
	 */
	public void setKeyStorePassword(String strValue)
	{
		m_strKeyStorePassword = strValue;
	}
	
	/**
	 * Returns the "alias" string identifying the key and certificate that will be used
	 * to sign the project.
	 * 
	 * @return	<code>String</code> containing the alias identifying the key
	 * 			and certificate.
	 */
	public String getKeyAlias()
	{
		return(m_strKeyAlias);
	}
	
	/**
	 * Sets the "alias" string identifying the key and certificate that will be used
	 * to sign the project.
	 * 
	 * @param strValue	<code>String</code> containing the alias identifying the key
	 * 					and certificate.
	 */
	public void setKeyAlias(String strValue)
	{
		m_strKeyAlias = strValue;
	}
	
	/**
	 * Returns the key password, if passwords are being saved.  
	 * Will return <code>null</code>
	 * if passwords are not being saved.
	 * 
	 * @return	<code>String</code> containing the key password.
	 */
	public String getKeyPassword()
	{
		return(m_strKeyPassword);
	}
	
	/**
	 * Sets the key password, if passwords are being saved.  Ignored if passwords
	 * are not being saved.
	 * 
	 * @param strValue	<code>String</code> containing the key password.
	 */
	public void setKeyPassword(String strValue)
	{
		m_strKeyPassword = strValue;
	}
	
	/**
	 * Returns the display string representing the
	 * keystore path.  This may be an absolute path, or it may
	 * be a project-relative path.  Relative paths are of the
	 * form "<code>$/[Folder[/Folder...]]filename</code>".
	 * Absolute paths have OS-dependent form.
	 * 
	 * @return	<code>String</code> containing displayed path.
	 * 
	 * @see #isKeyStorePathExternal()
	 */
	public String getKeyStoreDisplayPath()
	{
		return(m_strKeyStoreDisplayPath);
	}
	
	/**
	 * Sets the display string representing the
	 * keystore path.  This may be an absolute path, or it may
	 * be a project-relative path.
	 * 
	 * @param path 	<code>String</code> containing displayed path.
	 * 
	 * @see #getKeyStoreDisplayPath()
	 */
	public void setKeyStoreDisplayPath(String path)
	{
		m_strKeyStoreDisplayPath = path;
	}
	
	/**
	 * Returns the absolute file system path to the
	 * keystore file.  The specified <code>project</code> instance
	 * is used to convert a project-relative path to an absolute
	 * path. 
	 * 
	 * @param project	<code>IProject</code> to which this 
	 * 					<code>ISignatureProperties</code> belongs.
	 * @return	<code>String</code> containing absolute path to
	 * 			keystore file.
	 * @throws CoreException 
	 */
	public String getAbsoluteKeyStorePath(IProject project) 
		throws CoreException
	{
		if (isKeyStorePathExternal())
		{
			return(m_strKeyStoreDisplayPath);
		}

		return(toAbsolute(m_strKeyStoreDisplayPath, project));
	}
	
	/**
	 * Indicates whether the keystore path is external to the project
	 * or project-relative.
	 * 
	 * @return <code>true</code> if the keystore path is external
	 * 			to the project, <code>false</code> if it's relative
	 * 			to the current project.
	 */
	public boolean isKeyStorePathExternal()
	{
		if (m_strKeyStoreDisplayPath == null)
		{
			return(true);
		}
		
		if (m_strKeyStoreDisplayPath.length() < ISignatureProperties.PROJECT_RELATIVE_PREFIX.length())
		{
			return(true);
		}
		
		if (!ISignatureProperties.PROJECT_RELATIVE_PREFIX.equals(m_strKeyStoreDisplayPath.substring(0, ISignatureProperties.PROJECT_RELATIVE_PREFIX.length())))
		{
			return(true);
		}
		
		return(false);
	}

	/**
	 * Converts a project-relative path into an absolute one, based
	 * on the location of the project containing the file.
	 * 
	 * @param path		Relative path to be converted.
	 * @param project	<code>IProject</code> instance containing
	 * 					the relative path.
	 * @return	<code>String</code> containing the absolute path
	 * 			to the file.
	 * @throws CoreException 
	 */
	public static String toAbsolute(String path, IProject project) 
		throws CoreException
	{
		String relativePath = path.substring(ISignatureProperties.PROJECT_RELATIVE_PREFIX.length());
		IPath projectPath = project.getLocation(); 
		IPath absolutePath = projectPath.append(relativePath);
		
		return(absolutePath.toString());
	}
	
	/**
	 * Converts a basic project-relative path into the format that
	 * we recognize internally.  This is done by ensuring that the
	 * path string starts with our "relative prefix."
	 * 
	 * @param path	<code>String</code> containing the path to be
	 * 				converted.
	 * @return		<code>String</code> with the converted value.
	 */
	public static String toRelative(String path)
	{
		if (path.charAt(0) == '/')
		{
			path = ISignatureProperties.PROJECT_RELATIVE_PREFIX + path.substring(1);
		}
		else
		{
			path = ISignatureProperties.PROJECT_RELATIVE_PREFIX + path;
		}
		
		return(path);
	}
}


/*
 ********************************************************************
 *	CVS History:
 *	$$Log: SignatureProperties.java,v $
 *	$Revision 1.5  2006/11/12 01:11:01  setera
 *	$Merging the preprocessor functionality back to the mainline
 *	$
 *	$Revision 1.4.4.2  2006/10/09 13:48:23  setera
 *	$Transitioning to secondary project for preprocessed output
 *	$
 *	$Revision 1.4.4.1  2006/09/14 00:49:06  setera
 *	$More preprocessing work via file system
 *	$
 *	$Revision 1.4  2005/10/29 15:39:29  setera
 *	$Refactor packaging and signing functionality into their own packages
 *	$Warn user while trying to package a project with an invalid platform definition (Bug 1304273)
 *	$
 *	$Revision 1.6  2004/12/17 01:33:34  setera
 *	$Documentation updates for the 0.7.0
 *	$
 *	$Revision 1.5  2004/12/16 13:12:05  kdhunter
 *	$Removed two unnecessary routines
 *	$JavaDoc updates
 *	$
 *	$Revision 1.4  2004/12/12 20:21:10  kdhunter
 *	$Support for storing passwords in keyring
 *	$
 *	$Revision 1.3  2004/12/09 01:21:00  kdhunter
 *	$Mods to support two different buttons for "external"
 *	$or "internal" keystore files
 *	$
 *	$Revision 1.2  2004/12/07 01:10:19  kdhunter
 *	$Changes to allow project-relative or absolute
 *	$keystore paths
 *	$
 *	$Revision 1.1  2004/11/26 21:35:25  kdhunter
 *	$Moved from internal/signing
 *	$$
 *
 ********************************************************************
 */