com.dynatrace.openkit.core.communication

Class BeaconSendingContext

java.lang.Object

com.dynatrace.openkit.core.communication.BeaconSendingContext

public class BeaconSendingContext
extends java.lang.Object

State context for beacon sending states.

Constructor Summary

Constructors

Constructor and Description
BeaconSendingContext(Logger logger, Configuration configuration, HTTPClientProvider httpClientProvider, TimingProvider timingProvider) Constructor.
BeaconSendingContext(Logger logger, Configuration configuration, HTTPClientProvider httpClientProvider, TimingProvider timingProvider, com.dynatrace.openkit.core.communication.AbstractBeaconSendingState initialState) Constructor.

Method Summary

Modifier and Type	Method and Description
void	executeCurrentState() Executes the current state.
void	finishSession(SessionImpl session) Finish a session which has been started previously using startSession(SessionImpl).
boolean	isInitialized() Get a boolean indicating whether OpenKit is initialized or not.
boolean	isInTerminalState() Gets a boolean indicating whether the current state is a terminal state or not.
boolean	isShutdownRequested() Gets a boolean flag indicating whether shutdown was requested before or not.
void	requestShutdown() Requests a shutdown.
void	startSession(SessionImpl session) Start a new session.
boolean	waitForInit() Wait until OpenKit has been fully initialized.
boolean	waitForInit(long timeoutMillis) Wait until OpenKit has been fully initialized or timeout expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeaconSendingContext

public BeaconSendingContext(Logger logger,
                            Configuration configuration,
                            HTTPClientProvider httpClientProvider,
                            TimingProvider timingProvider)

Constructor.

The state is initialized to BeaconSendingInitState,

BeaconSendingContext

public BeaconSendingContext(Logger logger,
                            Configuration configuration,
                            HTTPClientProvider httpClientProvider,
                            TimingProvider timingProvider,
                            com.dynatrace.openkit.core.communication.AbstractBeaconSendingState initialState)

Constructor.

The initial state is provided. This constructor is intended for unit testing.

Method Detail

executeCurrentState

public void executeCurrentState()

Executes the current state.

requestShutdown

public void requestShutdown()

Requests a shutdown.

isShutdownRequested

public boolean isShutdownRequested()

Gets a boolean flag indicating whether shutdown was requested before or not.

waitForInit

public boolean waitForInit()

Wait until OpenKit has been fully initialized.

If initialization is interrupted (e.g. requestShutdown() was called), then this method also returns.

Returns:

true OpenKit is fully initialized, false OpenKit init got interrupted.

waitForInit

public boolean waitForInit(long timeoutMillis)

Wait until OpenKit has been fully initialized or timeout expired.

If initialization is interrupted (e.g. requestShutdown() was called), then this method also returns.

Parameters:

timeoutMillis - The maximum number of milliseconds to wait for initialization being completed.

Returns:

true if OpenKit is fully initialized, false if OpenKit init got interrupted or time to wait expired.

isInitialized

public boolean isInitialized()

Get a boolean indicating whether OpenKit is initialized or not.

Returns:

true if OpenKit is initialized, false otherwise.

isInTerminalState

public boolean isInTerminalState()

Gets a boolean indicating whether the current state is a terminal state or not.

Returns:

true if the current state is a terminal state, false otherwise.

startSession

public void startSession(SessionImpl session)

Start a new session.

This add the session to the internal container of sessions.

Parameters:

session - The new session to start.

finishSession

public void finishSession(SessionImpl session)

Finish a session which has been started previously using startSession(SessionImpl).

Parameters:

session - The session to finish.