Package com.helger.photon.api

Class APISettings

java.lang.Object

com.helger.photon.api.APISettings

@ThreadSafe
public final class APISettings
extends Object

A central helper class that centrally configures all API callbacks.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_LONG_RUNNING_EXECUTION_LIMIT_MS	Default milliseconds until an implementation is considered long running.

Method Summary

Modifier and Type	Method	Description
static com.helger.commons.callback.CallbackList<IAPIAfterExecutionCallback>	afterExecutionCallbacks()
static com.helger.commons.callback.CallbackList<IAPIBeforeExecutionCallback>	beforeExecutionCallbacks()
static com.helger.commons.callback.CallbackList<IAPIExceptionCallback>	exceptionCallbacks()
static long	getLongRunningExecutionLimitTime()
static com.helger.commons.callback.CallbackList<IAPILongRunningExecutionCallback>	longRunningExecutionCallbacks()
static void	setLongRunningExecutionLimitTime(long nLongRunningExecutionLimitTime)	Set the milliseconds after which an execution is considered long running.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LONG_RUNNING_EXECUTION_LIMIT_MS

public static final long DEFAULT_LONG_RUNNING_EXECUTION_LIMIT_MS

Default milliseconds until an implementation is considered long running.

See Also:

Constant Field Values

Method Detail

exceptionCallbacks

@Nonnull
@ReturnsMutableObject("design")
public static com.helger.commons.callback.CallbackList<IAPIExceptionCallback> exceptionCallbacks()

beforeExecutionCallbacks

@Nonnull
@ReturnsMutableObject("design")
public static com.helger.commons.callback.CallbackList<IAPIBeforeExecutionCallback> beforeExecutionCallbacks()

afterExecutionCallbacks

@Nonnull
@ReturnsMutableObject
public static com.helger.commons.callback.CallbackList<IAPIAfterExecutionCallback> afterExecutionCallbacks()

getLongRunningExecutionLimitTime

@CheckForSigned
public static long getLongRunningExecutionLimitTime()

setLongRunningExecutionLimitTime

public static void setLongRunningExecutionLimitTime(long nLongRunningExecutionLimitTime)

Set the milliseconds after which an execution is considered long running.

Parameters:

nLongRunningExecutionLimitTime - The milliseconds to use. Value ≤ 0 are considered "no limit"

longRunningExecutionCallbacks

@Nonnull
@ReturnsMutableObject
public static com.helger.commons.callback.CallbackList<IAPILongRunningExecutionCallback> longRunningExecutionCallbacks()