Package com.carfey.ops.api.embedded

Class LogManager

java.lang.Object

com.carfey.ops.api.embedded.AbstractAPIManager

com.carfey.ops.api.embedded.LogManager

public class LogManager
extends AbstractAPIManager

Class to search event logs using the Obsidian public embedded API. See AbstractAPIManager for details on how transactions are managed within all requests.

Example:

    LogListing listing = new LogManager().listLogs(null);
    System.out.println("Listing: " + listing);
 

Since:

3.0

See Also:

Embedded API Wiki, REST API Wiki, Carfey Date

Nested Class Summary

Nested classes/interfaces inherited from class com.carfey.ops.api.embedded.AbstractAPIManager

AbstractAPIManager.ActionCallable

Constructor Summary

Constructors

Constructor	Description
LogManager()

Method Summary

Modifier and Type	Method	Description
Log	getLog(long id)	Describe the event log with the supplied ID.
LogListing	listLogs(LogListingParameters parameters)	Searches/lists event logs.

Methods inherited from class com.carfey.ops.api.embedded.AbstractAPIManager

addParameter, runApiTarget, validateRequired, withTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

LogManager

public LogManager()

Method Detail

listLogs

public LogListing listLogs(LogListingParameters parameters)
                    throws ValidationException,
                           java.lang.Exception

Searches/lists event logs.

Parameters:

parameters - options for searching logs (defaulted if null)

Returns:

the LogListing matching the supplied parameter (never null)

Throws:

ValidationException - A validation error which prevents the action from succeeding.

java.lang.Exception - Any other type of unexpected exception.

Since:

3.0

getLog

public Log getLog(long id)
           throws MissingEntityException,
                  java.lang.Exception

Describe the event log with the supplied ID.

Parameters:

id - log entry's unique ID.

Returns:

the Log with the supplied ID.

Throws:

MissingEntityException - If the log with the requested ID does not exist.

java.lang.Exception - Any other type of unexpected exception.

Since:

3.0