com.endeca.soleng.eac.toolkit.component

Class IFCRComponent

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.IFCRComponent

public class IFCRComponent
extends com.endeca.soleng.eac.toolkit.component.CustomComponent

Field Summary

Fields

Modifier and Type	Field and Description
static DateFormat	DATE_FORMAT The date format to use when creating names for repository export files

Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir

Constructor Summary

Constructors

Constructor and Description
IFCRComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	createKeywordRedirectsNode() Creates the node and default group for keyword redirects.
void	exportApplication() Exports the contents of the configuration application.
void	exportConfigSnapshot(DgraphCluster dgraphCluster) Snapshots the current dgraph configuration and writes it to the export config dir of the given dgraph cluster.
void	exportNode(String directory) Exports the entire contents of a site into the given directory.
void	exportNode(String directory, String node) Exports the contents of the specified node into the given directory.
void	exportNode(String directory, String node, String archiveName) Exports the contents of the specified node into the given directory.
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
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	importNode(String directory) Imports the contents of the given directory into the site root.
void	importNode(String directory, String node) Imports the contents of the given directory into the specified node in the IFCR.
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	loadContent(String directory, String node) Loads the contents of the given directory into the specified node in the IFCR.
void	loadContent(String directory, String node, String replace) Loads the contents of the given directory into the specified node in the IFCR.
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(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.

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

Field Detail

DATE_FORMAT

public static final DateFormat DATE_FORMAT

The date format to use when creating names for repository export files

Constructor Detail

IFCRComponent

public IFCRComponent()

Method Detail

storeTrackerFileInfoForMdexZip

public void storeTrackerFileInfoForMdexZip(String updateDirectory,
                                  String fileName)
                                    throws IOException

Stores the name of the current zip file into the mdex tracking file for the directory given. The file is created or overwritten with the new value for the fileName parameter

Parameters:

updateDirectory - The directory containing the zip files

fileName - The name of the zip file written into the file

Throws:

IOException - is thrown if there were problems creating the file

storeTrackerFileInfoForAsssemblerZip

public void storeTrackerFileInfoForAsssemblerZip(String updateDirectory,
                                        String fileName)
                                          throws IOException

Stores the name of the current zip file into the assembler tracking file for the directory given. The file is created or overwritten with the new value for the fileName parameter

Parameters:

updateDirectory - The directory containing the zip files

fileName - The name of the zip file written into the file

Throws:

IOException - is thrown if there were problems creating the file

exportXml

public void exportXml()
               throws IOException,
                      com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Exports all IFCR content for the specified site as JCR system view XML. A timestamped file for the export is created in the working directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR or writing to disk

exportXml

public void exportXml(String fileName)
               throws IOException,
                      com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Exports all IFCR content for the specified site as JCR system view XML.

Parameters:

fileName - The name of the file to write the output to.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR or writing to disk

exportConfigSnapshot

public void exportConfigSnapshot(DgraphCluster dgraphCluster)
                          throws IOException,
                                 com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Snapshots the current dgraph configuration and writes it to the export config dir of the given dgraph cluster.

Parameters:

dgraphCluster - Config is being exported to this cluster.

Throws:

IOException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

importXmlWithPrompt

public void importXmlWithPrompt(String file)
                         throws MalformedURLException,
                                com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                IOException,
                                com.endeca.soleng.eac.toolkit.exception.AppControlException

Imports the content for a site into the IFCR from the given JCR system view XML file. A "Delete existing content and continue? [Y/N]" prompt will be shown to the user if the root node in the file already exists in the IFCR, and this method will read a response from System.in. If "y" or "yes" is not supplied, the method will return without processing the import.

Parameters:

file - The name of the file that contains the data to be imported

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR or reading from disk

com.endeca.soleng.eac.toolkit.exception.AppControlException - If there was an error upgrading the export file

MalformedURLException

importXml

public void importXml(String file)
               throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                      IOException,
                      com.endeca.soleng.eac.toolkit.exception.AppControlException

Imports the content for a site into the IFCR from the given JCR system view XML file. If the root node in the file already exists in the IFCR, it will be temporarily backed up, then deleted once the new node has been imported.

Parameters:

file - The name of the file that contains the data to be imported

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR or reading from disk

com.endeca.soleng.eac.toolkit.exception.AppControlException - If there was an error upgrading the export file

exportApplication

public void exportApplication()
                       throws IOException,
                              com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Exports the contents of the configuration application. This export will contain an archive of all the content and configuration for this application, as well as a file used by the assembler for import. This file must be present in the directory with the archive in order for Assembler import to work properly. Exports to the directory specified by the 'applicationExportDir' property.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from the IFCR or writing to disk

exportNode

public void exportNode(String directory,
              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

Exports the contents of the specified node into the given directory. Resources which are stored as files in the repository are exported as files. Other resources are serialized to JSON. 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.

Parameters:

directory - The output directory

node - The path to the IFCR node relative to the site node

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException - If there is a problem archiving the folder

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException - If there is a problem communicating with the EAC

IOException - If there is a problem reading from the IFCR or writing to disk

exportNode

public void exportNode(String directory,
              String node,
              String archiveName)
                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                       IOException

Exports the contents of the specified node into the given directory. Resources which are stored as files in the repository are exported as files. Other resources are serialized to JSON. If the expand parameter is set to 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.

Parameters:

directory - The output directory

node - The path to the IFCR node relative to the site node

archiveName - The name of the archive that will be put under the specified directory with the name of the application, time stamped.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from the IFCR or writing to disk

exportNode

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

Exports the entire contents of a site into the given directory. Resources which are stored as files in the repository are exported as files. Other resources are serialized to JSON. 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.

Parameters:

directory - The output directory

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException - If there is a problem archiving the folder

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException - If there is a problem communicating with the EAC

IOException - If there is a problem reading from the IFCR or writing to disk

loadContent

public void loadContent(String directory,
               String node)
                 throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                        IOException

Loads the contents of the given directory into the specified node in the IFCR. The required file format is defined by the Content Import Utility definition. For full details, see the Oracle Commerce Administrator's Guide.

Parameters:

directory - The input directory

node - The path to the node relative to the site node

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from disk or uploading to the IFCR

loadContent

public void loadContent(String directory,
               String node,
               String replace)
                 throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                        IOException

Loads the contents of the given directory into the specified node in the IFCR. The required file format is defined by the Content Import Utility definition. For full details, see the Oracle Commerce Administrator's Guide.

Parameters:

directory - The input directory

node - The path to the node relative to the site node

replace - 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.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from disk or uploading to the IFCR

createKeywordRedirectsNode

public void createKeywordRedirectsNode()
                                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                       IOException

Creates the node and default group for keyword redirects. Used to migrate customers from 3.1.0 to 3.1.1.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from disk or uploading to the IFCR

importNode

public void importNode(String directory,
              String node)
                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                       IOException

Imports the contents of the given directory into the specified node in the IFCR. JSON files are interpreted as node descriptions while other files are uploaded as the files themselves.

Parameters:

directory - The input directory

node - The path to the node relative to the site node

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from disk or uploading to the IFCR

importNode

public void importNode(String directory)
                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                       IOException

Imports the contents of the given directory into the site root. JSON files are interpreted as node descriptions while other files are uploaded as the files themselves.

Parameters:

directory - The input directory

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there is a problem reading from disk or uploading to the IFCR

pushLiveContentToDgraphById

public void pushLiveContentToDgraphById(String componentId)
                                 throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                        IOException

Causes the IFCR to push content from its live environment to the single specified dgraph.

Parameters:

componentId - The component ID of the dgraph

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR

pushAuthoringContentToDgraphById

public void pushAuthoringContentToDgraphById(String componentId)
                                      throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                             IOException

Causes the IFCR to push content from its authoring environment to the single specified dgraph.

Parameters:

componentId - The component ID of the dgraph

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR

promoteFromAuthoringToLive

public void promoteFromAuthoringToLive()
                                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                       IOException

Causes the IFCR to promote its authoring environment to be the live environment and publish the changes to the live dgraphs.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR

provisionSite

public void provisionSite()
                   throws IOException,
                          com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Provisions the site in the IFCR.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException - If the component was not configured correctly

IOException - If there was a problem communicating with the IFCR

getIFCR

public com.endeca.soleng.eac.toolkit.utility.IFCRUtility getIFCR()
                                                          throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Gets an IFCRUtility object which has been configured to connect to the IFCR using the properties specified on this component.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

getApplicationExportDir

public String getApplicationExportDir()

Gets the configured application export directory for the IFCR.

getRepoUrl

public String getRepoUrl()

Gets the configured root URL of the IFCR.

getUsername

@Deprecated
public String getUsername()

Deprecated. This method has been deprecated from version 11.0.0.

Gets the configured username to use when connecting to the IFCR.

getPassword

@Deprecated
public String getPassword()

Deprecated. This method has been deprecated from version 11.0.0.

Gets the configured password to use when connecting to the IFCR.

getCredentialsKey

public String getCredentialsKey()

Gets the configured credentialsKey to uniquely identify credentials in credential store

setCsfManager

public void setCsfManager(CSFManager csfManager)

Sets the CSFManager instance to retrieve credentials from CredentialStore

getCsfManager

public CSFManager getCsfManager()

Gets the CSFManager instance to retrieve credentials from credential store

getSiteName

public String getSiteName()

Gets the IFCR Site Name

getMaxNumBackups

public int getMaxNumBackups()

Gets the configured number of archived exports to keep

removeDefinition

public void removeDefinition()
                      throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                             com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

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.

Overrides:

removeDefinition in class com.endeca.soleng.eac.toolkit.component.CustomComponent

Throws:

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.

See Also:

CustomComponent.removeDefinition()

removeApplicationFromIFCR

protected void removeApplicationFromIFCR()

Completely removes application content from the IFCR