Package org.apache.hop.history.local

Class LocalAuditManager

java.lang.Object

org.apache.hop.history.local.LocalAuditManager

All Implemented Interfaces:

IAuditManager

public class LocalAuditManager
extends Object
implements IAuditManager

The local audit manager stores its history in the hop home directory (~/.hop) under the history folder So : $HOME/.hop/history

It will be done using a new metadata. - Event groups are mapped to namespaces -

Constructor Summary

Constructors

Constructor	Description
LocalAuditManager()
LocalAuditManager(String rootFolder)

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 auditing state map for the specified group and type
Map<String,String>	loadMap(String group, String type)	Load the auditing state map for the specified group and 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

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalAuditManager

public LocalAuditManager()

LocalAuditManager

public LocalAuditManager(String rootFolder)

Method Detail

storeEvent

public void storeEvent(AuditEvent event)
                throws HopException

Description copied from interface: IAuditManager

Add an event

Specified by:

storeEvent in interface IAuditManager

Throws:

HopException

findEvents

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

Description copied from interface: IAuditManager

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

Specified by:

findEvents in interface IAuditManager

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

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

Description copied from interface: IAuditManager

Store a list

Specified by:

storeList in interface IAuditManager

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

public AuditList retrieveList(String group,
                              String type)
                       throws HopException

Description copied from interface: IAuditManager

Retrieve a list of items of a certain group and type

Specified by:

retrieveList in interface IAuditManager

Parameters:

group - The group to which the list belongs

type - The type of list you want retrieved

Returns:

The list

Throws:

HopException

storeState

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

Description copied from interface: IAuditManager

Store the state of an object

Specified by:

storeState in interface IAuditManager

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

loadAuditStateMap

public AuditStateMap loadAuditStateMap(String group,
                                       String type)

Load the auditing state map for the specified group and type

Specified by:

loadAuditStateMap in interface IAuditManager

Parameters:

group -

type -

Returns:

The map. An empty one if there are any loading problems. They are simply logged and you start over.

saveAuditStateMap

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

Description copied from interface: IAuditManager

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

Specified by:

saveAuditStateMap in interface IAuditManager

Throws:

HopException

retrieveState

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

Description copied from interface: IAuditManager

Retrieve the state of an object with a particular name

Specified by:

retrieveState in interface IAuditManager

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

loadMap

public Map<String,String> loadMap(String group,
                                        String type)

Load the auditing state map for the specified group and type

Specified by:

loadMap in interface IAuditManager

Parameters:

group -

type -

Returns:

The map. An empty one if there are any loading problems. They are simply logged and you start over.

saveMap

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

Description copied from interface: IAuditManager

Store a Strings Map

Specified by:

saveMap in interface IAuditManager

map - The map to save

Throws:

HopException

clearEvents

public void clearEvents()
                 throws HopException

Description copied from interface: IAuditManager

Clear all events.

Specified by:

clearEvents in interface IAuditManager

Throws:

HopException