de.hybris.bootstrap.config

Class ExtensionInfo

java.lang.Object

de.hybris.bootstrap.config.ExtensionInfo

public class ExtensionInfo
extends java.lang.Object

represents an extension and contains the meta information.

• String:name - the extension name
• String:abstractClassPrefix - abstract class prefix (not used?)
• String:classPrefix - the class prefix e.g. 'Generated'
• String:managerName - the manager class name of the extension
• String:managerSuperclass - the manager superclass name of the extension, default is: "de.hybris.platform.jalo.extension.Extension"
• String:typeCode: - TypeCode of an extension
• File:extensionDirectory - The directory of the extension (parent of file extensioninfo.xml)
• Collection:extensionmodules - Collection of AbstractExtensionModule which are part of this extension
• List:requiredextensions - List of extension names (Strings) which are required by this extension

Constructor Summary

Constructors

Constructor and Description
ExtensionInfo(PlatformConfig extensionsXML, java.io.File configFile, boolean isCoreExtension)
ExtensionInfo(java.lang.String contextRoot, java.util.HashMap metaMap)

Method Summary

Modifier and Type	Method and Description
void	addImplicitlyRequiredExtensionNames(java.util.Set<java.lang.String> extensionnames)
void	addRequiredExtensionName(java.lang.String extensionname)
boolean	equals(java.lang.Object obj)
java.lang.String	getAbstractClassPrefix()
java.util.Set<ExtensionInfo>	getAllConfiguredRequiredExtensionInfos()
java.lang.String	getAllConfiguredRequiredExtensionsString() Returns comma separated list string containing names or all extensions which are either explicitly required.
java.util.Set<ExtensionInfo>	getAllRequiredExtensionInfos() returns a List with all required ExtensionInfos which are needed by this extension.
java.util.Set<java.lang.String>	getAllRequiredExtensionNames()
java.lang.String	getAllRequiredExtensionsString() Returns comma separated list string containing names or all extensions which are either explicitly or implicitly required.
java.io.File	getBeansXML()
java.lang.String	getClassPrefix()
java.io.File	getConfigFile()
java.util.Set<java.lang.String>	getConfiguredRequiredExtensionNames()
CoreExtensionModule	getCoreModule()
java.io.File	getExtensionDirectory()
java.util.Set<java.io.File>	getGenericAuditXMLs()
HMCExtensionModule	getHMCModule()
java.util.Set<java.lang.String>	getImplicitRequiredExtensionNames()
java.io.File	getItemsXML()
java.lang.String	getManagerName()
java.lang.String	getManagerSuperclass()
java.lang.String	getMeta(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getMetaMap()
java.lang.String	getModulegenName()
java.util.Collection<AbstractExtensionModule>	getModules()
java.lang.String	getName()
java.util.Set<ExtensionInfo>	getRequiredExtensionInfos()
java.lang.String	getVersion()
WebExtensionModule	getWebModule()
int	hashCode()
boolean	isCoreExtension()
boolean	isCorePlusExtension()
boolean	isDeprecated()
boolean	isExcluded()
boolean	isExternalExtension()
boolean	isExtgenTemplate()
boolean	isItemsXMLModifiedAfter(long lastModifiedTime)
boolean	isJaloLogicFree()
boolean	isModifiedForCodeGeneration()
boolean	isModulegenTemplate()
boolean	isOldStyleExtension()
boolean	isRequiredByAll()
boolean	isWebExtension()
void	markUnmodifiedForCodeGeneration()
void	removeRequiredExtensionName(java.lang.String name)
void	setExcluded(boolean excluded)
void	setJaloLogicFree(boolean jaloLogicFree)
void	setRequiredByAll(boolean required)
void	setVersion(java.lang.String version)
java.lang.String	toString()
protected java.lang.String	toString(java.util.Collection<ExtensionInfo> extensions)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtensionInfo

public ExtensionInfo(java.lang.String contextRoot,
                     java.util.HashMap metaMap)
              throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

ExtensionInfo

public ExtensionInfo(PlatformConfig extensionsXML,
                     java.io.File configFile,
                     boolean isCoreExtension)
              throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

markUnmodifiedForCodeGeneration

public void markUnmodifiedForCodeGeneration()

isDeprecated

public boolean isDeprecated()

isModifiedForCodeGeneration

public boolean isModifiedForCodeGeneration()

getItemsXML

public java.io.File getItemsXML()

getBeansXML

public java.io.File getBeansXML()

getGenericAuditXMLs

public java.util.Set<java.io.File> getGenericAuditXMLs()

isItemsXMLModifiedAfter

public boolean isItemsXMLModifiedAfter(long lastModifiedTime)

getName

public java.lang.String getName()

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

isRequiredByAll

public boolean isRequiredByAll()

isJaloLogicFree

public boolean isJaloLogicFree()

isCoreExtension

public boolean isCoreExtension()

isWebExtension

public boolean isWebExtension()

setRequiredByAll

public void setRequiredByAll(boolean required)

setJaloLogicFree

public void setJaloLogicFree(boolean jaloLogicFree)

getAbstractClassPrefix

public java.lang.String getAbstractClassPrefix()

isOldStyleExtension

public boolean isOldStyleExtension()

getClassPrefix

public java.lang.String getClassPrefix()

getManagerName

public java.lang.String getManagerName()

getManagerSuperclass

public java.lang.String getManagerSuperclass()

getExtensionDirectory

public java.io.File getExtensionDirectory()

getConfigFile

public java.io.File getConfigFile()

getModules

public java.util.Collection<AbstractExtensionModule> getModules()

getAllRequiredExtensionNames

public java.util.Set<java.lang.String> getAllRequiredExtensionNames()

getConfiguredRequiredExtensionNames

public java.util.Set<java.lang.String> getConfiguredRequiredExtensionNames()

getImplicitRequiredExtensionNames

public java.util.Set<java.lang.String> getImplicitRequiredExtensionNames()

addRequiredExtensionName

public void addRequiredExtensionName(java.lang.String extensionname)

addImplicitlyRequiredExtensionNames

public void addImplicitlyRequiredExtensionNames(java.util.Set<java.lang.String> extensionnames)

removeRequiredExtensionName

public void removeRequiredExtensionName(java.lang.String name)

getCoreModule

public CoreExtensionModule getCoreModule()

getHMCModule

public HMCExtensionModule getHMCModule()

getWebModule

public WebExtensionModule getWebModule()

getAllRequiredExtensionInfos

public java.util.Set<ExtensionInfo> getAllRequiredExtensionInfos()

returns a List with all required ExtensionInfos which are needed by this extension. This is calculated recursivly, e.g. if A req B and B req C, then the result of this method for A will be {B,C}

getAllConfiguredRequiredExtensionInfos

public java.util.Set<ExtensionInfo> getAllConfiguredRequiredExtensionInfos()

getRequiredExtensionInfos

public java.util.Set<ExtensionInfo> getRequiredExtensionInfos()

Returns:

a Set with ExtensionInfo which contains all defined required extensions and also the implicitly required extensions.

getAllRequiredExtensionsString

public java.lang.String getAllRequiredExtensionsString()

Returns comma separated list string containing names or all extensions which are either explicitly or implicitly required.

getAllConfiguredRequiredExtensionsString

public java.lang.String getAllConfiguredRequiredExtensionsString()

Returns comma separated list string containing names or all extensions which are either explicitly required.

toString

protected java.lang.String toString(java.util.Collection<ExtensionInfo> extensions)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the name of the extension

getMeta

public java.lang.String getMeta(java.lang.String key)

Returns:

Returns the value for the meta key defined in extensioninfo.xml or null if not found

isExtgenTemplate

public boolean isExtgenTemplate()

Returns:

Returns true if the extensions meta value for the key PlatformConfig.PLATFORM_EXTGEN_TEMPLATE_KEY is true

isModulegenTemplate

public boolean isModulegenTemplate()

Returns:

Returns true if the extensions meta value for the key PlatformConfig.PLATFORM_MODULEGEN_NAME_KEY is set

getModulegenName

public java.lang.String getModulegenName()

Returns:

Returns the modulegen name if the extensions meta value for the key PlatformConfig.PLATFORM_MODULEGEN_NAME_KEY is given

isExcluded

public boolean isExcluded()

setExcluded

public void setExcluded(boolean excluded)

getMetaMap

public java.util.Map<java.lang.String,java.lang.String> getMetaMap()

isCorePlusExtension

public boolean isCorePlusExtension()

isExternalExtension

public boolean isExternalExtension()