info.magnolia.commands

Class ExportJcrNodeToYamlCommand

java.lang.Object

info.magnolia.commands.MgnlCommand

info.magnolia.commands.impl.BaseRepositoryCommand

info.magnolia.commands.ExportJcrNodeToYamlCommand

All Implemented Interfaces:

Command, Cloneable

public class ExportJcrNodeToYamlCommand
extends BaseRepositoryCommand

Converts and exports a JCR sub-tree into to Yaml file.

Note: Supports only those JCR paths that represent the roots of definition objects, i.e. which are possible to query from RegistryFacade.
Note: 'extends' property is 'expanded' meaning that exported Yaml has effective structure with all the data and no 'extends'.

Command assumes following input parameters to be set:

• workspace - 'config' workspace by default
• path - JCR node path which represents a definition object from some Registry

Following output parameters are set by command:

• outputStream containing Yaml content
• fileName by which the content can be downloaded

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPORT_OUTPUT_STREAM

Fields inherited from interface info.magnolia.commands.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
ExportJcrNodeToYamlCommand(RegistryFacade registryFacade, DefinitionRawViewToYamlConverter definitionRawViewToYamlConverter)

Method Summary

Modifier and Type	Method and Description
boolean	checkPermissions(String repository, String basePath, long permissionType) Uses access manager to authorize this request.
boolean	execute(Context context) This is the actual method to be overridden in descendant classes.
String	getFileName()
OutputStream	getOutputStream()
void	setFileName(String fileName)
void	setOutputStream(OutputStream outputStream)

Methods inherited from class info.magnolia.commands.impl.BaseRepositoryCommand

getJCRNode, getPath, getRepository, getUuid, release, setPath, setRepository, setUuid

Methods inherited from class info.magnolia.commands.MgnlCommand

clone, execute, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

EXPORT_OUTPUT_STREAM

public static final String EXPORT_OUTPUT_STREAM

See Also:

Constant Field Values

Constructor Detail

ExportJcrNodeToYamlCommand

@Inject
public ExportJcrNodeToYamlCommand(RegistryFacade registryFacade,
                                          DefinitionRawViewToYamlConverter definitionRawViewToYamlConverter)

Method Detail

execute

public boolean execute(Context context)
                throws Exception

Description copied from class: MgnlCommand

This is the actual method to be overridden in descendant classes.

Specified by:

execute in class MgnlCommand

Throws:

Exception

checkPermissions

public boolean checkPermissions(String repository,
                                String basePath,
                                long permissionType)

Uses access manager to authorize this request.

Returns:

true if read access is granted

getOutputStream

public OutputStream getOutputStream()

Returns:

the outputStream

setOutputStream

public void setOutputStream(OutputStream outputStream)

Parameters:

outputStream - the outputStream to set

getFileName

public String getFileName()

Returns:

the fileName

setFileName

public void setFileName(String fileName)

Parameters:

fileName - the fileName to set