de.valtech.avs.core.history

Class HistoryService

java.lang.Object

de.valtech.avs.core.history.HistoryService

public class HistoryService
extends Object

Reads and writes history entries.

Author:

Roland Gruber

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ATTR_CLEAN
protected static String	ATTR_OUTPUT
protected static String	ATTR_PATH
protected static String	ATTR_TIME
protected static String	ATTR_USER_ID
static String	HISTORY_BASE Base node for history entries

Constructor Summary

Constructors

Constructor and Description
HistoryService()

Method Summary

Modifier and Type	Method and Description
void	createHistoryEntry(org.apache.sling.api.resource.ResourceResolver resolver, de.valtech.avs.api.service.scanner.ScanResult result) Creates 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.
List<de.valtech.avs.api.history.HistoryEntry>	getHistory(int startIndex, int count, org.apache.sling.api.resource.ResourceResolver resolver) Returns the last history entries.
void	purgeHistory(org.apache.sling.api.resource.ResourceResolver resolver, int daysToKeep) Purges the history by keeping only entries within the set number of days.
void	selfCheck(org.apache.sling.api.resource.ResourceResolver resolver) Self test of 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

ATTR_TIME

protected static final String ATTR_TIME

See Also:

Constant Field Values

ATTR_CLEAN

protected static final String ATTR_CLEAN

See Also:

Constant Field Values

ATTR_OUTPUT

protected static final String ATTR_OUTPUT

See Also:

Constant Field Values

ATTR_PATH

protected static final String ATTR_PATH

See Also:

Constant Field Values

ATTR_USER_ID

protected static final String ATTR_USER_ID

See Also:

Constant Field Values

Constructor Detail

HistoryService

public HistoryService()

Method Detail

createHistoryEntry

public void createHistoryEntry(org.apache.sling.api.resource.ResourceResolver resolver,
                               de.valtech.avs.api.service.scanner.ScanResult result)
                        throws de.valtech.avs.api.service.AvsException

Creates a new history entry.

Parameters:

resolver - resource resolver

result - scan result

Throws:

de.valtech.avs.api.service.AvsException - error setting up entry

getHistory

public List<de.valtech.avs.api.history.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)

createPath

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

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

Parameters:

path - path

resolver - resource resolver

primaryType - primary type

Throws:

de.valtech.avs.api.service.AvsException - 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.avs.api.service.AvsException

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

Parameters:

resolver - resource resolver

Throws:

de.valtech.avs.api.service.AvsException - check failed