org.eclipse.mtj.core.project.midp
Interface IMidletSuiteProject

All Superinterfaces:

IMTJProject

public interface IMidletSuiteProject
extends IMTJProject

This interface represents an specialization of an IMTJProject to represent a MIDlet suite project.

Features of MTJ projects include:

• Has an associated "Application Descriptor" file.
• Controls the process of preverifying its resources.
• Carry properties related to the signing process.
• Notify listeners when it's state changes.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the MTJ team.

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

Field Summary

static String

APPLICATION_DESCRIPTOR_NAME The project's application descriptor file name.

Method Summary

IApplicationDescriptor	getApplicationDescriptor() Return an ApplicationDescriptor instance wrapped around the Application Descriptor (JAD) file for this MIDlet suite.
IFile	getApplicationDescriptorFile() Return the IFile instance of the Application Descriptor (JAD) file for this MIDlet suite.
String	getJadFileName() Return the name that must be used on the project's jad file after deployment as specified in the project's metadata file.
String	getJarFilename() Return the name to use for the deployable JAR file.
String	getTempKeyPassword() Get the temporary password for a key in the keystore.
String	getTempKeystorePassword() Get the temporary password for the keystore.
IFolder	getVerifiedClassesOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
IFolder	getVerifiedLibrariesOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified libraries should be written.
IFolder	getVerifiedOutputFolder(IProgressMonitor monitor) Get the IFolder into which verified classes should be written.
IPreverificationError[]	preverify(IResource[] toVerify, IFolder outputFolder, IProgressMonitor monitor) Preverify the specified resources.
IPreverificationError[]	preverifyJarFile(File jarFile, IFolder outputFolder, IProgressMonitor monitor) Launch the preverification process on the specified jar file.
void	setJadFileName(String jadFileName) Set the name that must be used on the project's jad file after deployment as specified in the project's metadata file.
void	setTempKeyPassword(String pass) Get the temporary password for a key in the keystore.
void	setTempKeystorePassword(String pass) Get the temporary password for the keystore.

Methods inherited from interface org.eclipse.mtj.core.project.IMTJProject

addMTJProjectListener, createPackage, getJavaProject, getProject, getRuntimeList, getSignatureProperties, refreshClasspath, removeMTJProjectListener, saveMetaData, setSignatureProperties

Field Detail

APPLICATION_DESCRIPTOR_NAME

static final String APPLICATION_DESCRIPTOR_NAME

The project's application descriptor file name.

See Also:

Constant Field Values

Method Detail

getApplicationDescriptor

IApplicationDescriptor getApplicationDescriptor()

Return an ApplicationDescriptor instance wrapped around the Application Descriptor (JAD) file for this MIDlet suite.

Returns:

the suite's application descriptor.

getApplicationDescriptorFile

IFile getApplicationDescriptorFile()

Return the IFile instance of the Application Descriptor (JAD) file for this MIDlet suite.

Returns:

the suite's application descriptor IFile.

getJadFileName

String getJadFileName()

Return the name that must be used on the project's jad file after deployment as specified in the project's metadata file.

Returns:

the deployable jad file name.

getJarFilename

String getJarFilename()

Return the name to use for the deployable JAR file.

Returns:

the jar file name.

getTempKeyPassword

String getTempKeyPassword()

Get the temporary password for a key in the keystore.

Returns:

temporary password for a key in the keystore.

getTempKeystorePassword

String getTempKeystorePassword()

Get the temporary password for the keystore.

Returns:

temporary password for the keystore.

getVerifiedClassesOutputFolder

IFolder getVerifiedClassesOutputFolder(IProgressMonitor monitor)

Get the IFolder into which verified classes should be written.

Parameters:

monitor - a progress monitor, or null if progress reporting is not desired.

Returns:

a handle to the folder where verified classes should be outputted.

getVerifiedLibrariesOutputFolder

IFolder getVerifiedLibrariesOutputFolder(IProgressMonitor monitor)

Get the IFolder into which verified libraries should be written.

Parameters:

monitor - a progress monitor, or null if progress reporting is not desired.

Returns:

a handle to the folder where libraries should be outputted.

getVerifiedOutputFolder

IFolder getVerifiedOutputFolder(IProgressMonitor monitor)

Get the IFolder into which verified classes should be written.

Parameters:

monitor - a progress monitor, or null if progress reporting is not desired.

Returns:

the verified root output folder.

preverify

IPreverificationError[] preverify(IResource[] toVerify,
                                  IFolder outputFolder,
                                  IProgressMonitor monitor)
                                  throws CoreException,
                                         PreverifierNotFoundException

Preverify the specified resources. Return the map of class names with preverification errors mapped to the error that was caused.

Parameters:

toVerify - the resources to be preverified

outputFolder - the folder into which the output will be written

monitor - a progress monitor, or null if progress reporting is not desired.

Returns:

An array of errors found during preverification.

Throws:

CoreException - if this method fails. Reasons include:

• The existence of outputFolder could not be guaranteed.
• The command line for triggering the preverification process could not be created.
• The preverification process could not be created correctly.

PreverifierNotFoundException - a default preverifier was not specified.

preverifyJarFile

IPreverificationError[] preverifyJarFile(File jarFile,
                                         IFolder outputFolder,
                                         IProgressMonitor monitor)
                                         throws CoreException,
                                                PreverifierNotFoundException

Launch the preverification process on the specified jar file.

Parameters:

jarFile - The jar file to be preverified.

outputFolder - The folder into which the output is to be placed.

monitor - a progress monitor, or null if progress reporting is not desired.

Returns:

An array of errors found during preverification.

Throws:

CoreException - if this method fails. Reasons include:

• The .jar file could not be expanded.
• The existence of outputFolder could not be guaranteed.
• The command line for triggering the preverification process could not be created.
• The preverification process could not be created correctly.

PreverifierNotFoundException - a default preverifier was not specified.

setJadFileName

void setJadFileName(String jadFileName)

Set the name that must be used on the project's jad file after deployment as specified in the project's metadata file.

Parameters:

jadFileName - the deployable jad file name.

setTempKeyPassword

void setTempKeyPassword(String pass)

Get the temporary password for a key in the keystore.

Parameters:

pass - temporary password for a key in the keystore.

setTempKeystorePassword

void setTempKeystorePassword(String pass)

Get the temporary password for the keystore.

Parameters:

pass - temporary password for the keystore.