public class IFCRComponent
extends com.endeca.soleng.eac.toolkit.component.CustomComponent
Modifier and Type | Field and Description |
---|---|
static DateFormat |
DATE_FORMAT
The date format to use when creating names for repository export files
|
Constructor and Description |
---|
IFCRComponent() |
Modifier and Type | Method and Description |
---|---|
void |
createKeywordRedirectsNode()
Deprecated.
|
void |
exportApplication()
Exports the contents of the configured application.
|
void |
exportApplication(String targetDirPath)
Exports the contents of the configured application.
|
void |
exportApplication(String targetDirPath,
String directoryFormat)
Exports the contents of the configured application.
|
void |
exportConfigSnapshot(DgraphCluster dgraphCluster)
Snapshots the current dgraph configuration and writes it to the
export config dir of the given dgraph cluster.
|
void |
exportContent(String relPath,
String targetDirPath)
Exports the specified Workbench content into the target directory.
|
void |
exportContent(String relPath,
String targetDirPath,
String directoryFormat)
Exports the specified Workbench content into the target directory.
|
void |
exportNode(String directory)
Deprecated.
|
void |
exportNode(String targetDirPath,
String node)
Deprecated.
|
void |
exportNode(String directory,
String node,
String archiveName)
Deprecated.
|
void |
exportXml()
Exports all IFCR content for the specified site as JCR system view XML.
|
void |
exportXml(String fileName)
Exports all IFCR content for the specified site as JCR system view XML.
|
String |
getApplicationExportDir()
Gets the configured application export directory for the IFCR.
|
String |
getCredentialsKey()
Gets the configured credentialsKey to uniquely identify credentials in credential store
|
com.endeca.soleng.eac.toolkit.util.CSFManager |
getCsfManager()
Gets the CSFManager instance to retrieve credentials from
credential store
|
com.endeca.soleng.eac.toolkit.utility.IFCRUtility |
getIFCR()
Gets an
IFCRUtility object which has been configured to
connect to the IFCR using the properties specified on this component. |
int |
getMaxNumBackups()
Gets the configured number of archived exports to keep
|
String |
getPassword()
Deprecated.
This method has been deprecated from version 11.0.0.
|
String |
getRepoUrl()
Gets the configured root URL of the IFCR.
|
String |
getSiteName()
Gets the IFCR Site Name
|
String |
getUsername()
Deprecated.
This method has been deprecated from version 11.0.0.
|
void |
importApplication(String sourcePath)
Imports the contents of the given directory or zip and
replaces the configured application.
|
void |
importContent(String relPath,
String sourceDirPath)
Imports the contents of the given directory or zip into the specified
path in the workbench.
|
void |
importNode(String directory)
Deprecated.
|
void |
importNode(String directory,
String node)
Deprecated.
|
void |
importXml(String file)
Imports the content for a site into the IFCR from the given JCR
system view XML file.
|
void |
importXmlWithPrompt(String file)
Imports the content for a site into the IFCR from the given JCR
system view XML file.
|
void |
legacyExportContent(String relPath,
String targetDirPath)
Deprecated.
|
void |
legacyUpdateContent(String relPath,
String sourceDirPath)
Deprecated.
|
void |
loadContent(String directory,
String node)
Deprecated.
|
void |
loadContent(String directory,
String node,
String replace)
Deprecated.
|
void |
promoteFromAuthoringToLive()
Causes the IFCR to promote its authoring environment to be the
live environment and publish the changes to the live dgraphs.
|
void |
provisionSite()
Provisions the site in the IFCR.
|
void |
pushAuthoringContentToDgraphById(String componentId)
Causes the IFCR to push content from its authoring environment to
the single specified dgraph.
|
void |
pushLiveContentToDgraphById(String componentId)
Causes the IFCR to push content from its live environment to
the single specified dgraph.
|
protected void |
removeApplicationFromIFCR()
Completely removes application content from the IFCR
|
void |
removeDefinition()
In addition to removing the definition of this component from the EAC,
the
IFCRComponent implementation also removes all content
for the site from the IFCR. |
void |
setCsfManager(com.endeca.soleng.eac.toolkit.util.CSFManager csfManager)
Sets the CSFManager instance to retrieve credentials from
CredentialStore
|
void |
storeTrackerFileInfoForAsssemblerZip(String updateDirectory,
String fileName)
Stores the name of the current zip file into the assembler tracking file for the directory
given.
|
void |
storeTrackerFileInfoForMdexZip(String updateDirectory,
String fileName)
Stores the name of the current zip file into the mdex tracking file for the directory
given.
|
buildEacStub, getCustomDirectories, getHost, getHostId, getProperties, getProperty, isDefined, isDefinitionChanged, setCustomDirectories, setDefinition, setHostId, setProperties, updateDefinition
getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition
getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir
public static final DateFormat DATE_FORMAT
public void storeTrackerFileInfoForMdexZip(String updateDirectory, String fileName) throws IOException
updateDirectory
- The directory containing the zip filesfileName
- The name of the zip file written into the fileIOException
- is thrown if there were problems creating the filepublic void storeTrackerFileInfoForAsssemblerZip(String updateDirectory, String fileName) throws IOException
updateDirectory
- The directory containing the zip filesfileName
- The name of the zip file written into the fileIOException
- is thrown if there were problems creating the filepublic void exportXml() throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCR
or writing to diskpublic void exportXml(String fileName) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
fileName
- The name of the file to write the output to.com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCR
or writing to diskpublic void exportConfigSnapshot(DgraphCluster dgraphCluster) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
dgraphCluster
- Config is being exported to this cluster.IOException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public void importXmlWithPrompt(String file) throws MalformedURLException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException, com.endeca.soleng.eac.toolkit.exception.AppControlException
file
- The name of the file that contains the data to be importedcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCR
or reading from diskcom.endeca.soleng.eac.toolkit.exception.AppControlException
- If there was an error upgrading the export fileMalformedURLException
public void importXml(String file) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException, com.endeca.soleng.eac.toolkit.exception.AppControlException
file
- The name of the file that contains the data to be importedcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCR
or reading from diskcom.endeca.soleng.eac.toolkit.exception.AppControlException
- If there was an error upgrading the export filepublic void exportApplication() throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the IFCR or
writing to diskpublic void exportApplication(String targetDirPath) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
targetDirPath
- The output directory where the exported application will residecom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the IFCR or
writing to diskpublic void exportApplication(String targetDirPath, String directoryFormat) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
targetDirPath
- The output directory where the exported application will residedirectoryFormat
- Export as directory if true, export as zip otherwisecom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the IFCR or
writing to diskpublic void importApplication(String sourcePath) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
sourcePath
- The input directory or zipcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbenchpublic void exportContent(String relPath, String targetDirPath) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
relPath
- The path to content being exported, relative to the applicationtargetDirPath
- The output directory where the exported artifact will residecom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the Workbench or
writing to diskpublic void exportContent(String relPath, String targetDirPath, String directoryFormat) throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
relPath
- The path to content being exported, relative to the applicationtargetDirPath
- The output directory where the exported artifact will residedirectoryFormat
- Export as directory if true, export as zip otherwisecom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the Workbench or
writing to diskpublic void importContent(String relPath, String sourceDirPath) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
relPath
- The path of the Workbench content relative to the applicationsourceDirPath
- The input directory or zipcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void exportNode(String targetDirPath, String node) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, IOException
targetDirPath
- The output directorynode
- The path to the IFCR node relative to the applicationcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlycom.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- If there is a problem archiving
the foldercom.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- If there is a problem communicating
with the EACIOException
- If there is a problem reading from the IFCR or
writing to disk@Deprecated public void exportNode(String directory, String node, String archiveName) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
FALSE
, these files will remain compressed in the
specified directory.
If the specified directory is not empty, its contents will be
archived. The number of archives to keep can be configured by
setting this component's "numExportBackups" property.
Deprecation note:
This method is deprecated in favor of exportContent.
exportContent supports exporting content as a zip or directory.directory
- The output directorynode
- The path to the IFCR node relative to the applicationarchiveName
- The name of the archive that will be put under
the specified directory with the name of the application,
time stamped.com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from the IFCR or
writing to disk@Deprecated public void exportNode(String directory) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException, com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, IOException
directory
- The output directorycom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlycom.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- If there is a problem
archiving the foldercom.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- If there is a problem
communicating with the EACIOException
- If there is a problem reading from the IFCR or
writing to disk@Deprecated public void loadContent(String directory, String node) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
directory
- The input directorynode
- The path to the node relative to the applicationcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void loadContent(String directory, String node, String replace) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
directory
- The input directorynode
- The path to the node relative to the applicationreplace
- If true, hierarchical objects (folders, collections,
pages) which already exist will be completely replaced by the new
content. All children of these objects will be removed and replaced
with the children being loaded. If this value is false, child objects
will be added to the existing set of children.com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void createKeywordRedirectsNode() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void importNode(String directory, String node) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
directory
- The input directorynode
- The path to the node relative to the applicationcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void importNode(String directory) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
legacyUpdateContent
.
Deprecation note:
This method is deprecated in favor of importContent.
importContent supports import of a zip or directory of
Workbench content in public format. See the Commerce Admin
Guide for supported types of Workbench content.directory
- The input directorycom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbench@Deprecated public void legacyExportContent(String relPath, String targetDirPath) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
relPath
- The path of the Workbench content relative to the application.
If given String is empty, this method only exports configuration and media content of the application in the
legacy format.
All other content can be exported by using exportApplication(targetDirPath) method.targetDirPath
- The output directorycom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlycom.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- If there is a problem archiving
the foldercom.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- If there is a problem communicating
with the EACIOException
- If there is a problem reading from the Workbench or
writing to disk@Deprecated public void legacyUpdateContent(String relPath, String sourceDirPath) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
importNode
as it only
updates Workbench content described in the files from the given directory,
and does not delete other existing Workbench content.
Deprecation note:
This method is deprecated in favor of importContent.
importContent supports import of a zip or directory of
Workbench content in public format. See the Commerce Admin
Guide for supported types of Workbench content.relPath
- The path to the Workbench content relative to the applicationsourceDirPath
- The input directorycom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there is a problem reading from disk or
uploading to the workbenchpublic void pushLiveContentToDgraphById(String componentId) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
componentId
- The component ID of the dgraphcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCRpublic void pushAuthoringContentToDgraphById(String componentId) throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
componentId
- The component ID of the dgraphcom.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCRpublic void promoteFromAuthoringToLive() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException, IOException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCRpublic void provisionSite() throws IOException, com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
- If the component was not
configured correctlyIOException
- If there was a problem communicating with the IFCRpublic com.endeca.soleng.eac.toolkit.utility.IFCRUtility getIFCR() throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
IFCRUtility
object which has been configured to
connect to the IFCR using the properties specified on this component.com.endeca.soleng.eac.toolkit.exception.AppConfigurationException
public String getApplicationExportDir()
public String getRepoUrl()
@Deprecated public String getUsername()
@Deprecated public String getPassword()
public String getCredentialsKey()
public void setCsfManager(com.endeca.soleng.eac.toolkit.util.CSFManager csfManager)
public com.endeca.soleng.eac.toolkit.util.CSFManager getCsfManager()
public String getSiteName()
public int getMaxNumBackups()
public void removeDefinition() throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException, com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
IFCRComponent
implementation also removes all content
for the site from the IFCR.removeDefinition
in class com.endeca.soleng.eac.toolkit.component.CustomComponent
com.endeca.soleng.eac.toolkit.exception.EacCommunicationException
- If a communication error occurs while
retrieving the provisioning port.com.endeca.soleng.eac.toolkit.exception.EacComponentControlException
- If an error occurs while trying to
start, stop or check the status of a component.CustomComponent.removeDefinition()
protected void removeApplicationFromIFCR()
Copyright © 2014, Oracle and/or its affiliates. All rights reserved.