public class ModuleInfo
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
ModuleInfo.Builder |
static class |
ModuleInfo.JarInfo
Contains meta information about a module's jar file, such as its scope and native lib parameters, and path within
the module package.
|
static class |
ModuleInfo.ModuleDependency |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
long |
getCrc()
The module file's crc is calculated when the modl file is loaded in the Gateway.
|
java.util.Map<java.lang.Integer,ModuleInfo.ModuleDependency> |
getDependencies() |
java.lang.String |
getDescription() |
java.lang.String |
getDocumentationRoot()
The root of the module's documentation, expected to be an HTML file and must be stored under a folder named
"doc"
|
java.util.List<ModuleInfo.JarInfo> |
getExports() |
java.util.Map<java.lang.Integer,java.lang.String> |
getHooks() |
java.lang.String |
getId() |
java.lang.String |
getInstallPath()
The location of the module on the local file system.
|
java.util.List<ModuleInfo.JarInfo> |
getJars() |
java.lang.String |
getLicenseFile()
The name of an HTML-formatted license file to be found in the module's *.modl file
|
LicenseState |
getLicenseState() |
java.lang.String |
getName() |
int |
getRequiredFrameworkVersion() |
Version |
getRequiredIgnitionVersion() |
java.lang.String |
getVendorContactInfo() |
int |
getVendorId() |
java.lang.String |
getVendorName() |
Version |
getVersion() |
int |
hashCode() |
boolean |
isFree() |
boolean |
isSelfSigned() |
boolean |
isTrialMode()
Returns true if the module is not marked as a free module AND either the module's license state is not set or the
license state is a trial license
|
static ModuleInfo.Builder |
newBuilder() |
void |
setCrc(long crc) |
void |
setFree()
Set to true when modules implement GatewayModuleHook.isFreeModule() to return true
|
void |
setInstallPath(java.lang.String installPath)
Sets the location of the module on the local file system.
|
void |
setLicenseState(LicenseState newState) |
void |
setSelfSigned()
Setter needs to exist so that the Marketplace can add the selfsigned=true property to a module.xml when a user is
signing their own module.
|
void |
setVendorInfo(int vendorId,
java.lang.String vendorName,
java.lang.String vendorContactInfo)
Setter needs to exist so that the Marketplace can add the vendor info to module.xml when uploading a customer's
module.
|
static java.util.List<ModuleInfo> |
sortDependencyOrder(java.util.List<ModuleInfo> list,
int scope,
boolean reverse)
Sorts the list of module infos in correct dependency order.
|
java.lang.String |
toString() |
java.lang.String |
toXML() |
public static ModuleInfo.Builder newBuilder()
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getDescription()
public int getVendorId()
public java.lang.String getVendorName()
public java.lang.String getVendorContactInfo()
public void setVendorInfo(int vendorId, java.lang.String vendorName, java.lang.String vendorContactInfo)
vendorId
- vendorName
- vendorContactInfo
- public java.lang.String getLicenseFile()
public java.lang.String getDocumentationRoot()
public Version getVersion()
public Version getRequiredIgnitionVersion()
public int getRequiredFrameworkVersion()
public java.util.Map<java.lang.Integer,java.lang.String> getHooks()
public java.util.List<ModuleInfo.JarInfo> getJars()
public java.util.List<ModuleInfo.JarInfo> getExports()
public java.util.Map<java.lang.Integer,ModuleInfo.ModuleDependency> getDependencies()
public boolean isFree()
public boolean isSelfSigned()
public void setFree()
public void setSelfSigned()
public boolean isTrialMode()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public LicenseState getLicenseState()
public void setLicenseState(LicenseState newState)
public long getCrc()
public void setCrc(long crc)
public java.lang.String getInstallPath()
public void setInstallPath(java.lang.String installPath)
installPath
- public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toXML()
public static java.util.List<ModuleInfo> sortDependencyOrder(java.util.List<ModuleInfo> list, int scope, boolean reverse) throws DependencyCycleException
list
- scope
- DependencyCycleException
- If a dependency cycle is detected