|
EAC Components 3.2.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.soleng.eac.toolkit.base.EacElement com.endeca.soleng.eac.toolkit.base.Provisionable com.endeca.soleng.eac.toolkit.component.CustomComponent com.endeca.soleng.eac.toolkit.component.ConfigManagerComponent
public class ConfigManagerComponent
This custom component represents a configuration manager, which interacts with disparate configuration sources to retrieve and merge configuration files. This implementation handles integration with Web Studio's config store as well as a Dev Studio-maintained configuration source. Though this is "provisioned" like a component in the app configuration, this object's provisioning is stored as a set of custom properties (key value pairs) on the provisioned host on which this component runs.
Field Summary |
---|
Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement |
---|
appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir |
Constructor Summary | |
---|---|
ConfigManagerComponent()
Constructor for the Config Manager custom component. |
Method Summary | |
---|---|
void |
cleanDirs()
Cleans the component's directories. |
void |
downloadWsConfig()
Downloads Web Studio configuration to WS config directory. |
void |
downloadWsConfig(boolean filterInactive)
Downloads Web Studio configuration to WS config directory. |
void |
downloadWsDgraphConfig()
Downloads Web Studio dgraph configuration WS temp directory. |
void |
downloadWsDgraphConfig(boolean filterInactive)
Downloads Web Studio dgraph configuration WS temp directory. |
void |
fetchDsConfig()
Retrieves Dev Studio config from the DS config directory and delivers it to the merged config directory. |
void |
fetchMergedConfig()
Retrieves configuration from disparate sources and merges into the merged config directory. |
void |
fetchWsConfig()
Retrieves Web Studio config from the WS config directory and delivers it to the merged config directory. |
java.lang.String |
getDsConfigDir()
|
java.lang.String |
getMergedConfigDir()
|
java.lang.String |
getWsConfigDir()
|
java.lang.String |
getWsDgraphConfigDir()
|
java.lang.String |
getWsHost()
|
java.util.List<java.lang.String> |
getWsMaintainedFiles()
|
java.lang.String |
getWsPort()
|
java.lang.String |
getWsTempDir()
|
boolean |
isSkipTestingForFilesDuringCleanup()
Retrieves the boolean indicating whether directory cleanup should use the default behavior of first testing for non-empty directory contents, or if that test should be skipped. |
boolean |
isWebStudioEnabled()
|
void |
removeDefinition()
|
void |
removeWsConfig()
Removes any instance configuration files in Web Studio associated with this application. |
void |
updateWsConfig()
Updates Web Studio with the latest configuration. |
void |
updateWsDimensions()
Updates Web Studio with the latest post-Forge dimensions. |
Methods inherited from class com.endeca.soleng.eac.toolkit.component.CustomComponent |
---|
buildEacStub, getCustomDirectories, getHost, getHostId, getProperties, getProperty, isDefined, isDefinitionChanged, setCustomDirectories, setDefinition, setHostId, setProperties, updateDefinition |
Methods inherited from class com.endeca.soleng.eac.toolkit.base.Provisionable |
---|
getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition |
Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement |
---|
getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigManagerComponent()
Method Detail |
---|
public void cleanDirs() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
public void fetchMergedConfig() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void fetchDsConfig() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
public void fetchWsConfig() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
public void downloadWsConfig() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
#downloadWsConfig(true)
.
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void downloadWsConfig(boolean filterInactive) throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
filterInactive
- true if inactive merch rules should not be downloaded.
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void downloadWsDgraphConfig() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
#downloadWsDgraphConfig(true)
.
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void downloadWsDgraphConfig(boolean filterInactive) throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void updateWsConfig() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void removeWsConfig()
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void updateWsDimensions() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void removeDefinition() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
removeDefinition
in class com.endeca.soleng.eac.toolkit.component.CustomComponent
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
public java.lang.String getDsConfigDir()
public java.lang.String getWsConfigDir()
public java.lang.String getWsDgraphConfigDir()
public java.lang.String getWsPort()
public java.lang.String getWsHost()
public boolean isWebStudioEnabled()
public java.lang.String getWsTempDir()
public java.lang.String getMergedConfigDir()
public java.util.List<java.lang.String> getWsMaintainedFiles()
public boolean isSkipTestingForFilesDuringCleanup()
|
EAC Components 3.2.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@VERSION PRODUCT: EAC Components (eacComponents) VERSION: 3.2.2 BUILD: NONEDEV ARCH_OS: n/a DATE: 2012-02-28T13:13:23-0500