com.endeca.soleng.eac.toolkit.utility

Class IFCRUtility

java.lang.Object

com.endeca.soleng.eac.toolkit.utility.IFCRUtility

public class IFCRUtility
extends Object

Utility class for performing operations on the IFCR including creating, modifying, copying, moving, deleting, and importing nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IFCRUtility.HttpStatusException An exception for use when an HTTP request returns a non-2xx status code.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE
static String	PUBLIC_IMPORT_MODE

Constructor Summary

Constructors

Constructor and Description
IFCRUtility(String repositoryUrl, String username, String password) Constructs a utility for operating on the repository at the given URL.

Method Summary

Modifier and Type	Method and Description
static void	close(OutputStream out) Attempts to close the given output stream.
void	copyNode(String src, String dest) Creates a copy of the specified source node at the specified destination.
void	deleteNode(String path) Deletes the specified node.
void	deployContent(String application, String targetEnvironment) Causes IFCR to deploy applicable content to the target environment.
String	exportJsonString(String nodeUrl) Returns a string with the JSON representation of the specified node and all of its descendants.
String	exportJsonString(String nodeUrl, String selector) Returns a string with the JSON representation of the specified node and all of its descendants.
void	exportMdexZip(String filePath, String node) Connects to the MDEXExportServlet and retrieves a zip file
void	exportNode(String targetDirPath, String configAbsPath) Exports the contents of the given node into the given directory.
void	exportNode(String directory, String fileName, String node) Exports the contents of the given node into the given directory.
void	exportXml(String filePath, String node) Exports the specified node and all of its descendants as JCR system view XML.
void	exportZip(String filePath, String node) Exports the specified node, and all its children, as a zip file.
String	getUsername() Method to retrieve username
org.apache.http.HttpResponse	httpGet(String path) Performs an HTTP GET request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpGet(String path, String params) Performs an HTTP GET request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpHead(String path) Performs an HTTP HEAD request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpPost(String path, org.apache.http.HttpEntity entity) Performs an HTTP POST request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpPost(String path, List<org.apache.http.NameValuePair> params) Performs an HTTP POST request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpPost(String path, String... params) Performs an HTTP POST request for the given resource (relative to the repository root).
org.apache.http.HttpResponse	httpPostDoNotConsume(String path, String... params) This works same way as httpPost(String, String...), but without consuming the HttpResponse.
void	importNode(String source, String node, String importMode, boolean replace) Imports the contents of the given directory or zip into the specified node in the IFCR.
void	importXml(String parentNode, String nodeName, String filePath) Imports the node hierarchy described in the specified JCR system view XML file into the IFCR.
void	legacyExportContent(String configAbsPath, boolean shouldExportRootNode, String targetDirPath) Deprecated.
void	legacyExportContent(String configAbsPath, String targetDirPath) Deprecated.
void	mdexPublish(String site) Causes the IFCR to publish all applicable content from the authoring environment to the authoring dgraphs for the specified site.
void	mdexPublish(String site, boolean authoring) Causes the IFCR to publish all applicable content from the specified environment to the appropriate dgraphs for the specified site.
void	mdexPublish(String site, boolean authoring, String componentId) Causes the IFCR to publish all applicable content from the specified environment to the specified dgraph for the specified site.
boolean	nodeExists(String path) Checks to see whether the specified node exists in the repository.
void	promoteFromAuthoringToLive(String site) Promotes the authoring environment of the specified site to be the live environment.
void	updateSearchTermExpansions(String node)
static void	writeDirectoryContents(String prefix, File dir, ZipOutputStream out) Write the contents of the specified directory to the given stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

PUBLIC_IMPORT_MODE

public static final String PUBLIC_IMPORT_MODE

See Also:

Constant Field Values

Constructor Detail

IFCRUtility

public IFCRUtility(String repositoryUrl,
                   String username,
                   String password)
            throws AppConfigurationException

Constructs a utility for operating on the repository at the given URL.

Parameters:

repositoryUrl - The URL of the repository

username - The username to use for authenticating to the IFCR

password - The password to use for authenticating to the IFCR

Throws:

AppConfigurationException - If the given URL was not valid

Method Detail

getUsername

public String getUsername()

Method to retrieve username

Returns:

Returns username

copyNode

public void copyNode(String src,
                     String dest)
              throws IOException

Creates a copy of the specified source node at the specified destination. Both the source and destination should be given relative to the repository root.

Parameters:

src - The path to the source node

dest - The path to the destination node

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

nodeExists

public boolean nodeExists(String path)
                   throws IOException

Checks to see whether the specified node exists in the repository.

Parameters:

path - The path to the node, relative to the repository root

Returns:

true if the node exists, false if not

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

deleteNode

public void deleteNode(String path)
                throws IOException

Deletes the specified node.

Parameters:

path - The path to the node, relative to the repository root

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

exportJsonString

public String exportJsonString(String nodeUrl,
                               String selector)
                        throws IOException

Returns a string with the JSON representation of the specified node and all of its descendants.

Parameters:

nodeUrl - The path to the node, relative to the repository root

Returns:

JSON representation of the node

Throws:

IOException

exportJsonString

public String exportJsonString(String nodeUrl)
                        throws IOException

Returns a string with the JSON representation of the specified node and all of its descendants.

Parameters:

nodeUrl - The path to the node, relative to the repository root

Returns:

JSON representation of the node

Throws:

IOException

exportZip

public void exportZip(String filePath,
                      String node)
               throws IOException

Exports the specified node, and all its children, as a zip file.

Parameters:

filePath - The path on file to export to.

node - The node you want to export as a zip file.

Throws:

IOException - Thrown when the node or its children could not be written to disk in a zip file.

exportXml

public void exportXml(String filePath,
                      String node)
               throws IOException

Exports the specified node and all of its descendants as JCR system view XML.

Parameters:

filePath - The path of the file to write the export to

node - The path to the node, relative to the repository root

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

exportMdexZip

public void exportMdexZip(String filePath,
                          String node)
                   throws IOException

Connects to the MDEXExportServlet and retrieves a zip file

Parameters:

filePath -

node -

Throws:

IOException

importXml

public void importXml(String parentNode,
                      String nodeName,
                      String filePath)
               throws IOException

Imports the node hierarchy described in the specified JCR system view XML file into the IFCR.

Parameters:

parentNode - The path to the parent node for the import, relative to the repository URL. This is the node that will end up having the root node of the import as a child.

nodeName - The name of the root node of the import

filePath - The file to import

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

exportNode

public void exportNode(String directory,
                       String fileName,
                       String node)
                throws IOException

Exports the contents of the given node into the given directory. Resources which are stored as files in the repository are exported as a zip file.

Parameters:

directory - The output directory

fileName - The name of the zip file to write to disk.

node - The path to the node relative to the repository URL

Throws:

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

exportNode

public void exportNode(String targetDirPath,
                       String configAbsPath)
                throws IOException

Exports the contents of the given node into the given directory. Resources which are stored as files in the repository are exported as files. Other resources are serialized to JSON.

Parameters:

targetDirPath - The output directory

configAbsPath - The path to the node relative to the repository URL

Throws:

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

legacyExportContent

@Deprecated
public void legacyExportContent(String configAbsPath,
                                            String targetDirPath)
                                     throws IOException

Deprecated.

Exports and unzips the Workbench content that resides under the given absolute path into the target directory. The format of exported content is legacy JCR format. Note that the content at given path is not exported, only the content under the given path is exported.

Parameters:

targetDirPath - The directory in which the exported content should be stored. If given directory doesn't exists, it will be created. If the given directory exists, all of its content will be deleted.

Throws:

IOException

legacyExportContent

@Deprecated
public void legacyExportContent(String configAbsPath,
                                            boolean shouldExportRootNode,
                                            String targetDirPath)
                                     throws IOException

Deprecated.

Exports and unzips the Workbench content that resides under the given absolute path into the target directory. The format of exported content is legacy JCR format.

Parameters:

targetDirPath - The directory in which the exported content should be stored. If given directory doesn't exists, it will be created.

shouldExportRootNode - When false, the content at given path is not exported, only the content under the given path is exported. When true, the content at the given path is exported as well.

Throws:

IOException

deployContent

public void deployContent(String application,
                          String targetEnvironment)
                   throws IOException

Causes IFCR to deploy applicable content to the target environment.

Parameters:

application - The application to be deployed

targetEnvironment - The targetEnvironment to be deployed. The possible values are "Authoring" and "Live". Currently only "Authoring" environment is supported. For other than "Authoring", an exception will be thrown.

Throws:

IOException

See Also:

#httpPost(String, List)}

updateSearchTermExpansions

public void updateSearchTermExpansions(String node)
                                throws IOException

Throws:

IOException

importNode

public void importNode(String source,
                       String node,
                       String importMode,
                       boolean replace)
                throws IOException

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

Parameters:

source - The input directory or zip

node - The path to the node relative to the repository URL

Throws:

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

writeDirectoryContents

public static void writeDirectoryContents(String prefix,
                                          File dir,
                                          ZipOutputStream out)
                                   throws IOException

Write the contents of the specified directory to the given stream.

Throws:

IOException

mdexPublish

public void mdexPublish(String site)
                 throws IOException

Causes the IFCR to publish all applicable content from the authoring environment to the authoring dgraphs for the specified site.

Parameters:

site - The site to publish

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

mdexPublish

public void mdexPublish(String site,
                        boolean authoring)
                 throws IOException

Causes the IFCR to publish all applicable content from the specified environment to the appropriate dgraphs for the specified site.

Parameters:

site - The site to publish

authoring - Whether to publish content from the authoring environment (as opposed to the live environment)

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

mdexPublish

public void mdexPublish(String site,
                        boolean authoring,
                        String componentId)
                 throws IOException

Causes the IFCR to publish all applicable content from the specified environment to the specified dgraph for the specified site.

Parameters:

site - The site to publish

authoring - Whether to publish content from the authoring environment (as opposed to the live environment)

componentId - The component ID of the dgraph to publish to

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

promoteFromAuthoringToLive

public void promoteFromAuthoringToLive(String site)
                                throws IOException

Promotes the authoring environment of the specified site to be the live environment.

Parameters:

site - The site to promote

Throws:

IOException - If there was a problem connecting to the IFCR or performing the operation

httpHead

public org.apache.http.HttpResponse httpHead(String path)
                                      throws IOException

Performs an HTTP HEAD request for the given resource (relative to the repository root).

Parameters:

path - The path

Returns:

The response

Throws:

IOException - If there was a problem connecting to the IFCR

httpGet

public org.apache.http.HttpResponse httpGet(String path)
                                     throws IOException

Performs an HTTP GET request for the given resource (relative to the repository root).

Parameters:

path - The path

Returns:

The response

Throws:

IOException - If there was a problem connecting to the IFCR

httpGet

public org.apache.http.HttpResponse httpGet(String path,
                                            String params)
                                     throws IOException

Performs an HTTP GET request for the given resource (relative to the repository root).

Parameters:

path - The path

params - The request parameters to use in the request. For example, name=value

Returns:

The response

Throws:

IOException - If there was a problem connecting to the IFCR

httpPost

public org.apache.http.HttpResponse httpPost(String path,
                                             List<org.apache.http.NameValuePair> params)
                                      throws IOException

Performs an HTTP POST request for the given resource (relative to the repository root).

Parameters:

path - The path

params - A list of parameters to include on the request

Returns:

The response (with its InputStream consumed)

Throws:

IOException - If there was a problem connecting to the IFCR

httpPost

public org.apache.http.HttpResponse httpPost(String path,
                                             String... params)
                                      throws IOException

Performs an HTTP POST request for the given resource (relative to the repository root).

Parameters:

path - The path

params - A list of parameters to include on the request

Returns:

The response (with its InputStream consumed)

Throws:

IOException - If there was a problem connecting to the IFCR

httpPost

public org.apache.http.HttpResponse httpPost(String path,
                                             org.apache.http.HttpEntity entity)
                                      throws IOException

Performs an HTTP POST request for the given resource (relative to the repository root).

Parameters:

path - The path

entity - The entity to include on the POST request

Returns:

The response (with its InputStream consumed)

Throws:

IOException - If there was a problem connecting to the IFCR

httpPostDoNotConsume

public org.apache.http.HttpResponse httpPostDoNotConsume(String path,
                                                         String... params)
                                                  throws IOException

This works same way as httpPost(String, String...), but without consuming the HttpResponse. The caller should be responsible for closing the stream.

Throws:

IOException

close

public static void close(OutputStream out)

Attempts to close the given output stream.