de.valtech.aecu.core.jmx

Interface AecuServiceMBean

All Known Implementing Classes:

AecuServiceMBeanImpl

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

JMX service interface.

Author:

Roland Gruber

Method Summary

Modifier and Type	Method and Description
String	execute(String path) Executes the script at the given position.
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(value="Version")
String getVersion()

Returns the AECU version.

Returns:

version

getFiles

@Description(value="Returns a list of files that can be executed in the given path")
List<String> getFiles(@Name(value="Path") @Description(value="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(value="Executes a single file or all files of a folder structure")
String execute(@Name(value="Path") @Description(value="Path to file/folder that should be executed")
                                                                                               String path)
                                                                                        throws de.valtech.aecu.api.service.AecuException

Executes the script at the given position.

Parameters:

path - path of script

Returns:

execution result

Throws:

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

getHistory

@Description(value="Returns the last history entries")
String getHistory(@Name(value="Start index")
                                                                         int start,
                                                                         @Name(value="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