com.atlassian.confluence.impl.util.sandbox

Class DefaultSandboxConfiguration.Builder

java.lang.Object

com.atlassian.confluence.impl.util.sandbox.DefaultSandboxConfiguration.Builder

All Implemented Interfaces:

SandboxConfiguration.Builder

Enclosing class:

DefaultSandboxConfiguration

public static class DefaultSandboxConfiguration.Builder
extends Object
implements SandboxConfiguration.Builder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DefaultSandboxConfiguration.Builder	bootstrapClasses(List<Class<?>> bootstrapClasses) Classes required to bootstrap a sandbox process.
DefaultSandboxConfiguration	build() Builds the configuration.
<T> SandboxConfiguration.Builder	callbackContextObject(Class<T> type, T instance) This parameter allows us to specify the object retrievable from SandboxCallbackContext during the execution of SandboxCallback.apply(SandboxCallbackContext, Object).
DefaultSandboxConfiguration.Builder	concurrencyLevel(int concurrencyLevel) Number of sandbox processes.
DefaultSandboxConfiguration.Builder	errorConsumer(SandboxErrorConsumer errorConsumer) The sandbox server and SandboxTask log a debug message by writing it to standard error.
DefaultSandboxConfiguration.Builder	eventConsumer(SandboxEventConsumer eventConsumer) This parameter allows us to specify the method to consume different event of a sandbox process.
SandboxConfiguration.Builder	javaOptions(String... options) Other java options passed to the command that starts a sandbox JVM process.
DefaultSandboxConfiguration.Builder	logLevel(Level logLevel) The loglevel passed to a sandbox server to help debug it.
DefaultSandboxConfiguration.Builder	memoryInMegabytes(int memoryLimitInMegabytes) Limits memory of sandbox process.
DefaultSandboxConfiguration.Builder	requestTimeLimit(Duration timeLimit) Sandbox function call taking longer that this time limit will be terminated.
DefaultSandboxConfiguration.Builder	startupTimeLimit(Duration timeLimit) Sandbox process taking longer that this time limit will be killed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

concurrencyLevel

public DefaultSandboxConfiguration.Builder concurrencyLevel(int concurrencyLevel)

Description copied from interface: SandboxConfiguration.Builder

Number of sandbox processes.

Specified by:

concurrencyLevel in interface SandboxConfiguration.Builder

startupTimeLimit

public DefaultSandboxConfiguration.Builder startupTimeLimit(Duration timeLimit)

Description copied from interface: SandboxConfiguration.Builder

Sandbox process taking longer that this time limit will be killed.

Specified by:

startupTimeLimit in interface SandboxConfiguration.Builder

requestTimeLimit

public DefaultSandboxConfiguration.Builder requestTimeLimit(Duration timeLimit)

Description copied from interface: SandboxConfiguration.Builder

Sandbox function call taking longer that this time limit will be terminated. The sandbox process will be killed and restarted on the next call.

Specified by:

requestTimeLimit in interface SandboxConfiguration.Builder

memoryInMegabytes

public DefaultSandboxConfiguration.Builder memoryInMegabytes(int memoryLimitInMegabytes)

Description copied from interface: SandboxConfiguration.Builder

Limits memory of sandbox process. this is done by passing this value to the option -Xmx of the java command line.

Specified by:

memoryInMegabytes in interface SandboxConfiguration.Builder

bootstrapClasses

public DefaultSandboxConfiguration.Builder bootstrapClasses(List<Class<?>> bootstrapClasses)

Description copied from interface: SandboxConfiguration.Builder

Classes required to bootstrap a sandbox process. Most of classes can be requested from the host but in case they are not they can be specified here.

Specified by:

bootstrapClasses in interface SandboxConfiguration.Builder

errorConsumer

public DefaultSandboxConfiguration.Builder errorConsumer(SandboxErrorConsumer errorConsumer)

Description copied from interface: SandboxConfiguration.Builder

The sandbox server and SandboxTask log a debug message by writing it to standard error. This parameter allows us to specify the method to consume standard error of a sandbox process.

Specified by:

errorConsumer in interface SandboxConfiguration.Builder

eventConsumer

public DefaultSandboxConfiguration.Builder eventConsumer(SandboxEventConsumer eventConsumer)

Description copied from interface: SandboxConfiguration.Builder

This parameter allows us to specify the method to consume different event of a sandbox process.

Specified by:

eventConsumer in interface SandboxConfiguration.Builder

callbackContextObject

public <T> SandboxConfiguration.Builder callbackContextObject(Class<T> type,
                                                              T instance)

Description copied from interface: SandboxConfiguration.Builder

This parameter allows us to specify the object retrievable from SandboxCallbackContext during the execution of SandboxCallback.apply(SandboxCallbackContext, Object).

Specified by:

callbackContextObject in interface SandboxConfiguration.Builder

logLevel

public DefaultSandboxConfiguration.Builder logLevel(Level logLevel)

Description copied from interface: SandboxConfiguration.Builder

The loglevel passed to a sandbox server to help debug it.

Specified by:

logLevel in interface SandboxConfiguration.Builder

javaOptions

public SandboxConfiguration.Builder javaOptions(String... options)

Description copied from interface: SandboxConfiguration.Builder

Other java options passed to the command that starts a sandbox JVM process. Use with extreme care because it may cause fialure in starting a sandbox process.

Specified by:

javaOptions in interface SandboxConfiguration.Builder

build

public DefaultSandboxConfiguration build()

Description copied from interface: SandboxConfiguration.Builder

Builds the configuration.

Specified by:

build in interface SandboxConfiguration.Builder