Interface BackendClient<C extends BackendClient<C,S>, S>

Type Parameters:

C - the type of a BackendClient

S - the type of the application service of the parent application of a BackendClient.

All Superinterfaces:

AutoCloseable, Client, Closeable, GroupCloseable, OpennessRequestable, SecurityModeHolder

All Known Implementing Classes:

AbstractBackendClient, AbstractWebClient, WebClient

public interface BackendClient<C extends BackendClient<C,S>, S>
extends Client

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
IApplicationTarget	getApplicationAsTarget()
int	getSessionStackSize()
S	getStoredApplicationService()
void	internalPopCurrentSession()	Pops the current Session of the current BackendClient from the current BackendClient.
void	internalPopCurrentSessionWithResult(Object result)	Pops the current Session of the current BackendClient from the current BackendClient with the given result.
void	internalPushSession(Session<C,S> session)	Pushes the given session to the current BackendClient.
Object	internalPushSessionAndGetResult(Session<C,S> session)	Pushes the given session to the current BackendClient.
void	internalSetNextSession(Session<C,S> session)	Sets the next Session of the current BackendClient.
void	internalSetParentApplication(Application<C,S> parentApplication)	Sets the parent Application of the current BackendClient.

Methods inherited from interface Client

getTargetApplicationUrlName, hasTargetApplicationUrlName, internalSetEndPoint, isBackendClient, isFrontendClient

Methods inherited from interface GroupCloseable

close, createCloseDependencyTo, getStoredCloseController, isClosed, noteClose

Methods inherited from interface OpennessRequestable

isOpen

Methods inherited from interface SecurityModeHolder

getSecurityMode

Method Details

getApplicationAsTarget

IApplicationTarget getApplicationAsTarget()

Returns:

the application of the current BackendClient as target.

getSessionStackSize

int getSessionStackSize()

Returns:

the size of the session stack of the current BackendClient

getStoredApplicationService

S getStoredApplicationService()

Returns:

the application service of the parent application of the current BackendClient.

internalPopCurrentSession

void internalPopCurrentSession()

Pops the current Session of the current BackendClient from the current BackendClient. Closes the current BackendClient if the current Session of the current BackendClient was the last Session of the current BackendClient.

Throws:

InvalidArgumentException - if the current Session of the current BackendClient is not the top Session of the current BackendClient.

internalPopCurrentSessionWithResult

void internalPopCurrentSessionWithResult(Object result)

Pops the current Session of the current BackendClient from the current BackendClient with the given result. Closes the current BackendClient if the current Session of the current BackendClient was the last Session of the current BackendClient.

Parameters:

result -

Throws:

InvalidArgumentException - if the current Session of the current BackendClient is not the top Session of the current BackendClient

internalPushSession

void internalPushSession(Session<C,S> session)

Pushes the given session to the current BackendClient.

Parameters:

session -

Throws:

RuntimeException - if the given session is null

internalPushSessionAndGetResult

Object internalPushSessionAndGetResult(Session<C,S> session)

Pushes the given session to the current BackendClient.

Parameters:

session -

Returns:

the result from the given session

Throws:

RuntimeException - if the given session is null

internalSetNextSession

void internalSetNextSession(Session<C,S> session)

Sets the next Session of the current BackendClient. The current Session of the current BackendClient will be popped from the current BackendClient and the given session will be pushed to the current BackendClient.

Parameters:

session -

Throws:

RuntimeException - if the given session is null

internalSetParentApplication

void internalSetParentApplication(Application<C,S> parentApplication)

Sets the parent Application of the current BackendClient.

Parameters:

parentApplication -

Throws:

RuntimeException - if the given parentApplication is null

RuntimeException - if the current BackendClient has already to a parent Application