Package de.valtech.aecu.core.history

Class HistoryUtil

java.lang.Object

de.valtech.aecu.core.history.HistoryUtil

public class HistoryUtil
extends Object

Reads and writes history entries.

Author:

Roland Gruber

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ATTR_END
static String	ATTR_PATH
protected static String	ATTR_RESULT
protected static String	ATTR_RUN_OUTPUT
protected static String	ATTR_RUN_RESULT
protected static String	ATTR_RUN_STATE
protected static String	ATTR_RUN_TIME
protected static String	ATTR_START
protected static String	ATTR_STATE
static String	HISTORY_BASE	Base node for history entries
static String	NODE_FALLBACK

Constructor Summary

Constructors

Constructor	Description
HistoryUtil()

Method Summary

Modifier and Type	Method	Description
de.valtech.aecu.api.service.HistoryEntry	createHistoryEntry(org.apache.sling.api.resource.ResourceResolver resolver)	Starts a new history entry.
protected void	createPath(String path, org.apache.sling.api.resource.ResourceResolver resolver, String primaryType)	Creates the folder at the given path if not yet existing.
void	finishHistoryEntry(de.valtech.aecu.api.service.HistoryEntry history, org.apache.sling.api.resource.ResourceResolver resolver)	Finishes the history entry.
List<de.valtech.aecu.api.service.HistoryEntry>	getHistory(int startIndex, int count, org.apache.sling.api.resource.ResourceResolver resolver)	Returns the last history entries.
org.apache.sling.api.resource.Resource	getHistoryEntryResource(org.apache.sling.api.resource.Resource child)	Returns the base resource for a (fallback) script resource.
void	purgeHistory(org.apache.sling.api.resource.ResourceResolver resolver, int daysToKeep)	Purges the history by keeping only entries within the set number of days.
de.valtech.aecu.api.service.HistoryEntry	readHistoryEntry(org.apache.sling.api.resource.Resource resource)	Reads a history entry from JCR.
de.valtech.aecu.api.service.ExecutionResult	readHistorySingleResult(org.apache.sling.api.resource.Resource resource)	Reads a single script run from history.
void	selfCheck(org.apache.sling.api.resource.ResourceResolver resolver)	Self test of history.
void	storeExecutionInHistory(de.valtech.aecu.api.service.HistoryEntry history, de.valtech.aecu.api.service.ExecutionResult result, org.apache.sling.api.resource.ResourceResolver resolver)	Stores an execution run in existing history.

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_BASE

public static final String HISTORY_BASE

Base node for history entries

See Also:

Constant Field Values

NODE_FALLBACK

public static final String NODE_FALLBACK

See Also:

Constant Field Values

ATTR_PATH

public static final String ATTR_PATH

See Also:

Constant Field Values

ATTR_RUN_OUTPUT

protected static final String ATTR_RUN_OUTPUT

See Also:

Constant Field Values

ATTR_RUN_STATE

protected static final String ATTR_RUN_STATE

See Also:

Constant Field Values

ATTR_RUN_RESULT

protected static final String ATTR_RUN_RESULT

See Also:

Constant Field Values

ATTR_RUN_TIME

protected static final String ATTR_RUN_TIME

See Also:

Constant Field Values

ATTR_RESULT

protected static final String ATTR_RESULT

See Also:

Constant Field Values

ATTR_STATE

protected static final String ATTR_STATE

See Also:

Constant Field Values

ATTR_START

protected static final String ATTR_START

See Also:

Constant Field Values

ATTR_END

protected static final String ATTR_END

See Also:

Constant Field Values

Constructor Detail

HistoryUtil

public HistoryUtil()

Method Detail

createHistoryEntry

public de.valtech.aecu.api.service.HistoryEntry createHistoryEntry(org.apache.sling.api.resource.ResourceResolver resolver)
                                                            throws de.valtech.aecu.api.service.AecuException

Starts a new history entry.

Parameters:

resolver - resource resolver

Returns:

history entry

Throws:

de.valtech.aecu.api.service.AecuException - error setting up entry

storeExecutionInHistory

public void storeExecutionInHistory(de.valtech.aecu.api.service.HistoryEntry history,
                                    de.valtech.aecu.api.service.ExecutionResult result,
                                    org.apache.sling.api.resource.ResourceResolver resolver)
                             throws de.valtech.aecu.api.service.AecuException

Stores an execution run in existing history.

Parameters:

history - history entry

result - script execution result

resolver - resource resolver

Throws:

de.valtech.aecu.api.service.AecuException - error inserting history entry

finishHistoryEntry

public void finishHistoryEntry(de.valtech.aecu.api.service.HistoryEntry history,
                               org.apache.sling.api.resource.ResourceResolver resolver)

Finishes the history entry.

Parameters:

history - open history entry

resolver - resource resolver

getHistory

public List<de.valtech.aecu.api.service.HistoryEntry> getHistory(int startIndex,
                                                                 int count,
                                                                 org.apache.sling.api.resource.ResourceResolver resolver)

Returns the last history entries. The search starts at the newest entry.

Parameters:

startIndex - start reading at this index (first is 0)

count - number of entries to read

resolver - resource resolver

Returns:

history entries (newest first)

getHistoryEntryResource

public org.apache.sling.api.resource.Resource getHistoryEntryResource(org.apache.sling.api.resource.Resource child)

Returns the base resource for a (fallback) script resource.

Parameters:

child - child of base resource

Returns:

base run resource

readHistoryEntry

public de.valtech.aecu.api.service.HistoryEntry readHistoryEntry(org.apache.sling.api.resource.Resource resource)

Reads a history entry from JCR.

Parameters:

resource - history resource

Returns:

history entry

readHistorySingleResult

public de.valtech.aecu.api.service.ExecutionResult readHistorySingleResult(org.apache.sling.api.resource.Resource resource)

Reads a single script run from history.

Parameters:

resource - resource

Returns:

result

createPath

protected void createPath(String path,
                          org.apache.sling.api.resource.ResourceResolver resolver,
                          String primaryType)
                   throws de.valtech.aecu.api.service.AecuException

Creates the folder at the given path if not yet existing.

Parameters:

path - path

resolver - resource resolver

primaryType - primary type

Throws:

de.valtech.aecu.api.service.AecuException - error creating folder

purgeHistory

public void purgeHistory(org.apache.sling.api.resource.ResourceResolver resolver,
                         int daysToKeep)
                  throws org.apache.sling.api.resource.PersistenceException

Purges the history by keeping only entries within the set number of days.

Parameters:

resolver - resource resolver

daysToKeep - number of days to keep

Throws:

org.apache.sling.api.resource.PersistenceException - error deleting node

selfCheck

public void selfCheck(org.apache.sling.api.resource.ResourceResolver resolver)
               throws de.valtech.aecu.api.service.AecuException

Self test of history. Checks if the history node exists.

Parameters:

resolver - resource resolver

Throws:

de.valtech.aecu.api.service.AecuException - check failed