org.eclipse.mtj.core.build.sign
Interface ISignatureProperties
-
public interface ISignatureProperties
Classes implementing this interface are designed to hold the various
project-specific properties relating to potential signing operations.
It is mostly used by the UI to allow the user to manipulate the settings, as
well as the project properties persistence.
-
Since:
- 1.0
-
Restriction:
- This interface is not intended to be implemented by clients.
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. |
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
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
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
clear
void clear()
- Resets the class to its default values
-
copy
void copy(
ISignatureProperties other)
- Copy the values from another instance.
-
-
Parameters:
-
other
- ISignatureProperties
object to be copied.
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)
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)
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)
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()
getKeyStorePassword
String getKeyStorePassword()
- Returns the password for the keystore file, if passwords are being saved.
-
-
Returns:
-
String
containing keystore password. -
See Also:
-
setKeyStorePassword(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)
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)
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
isSignProject
boolean isSignProject()
- 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)
isProjectSpecific
boolean isProjectSpecific()
- Indicates whether or not the project has signing specific settings.
-
-
Returns:
-
true
if the project has specific signing settings
false
in case it used preference settings. -
See Also:
-
setProjectSpecific(boolean)
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)
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()
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()
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()
setKeyStorePassword
void setKeyStorePassword(
String strValue)
- Sets the password for the keystore file.
-
-
Parameters:
-
strValue
- String
containing keystore password. -
See Also:
-
getKeyStorePassword()
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)
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)
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
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:
-
isSignProject()
setProjectSpecific
void setProjectSpecific(boolean bValue)
- Indicates whether or not the project has specific signing settings.
-
-
Parameters:
-
bValue
- true
if the project has specific signing
settings false
otherwise. -
See Also:
-
isProjectSpecific()