fish.payara.nucleus.requesttracing.store

Interface RequestTraceStoreInterface

All Known Implementing Classes:

ClusteredRequestTraceStore, LocalRequestTraceStore

public interface RequestTraceStoreInterface

An interface for a store of RequestTrace objects.

Method Summary

Modifier and Type	Method and Description
RequestTrace	addTrace(RequestTrace trace) Adds a request trace to the store.
RequestTrace	addTrace(RequestTrace trace, RequestTrace traceToRemove) Adds a request trace to the store, removing the specified trace if present and necessary.
Collection<RequestTrace>	emptyStore() Removes all of the traces from the store.
int	getStoreSize() Gets the size of the store.
Collection<RequestTrace>	getTraces() Gets the entire contents of the store.
Collection<RequestTrace>	getTraces(int limit) Gets the contents of the store, up to a limit number of items.
void	setSize(int size) Sets the maximum size of the store.

Method Detail

addTrace

RequestTrace addTrace(RequestTrace trace)

Adds a request trace to the store.

Parameters:

trace - the trace to add.

Returns:

The trace that was removed, or null if no trace was removed

addTrace

RequestTrace addTrace(RequestTrace trace,
                      RequestTrace traceToRemove)

Adds a request trace to the store, removing the specified trace if present and necessary.

Parameters:

trace - The trace to add

traceToRemove - The trace to remove if present

Returns:

The trace that was removed, or null if no trace was removed

getTraces

Collection<RequestTrace> getTraces()

Gets the entire contents of the store.

Returns:

every request trace in the store.

getTraces

Collection<RequestTrace> getTraces(int limit)

Gets the contents of the store, up to a limit number of items.

Parameters:

limit - the maximum number of traces to return.

Returns:

up to the limit number of items from the store.

setSize

void setSize(int size)

Sets the maximum size of the store. Any traces added after this size will cause another to be removed. The trace removed depends on the store implementation.

Parameters:

size - the maximum size of the store.

getStoreSize

int getStoreSize()

Gets the size of the store.

Returns:

the size of the store.

emptyStore

Collection<RequestTrace> emptyStore()

Removes all of the traces from the store. The store will be empty after this method is called.

Returns:

The traces that were stored