Package org.apache.hop.history

Interface IAuditManager

All Known Implementing Classes:

LocalAuditManager

public interface IAuditManager

This interface describes all the things you can do with a history manager

Method Summary

Modifier and Type	Method	Description
void	clearEvents()	Clear all events.
List<AuditEvent>	findEvents(String group, String type, boolean unique)	Find all the events for a certain group and of a given type.
AuditStateMap	loadAuditStateMap(String group, String type)	Load the audit state map of a map of objects
Map<String,String>	loadMap(String group, String type)	Load a map of String values for a given group for a given type
AuditList	retrieveList(String group, String type)	Retrieve a list of items of a certain group and type
AuditState	retrieveState(String group, String type, String name)	Retrieve the state of an object with a particular name
void	saveAuditStateMap(String group, String type, AuditStateMap auditStateMap)	Save the given audit state map for a map of objects.
void	saveMap(String group, String type, Map<String,String> map)	Store a Strings Map
void	storeEvent(AuditEvent event)	Add an event
void	storeList(String group, String type, AuditList auditList)	Store a list
void	storeState(String group, String type, AuditState auditState)	Store the state of an object

Method Detail

storeEvent

void storeEvent(AuditEvent event)
         throws HopException

Add an event

Parameters:

event -

Throws:

HopException

findEvents

List<AuditEvent> findEvents(String group,
                            String type,
                            boolean unique)
                     throws HopException

Find all the events for a certain group and of a given type.

Parameters:

group - The event group

type - The event type

unique - Set to true if you want to have a unique list by name

Returns:

The matching events reverse sorted by event date (last events first).

Throws:

HopException

storeList

void storeList(String group,
               String type,
               AuditList auditList)
        throws HopException

Store a list

Parameters:

group - The group to which the list belongs

type - The type of list you want to store

auditList - The list to be stored

Throws:

HopException

retrieveList

AuditList retrieveList(String group,
                       String type)
                throws HopException

Retrieve a list of items of a certain group and type

Parameters:

group - The group to which the list belongs

type - The type of list you want retrieved

Returns:

The list

Throws:

HopException

storeState

void storeState(String group,
                String type,
                AuditState auditState)
         throws HopException

Store the state of an object

Parameters:

group - the group to which the state belongs (namespace, environment, ...)

type - the type of state (shell, perspective, ...)

auditState - The audit state

Throws:

HopException - In case something goes wrong

retrieveState

AuditState retrieveState(String group,
                         String type,
                         String name)
                  throws HopException

Retrieve the state of an object with a particular name

Parameters:

group - The group (namespace, environment)

type - The type (file, window, perspective,...)

name - filename, shell name, ...

Returns:

The state

Throws:

HopException - in case something goes wrong

loadAuditStateMap

AuditStateMap loadAuditStateMap(String group,
                                String type)
                         throws HopException

Load the audit state map of a map of objects

Parameters:

group -

type -

Returns:

Throws:

HopException

saveAuditStateMap

void saveAuditStateMap(String group,
                       String type,
                       AuditStateMap auditStateMap)
                throws HopException

Save the given audit state map for a map of objects.

Parameters:

group -

type -

auditStateMap -

Throws:

HopException

loadMap

Map<String,String> loadMap(String group,
                                 String type)
                          throws HopException

Load a map of String values for a given group for a given type

Parameters:

group -

type -

Returns:

The map

Throws:

HopException

saveMap

void saveMap(String group,
             String type,
             Map<String,String> map)
      throws HopException

Store a Strings Map

Parameters:

group -

type -

map - The map to save

Throws:

HopException

clearEvents

void clearEvents()
          throws HopException

Clear all events.

Throws:

HopException