org.eclipse.mtj.core.model.sign
Interface ISignatureProperties

All Known Implementing Classes:

SignatureProperties

public interface ISignatureProperties

Classes implementing this interface are 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 persistence stuff.

Note: 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.

Field Summary

static int	PASSMETHOD_IN_KEYRING Password storage method indicating passwords should be stored in the user's Eclipse keyring
static int	PASSMETHOD_IN_PROJECT Password storage method indicating passwords should be stored in the .mtj metadata file in the project.
static int	PASSMETHOD_PROMPT Password storage method indicating passwords should be requested as required and not stored.
static String	PROJECT_RELATIVE_PREFIX String used to prefix project-relative paths in display strings.

Method Summary

void	clear() Resets the class to its default values
void	copy(ISignatureProperties other) Copy the values from another instance.
String	getAbsoluteKeyStorePath(IProject project) Returns the absolute file system path to the keystore file.
String	getKeyAlias() Returns the "alias" string identifying the key and certificate that will be used to sign the project.
String	getKeyPassword() Returns the key password, if passwords are being saved.
String	getKeyStoreDisplayPath() Returns the display string representing the keystore path.
String	getKeyStorePassword() Returns the password for the keystore file, if passwords are being saved.
String	getKeyStoreProvider() Returns the crypto provider string.
String	getKeyStoreType() Type of the keystore file.
int	getPasswordStorageMethod() Returns the password storage method.
boolean	getSignProject() Indicates whether or not the project is to be signed.
boolean	isKeyStorePathExternal() Indicates whether the keystore path is external to the project or project-relative.
void	setKeyAlias(String strValue) Sets the "alias" string identifying the key and certificate that will be used to sign the project.
void	setKeyPassword(String strValue) Sets the key password, if passwords are being saved.
void	setKeyStoreDisplayPath(String path) Sets the display string representing the keystore path.
void	setKeyStorePassword(String strValue) Sets the password for the keystore file.
void	setKeyStoreProvider(String strValue) Sets the crypto provider string.
void	setKeyStoreType(String strValue) Type of the keystore file.
void	setPasswordStorageMethod(int nMethod) Sets the password storage method.
void	setSignProject(boolean bValue) Indicates whether or not the project is to be signed.

Field Detail

PASSMETHOD_PROMPT

static final int PASSMETHOD_PROMPT

Password storage method indicating passwords should be requested as required and not stored.

See Also:

getPasswordStorageMethod(), setPasswordStorageMethod(int), Constant Field Values

PASSMETHOD_IN_KEYRING

static final int PASSMETHOD_IN_KEYRING

Password storage method indicating passwords should be stored in the user's Eclipse keyring

See Also:

getPasswordStorageMethod(), setPasswordStorageMethod(int), Constant Field Values

PASSMETHOD_IN_PROJECT

static final int PASSMETHOD_IN_PROJECT

Password storage method indicating passwords should be stored in the .mtj metadata file in the project.

See Also:

getPasswordStorageMethod(), setPasswordStorageMethod(int), Constant Field Values

PROJECT_RELATIVE_PREFIX

static final String PROJECT_RELATIVE_PREFIX

String used to prefix project-relative paths in display strings. A display string that starts with this prefix will be considered project-relative. Display strings that do not start with this prefix will be considered absolute.

See Also:

setKeyStoreDisplayPath(String), Constant Field Values

Method Detail

copy

void copy(ISignatureProperties other)

Copy the values from another instance.

Parameters:

other - ISignatureProperties object to be copied.

clear

void clear()

Resets the class to its default values

getSignProject

boolean getSignProject()

Indicates whether or not the project is to be signed.

Returns:

true if the project is to be signed, false otherwise

See Also:

setSignProject(boolean)

setSignProject

void setSignProject(boolean bValue)

Indicates whether or not the project is to be signed.

Parameters:

bValue - true if the project is to be signed, false otherwise.

See Also:

getSignProject()

getPasswordStorageMethod

int getPasswordStorageMethod()

Returns the password storage method.

Returns:

One of PASSMETHOD_PROMPT, PASSMETHOD_IN_KEYRING or PASSMETHOD_IN_PROJECT.

See Also:

setPasswordStorageMethod(int), PASSMETHOD_IN_KEYRING, PASSMETHOD_IN_PROJECT, PASSMETHOD_PROMPT

setPasswordStorageMethod

void setPasswordStorageMethod(int nMethod)

Sets the password storage method.

Parameters:

nMethod - One of PASSMETHOD_PROMPT, PASSMETHOD_IN_KEYRING or PASSMETHOD_IN_PROJECT.

See Also:

getPasswordStorageMethod(), PASSMETHOD_IN_KEYRING, PASSMETHOD_IN_PROJECT, PASSMETHOD_PROMPT

getKeyStoreType

String getKeyStoreType()

Type of the keystore file. null indicates the system standard type. This string is passed to KeyStore.getInstance as part of loading the keystore.

Returns:

String indicating keystore file type.

See Also:

setKeyStoreType(String), KeyStore.getInstance(java.lang.String), KeyStore.getInstance(java.lang.String, java.lang.String)

setKeyStoreType

void setKeyStoreType(String strValue)

Type of the keystore file. null indicates the system standard type. This string is passed to KeyStore.getInstance as part of loading the keystore.

Parameters:

strValue - KeyStore type string, or null to use the system default type.

See Also:

getKeyStoreType(), KeyStore.getInstance(java.lang.String), KeyStore.getInstance(java.lang.String, java.lang.String)

getKeyStoreProvider

String getKeyStoreProvider()

Returns the crypto provider string. null indicates the system standard type. This string is passed to KeyStore.getInstance as part of loading the keystore.

Returns:

KeyStore provider string, or null to use the system default provider.

See Also:

setKeyStoreProvider(String), KeyStore.getInstance(java.lang.String, java.lang.String)

setKeyStoreProvider

void setKeyStoreProvider(String strValue)

Sets the crypto provider string. null indicates the system standard type.

Parameters:

strValue - KeyStore provider string, or null to use the system default provider.

See Also:

getKeyStoreProvider(), KeyStore.getInstance(java.lang.String, java.lang.String)

getKeyStorePassword

String getKeyStorePassword()

Returns the password for the keystore file, if passwords are being saved.

Returns:

String containing keystore password.

See Also:

setKeyStorePassword(String)

setKeyStorePassword

void setKeyStorePassword(String strValue)

Sets the password for the keystore file.

Parameters:

strValue - String containing keystore password.

See Also:

getKeyStorePassword()

getKeyAlias

String getKeyAlias()

Returns the "alias" string identifying the key and certificate that will be used to sign the project.

Returns:

String containing the alias identifying the key and certificate.

See Also:

setKeyAlias(String)

setKeyAlias

void setKeyAlias(String strValue)

Sets the "alias" string identifying the key and certificate that will be used to sign the project.

Parameters:

strValue - String containing the alias identifying the key and certificate.

See Also:

getKeyAlias()

getKeyPassword

String getKeyPassword()

Returns the key password, if passwords are being saved. Will return null if passwords are not being saved.

Returns:

String containing the key password.

See Also:

setKeyPassword(String)

setKeyPassword

void setKeyPassword(String strValue)

Sets the key password, if passwords are being saved. Ignored if passwords are not being saved.

Parameters:

strValue - String containing the key password.

See Also:

getKeyPassword()

getKeyStoreDisplayPath

String getKeyStoreDisplayPath()

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 "$/[Folder[/Folder...]]filename". Absolute paths have OS-dependent form.

Returns:

String containing displayed path.

See Also:

setKeyStoreDisplayPath(String), isKeyStorePathExternal()

setKeyStoreDisplayPath

void setKeyStoreDisplayPath(String path)

Sets the display string representing the keystore path. This may be an absolute path, or it may be a project-relative path.

Parameters:

path - String containing displayed path.

See Also:

getKeyStoreDisplayPath()

getAbsoluteKeyStorePath

String getAbsoluteKeyStorePath(IProject project)
                               throws CoreException

Returns the absolute file system path to the keystore file. The specified project instance is used to convert a project-relative path to an absolute path.

Parameters:

project - IProject to which this ISignatureProperties belongs.

Returns:

String containing absolute path to keystore file.

Throws:

CoreException

See Also:

setKeyStoreDisplayPath(String)

isKeyStorePathExternal

boolean isKeyStorePathExternal()

Indicates whether the keystore path is external to the project or project-relative.

Returns:

true if the keystore path is external to the project, false if it's relative to the current project.

See Also:

setKeyStoreDisplayPath(String)