Constructor and Description |
---|
StatisticsModule() |
Modifier and Type | Method and Description |
---|---|
void |
addEntry(Entry entry)
Adds an entry to the statistics workspace.
|
String |
getName()
Returns the name of this module.
|
String |
getWorkspaceName() |
Iterator |
runReport(Report report)
Runs a report and returns the result of the report.
|
void |
setWorkspaceName(String wspName) |
void |
start(CRXSession session)
Starts this module and makes it ready for use.
|
void |
stop()
Stops this module.
|
public String getName()
This name is expected to be unique amongst the registered modules and is just used to identify the module. Other than to register the module under this name, the repository does not use it for anything else.
public void start(CRXSession session) throws RepositoryException
This method is called by the repository before registering the module
internally. This means, that while this method is active, this module is
not yet visible by the CRXRepository.getModule(String)
and
CRXRepository.getModules()
method.
If this method fails by throwing a RepositoryException
,
any resources already acquired must be released. A module failing to
start is also not registered and thus visible. Finally a module failing
to start will never be stopped, that is the CRXModule.stop()
method will
not be called.
This method should only throw a RepositoryException
if
failing to start. Notably, the implementation should prevent throwing a
RuntimeException
.
NOTE:
logout()
method on this
session
. Otherwise the repository may behave unexpectedly.
session
is a shared Session. This means, the Session
is not thread safe and may at most be used for concurrent read
operations but MUST NOT be used to write to the repository. If the
module requires writing to the repository, a new Session MUST be
acquired calling the CRXSession.getSession(String)
method on
the session
. Such session SHOULD of course be logged out
when the module is stopped
}.
start
in interface CRXModule
session
- The CRXSession
to access the system workspace of
the repository. This session is shared and MUST NOT be used
to write to the repository. Use the
CRXSession.getSession(String)
method to get a session
to write to the repository.RepositoryException
- May be thrown if the module fails to start.public void stop()
This method is called after the module has been unregistered. If the module failed to start, this method is never called.
This method is not excpected to throw any exception. Care must be taken
to prevent RuntimeExceptions
from occurring.
public Iterator runReport(Report report) throws RepositoryException
report
- the report to run.RepositoryException
- if an error occurs while reading from the
workspace.public void addEntry(Entry entry) throws RepositoryException
entry
- the entry to add.RepositoryException
- if an error occurs while writing to the
workspace.public String getWorkspaceName()
public void setWorkspaceName(String wspName)
wspName
- the name of the statistics workspace.Copyright © 2010 - 2020 Adobe. All Rights Reserved