Package de.valtech.aecu.core.jmx

Interface AecuServiceMBean

All Known Implementing Classes:

AecuServiceMBeanImpl

@Description("AEM Easy Content Upgrade")
@ProviderType
public interface AecuServiceMBean

JMX service interface.

Author:

Roland Gruber

Method Summary

Modifier and Type	Method	Description
String	execute(String path)	Executes the script(s) at the given position.
String	execute(String path, String data)	Returns history entries.
String	executeWithHistory(String path)	Executes the script(s) at the given position and taking install hook history into account.
List<String>	getFiles(String path)	Returns a list of files that can be executed in the given path.
String	getHistory(int start, int count)	Returns history entries.
String	getVersion()	Returns the AECU version.

Method Detail

getVersion

@Description("Version")
String getVersion()

Returns the AECU version.

Returns:

version

getFiles

@Description("Returns a list of files that can be executed in the given path")
List<String> getFiles(@Name("Path") @Description("File or folder")
                      String path)
               throws de.valtech.aecu.api.service.AecuException

Returns a list of files that can be executed in the given path.

Parameters:

path - file or folder

Returns:

list of files that are executable

Throws:

de.valtech.aecu.api.service.AecuException - error finding files (e.g. invalid path)

execute

@Description("Executes a single file or all files of a folder structure")
String execute(@Name("Path") @Description("Path to file/folder that should be executed")
               String path)
        throws de.valtech.aecu.api.service.AecuException

Executes the script(s) at the given position.

Parameters:

path - path of script/folder

Returns:

execution result

Throws:

de.valtech.aecu.api.service.AecuException - error during execution

executeWithHistory

@Description("Executes a single file or all files of a folder structure. Additionally, the install hook history will be checked if scripts need to be run. History will also be updated for executed scripts.")
String executeWithHistory(@Name("Path") @Description("Path to file/folder that should be executed")
                          String path)
                   throws de.valtech.aecu.api.service.AecuException

Executes the script(s) at the given position and taking install hook history into account.

Parameters:

path - path of script/folder

Returns:

execution result

Throws:

de.valtech.aecu.api.service.AecuException - error during execution

getHistory

@Description("Returns the last history entries")
String getHistory(@Name("Start index")
                  int start,
                  @Name("Count")
                  int count)
           throws de.valtech.aecu.api.service.AecuException

Returns history entries.

Parameters:

start - start index (0 is last run)

count - number of entries to return

Returns:

history entries

Throws:

de.valtech.aecu.api.service.AecuException - error reading history

execute

@Description("Executes a single file or all files of a folder structure. Additionally you can pass json data for the script context")
String execute(@Name("Path")
               String path,
               @Name("Data")
               String data)
        throws de.valtech.aecu.api.service.AecuException

Returns history entries.

Parameters:

path - path of script/folder

data - json data used in the script context

Returns:

history entries

Throws:

de.valtech.aecu.api.service.AecuException - error reading history