org.eclipse.mtj.api.extension
Interface SigningProvider

All Superinterfaces:

BuildExtension, org.eclipse.emf.ecore.EObject, MtjExtension, org.eclipse.emf.common.notify.Notifier

public interface SigningProvider
extends BuildExtension

The Signing Provider provides the interface to sign a project's deployment package.

Method Summary

DeploymentType[]	getSupportedTypes() Returns the deployment types that are supported.
java.lang.String	getToolLocation(org.eclipse.core.runtime.IProgressMonitor monitor) Implementations that rely on an external security tool, are responsible for persistant storage of the tool location value.
void	importToRootCert(java.lang.String rootcert, java.lang.String keystore, java.lang.String alias, java.lang.String password) Attempt to import keystore element (alias) into rootcert.
boolean	isRootCertToolAvailable() Returns whether the SingingProvider plug-in can provide root certificate management features.
boolean	isSigned(org.eclipse.mtj.api.model.IMtjProject mtjProject, org.eclipse.core.resources.IFolder targetFolder, org.eclipse.core.runtime.IProgressMonitor monitor) Method determines and reports if deployment is signed.
java.lang.String[]	listrootcert(java.lang.String rootcert) Returns string array populated with the contents of the rootcert.
void	removeCertFromRoot(java.lang.String rootcert, int removeindex) Attempts to remove an entry from rootcert.
boolean	sign(org.eclipse.mtj.api.model.IMtjProject project, org.eclipse.core.resources.IFolder targetFolder, SigningCertificate certificates, org.eclipse.core.runtime.IProgressMonitor monitor) Method signs the project with the certificates.
void	storeToolLocation(java.lang.String loc, org.eclipse.core.runtime.IProgressMonitor monitor) Implementations that rely on an external security tool, are responsible for persistant storage of the tool location value.
boolean	unsign(org.eclipse.mtj.api.model.IMtjProject mtjProject, org.eclipse.core.resources.IFolder targetFolder, org.eclipse.core.runtime.IProgressMonitor monitor) Method unsigns the project.

Methods inherited from interface org.eclipse.mtj.api.extension.BuildExtension

getExtJar, setExtJar

Methods inherited from interface org.eclipse.mtj.api.extension.MtjExtension

getDescription, getId, getType, getVendor, getVersion, isActive, setActive, setDescription, setId, setType, setVendor, setVersion

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

isRootCertToolAvailable

boolean isRootCertToolAvailable()
                                throws org.eclipse.mtj.exception.MtjException

Returns whether the SingingProvider plug-in can provide root certificate management features.

Returns:

true if root certificate management features are available, false otherwise

Throws:

org.eclipse.mtj.exception.MtjException

importToRootCert

void importToRootCert(java.lang.String rootcert,
                      java.lang.String keystore,
                      java.lang.String alias,
                      java.lang.String password)
                      throws org.eclipse.mtj.exception.MtjException

Attempt to import keystore element (alias) into rootcert. Uses password to access keystore

Parameters:

rootcert -

keystore -

alias -

password -

Throws:

org.eclipse.mtj.exception.MtjException

listrootcert

java.lang.String[] listrootcert(java.lang.String rootcert)
                                throws org.eclipse.mtj.exception.MtjException

Returns string array populated with the contents of the rootcert.

Parameters:

rootcert -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

removeCertFromRoot

void removeCertFromRoot(java.lang.String rootcert,
                        int removeindex)
                        throws org.eclipse.mtj.exception.MtjException

Attempts to remove an entry from rootcert. References target entry by index (removeindex).

Parameters:

rootcert -

removeindex -

Throws:

org.eclipse.mtj.exception.MtjException

getSupportedTypes

DeploymentType[] getSupportedTypes()
                                   throws org.eclipse.mtj.exception.MtjException

Returns the deployment types that are supported.

Returns:

DeploymentType[]

Throws:

org.eclipse.mtj.exception.MtjException

sign

boolean sign(org.eclipse.mtj.api.model.IMtjProject project,
             org.eclipse.core.resources.IFolder targetFolder,
             SigningCertificate certificates,
             org.eclipse.core.runtime.IProgressMonitor monitor)
             throws org.eclipse.mtj.exception.MtjException

Method signs the project with the certificates.

Parameters:

project -

targetFolder -

certificates -

monitor -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

unsign

boolean unsign(org.eclipse.mtj.api.model.IMtjProject mtjProject,
               org.eclipse.core.resources.IFolder targetFolder,
               org.eclipse.core.runtime.IProgressMonitor monitor)
               throws org.eclipse.mtj.exception.MtjException

Method unsigns the project.

Parameters:

mtjProject -

targetFolder -

monitor -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

isSigned

boolean isSigned(org.eclipse.mtj.api.model.IMtjProject mtjProject,
                 org.eclipse.core.resources.IFolder targetFolder,
                 org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.mtj.exception.MtjException

Method determines and reports if deployment is signed.

Parameters:

mtjProject -

targetFolder -

monitor -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getToolLocation

java.lang.String getToolLocation(org.eclipse.core.runtime.IProgressMonitor monitor)
                                 throws org.eclipse.mtj.exception.MtjException

Implementations that rely on an external security tool, are responsible for persistant storage of the tool location value.
This method should return the location of the tool. Should never return null.

Parameters:

monitor -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

storeToolLocation

void storeToolLocation(java.lang.String loc,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws org.eclipse.mtj.exception.MtjException

Implementations that rely on an external security tool, are responsible for persistant storage of the tool location value. This method should contain the code to store the location.

Parameters:

loc -

monitor -

Throws:

org.eclipse.mtj.exception.MtjException