Package ch.nolix.system.application.main

Klasse AbstractClient<C extends AbstractClient<C>>

java.lang.Object

ch.nolix.system.application.main.AbstractClient<C>

Typparameter:

C - is the type of a AbstractClient.

Alle implementierten Schnittstellen:

Closeable, CloseStateRequestable, GroupCloseable, AutoCloseable

Bekannte direkte Unterklassen:

AbstractBackendClient, AbstractFrontendClient

public abstract class AbstractClient<C extends AbstractClient<C>>
extends Object
implements GroupCloseable

A AbstractClient is an end point with comfortable functionalities.

Version:

2016-01-01

Autor:

Silvan Wyss

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractClient()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected final C	asConcrete()
final boolean	containsSessionVariableWithKey(String key)
protected final INode<?>	getDataFromCounterpart(IChainedNode request)
protected abstract INode<?>	getDataFromHere(IChainedNode request)
SecurityMode	getSecurityMode()
final String	getSessionVariableValueByKey(String key)
final ICloseController	getStoredCloseController()
final String	getTarget()
final boolean	hasRequestedConnection()
final boolean	hasTarget()
abstract boolean	isBackendClient()
final boolean	isClosed()
protected final boolean	isConnected()
abstract boolean	isFrontendClient()
final boolean	isLocalClient()
final boolean	isNetClient()
final boolean	isWebClient()
protected abstract void	runHere(IChainedNode command)	Lets the current AbstractClient run the given command.
protected final void	runOnCounterpart(ChainedNode command, ChainedNode... commands)	Runs the given commands on the counterpart of the current AbstractClient.
protected final void	runOnCounterpart(IChainedNode command)	Runs the given command on the counterpart of the current AbstractClient.
protected final void	runOnCounterpart(Iterable<? extends IChainedNode> commands)	Runs the given commands on the counterpart of the current AbstractClient.
final void	setSessionVariableWithKeyAndValue(String key, String value)	Sets a session variable with the given key and value to the current AbstractClient.

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden ch.nolix.coreapi.resourcecontrolapi.resourceclosingapi.CloseStateRequestable

isOpen

Von Schnittstelle geerbte Methoden ch.nolix.coreapi.resourcecontrolapi.resourceclosingapi.GroupCloseable

close, createCloseDependencyTo, noteClose

Konstruktordetails

AbstractClient

public AbstractClient()

Methodendetails

containsSessionVariableWithKey

public final boolean containsSessionVariableWithKey(String key)

Parameter:

key -

Gibt zurück:

true if the current AbstractClient contains a session variable with the given key, false otherwise.

getStoredCloseController

public final ICloseController getStoredCloseController()

Angegeben von:

getStoredCloseController in Schnittstelle GroupCloseable

Gibt zurück:

the ICloseController of the current GroupCloseable.

getSecurityMode

public SecurityMode getSecurityMode()

Gibt zurück:

the SecurityMode of the current AbstractClient.

getSessionVariableValueByKey

public final String getSessionVariableValueByKey(String key)

Parameter:

key -

Gibt zurück:

the value of the session variable with the given key from the current AbstractClient.

Löst aus:

ArgumentDoesNotContainElementException - if the current AbstractClient does not contain a session variable with the given key.

getTarget

public final String getTarget()

Gibt zurück:

the name of the target Application of the current AbstractClient.

hasRequestedConnection

public final boolean hasRequestedConnection()

Gibt zurück:

true if the current AbstractClient has requested the connection.

hasTarget

public final boolean hasTarget()

Gibt zurück:

true if the current AbstractClient has a target.

isBackendClient

public abstract boolean isBackendClient()

Gibt zurück:

true if the current AbstractClient is a backend AbstractClient.

isClosed

public final boolean isClosed()

Angegeben von:

isClosed in Schnittstelle CloseStateRequestable

Angegeben von:

isClosed in Schnittstelle GroupCloseable

Gibt zurück:

true if the current CloseStateRequestable is closed.

isFrontendClient

public abstract boolean isFrontendClient()

Gibt zurück:

true if the current AbstractClient is a frontend AbstractClient.

isLocalClient

public final boolean isLocalClient()

Gibt zurück:

true if the current AbstractClient is a local AbstractClient.

isNetClient

public final boolean isNetClient()

Gibt zurück:

true if the current AbstractClient is a net AbstractClient.

isWebClient

public final boolean isWebClient()

Gibt zurück:

true if the current AbstractClient is a web AbstractClient.

Löst aus:

UnconnectedArgumentException - if the current AbstractClient is not connected.

setSessionVariableWithKeyAndValue

public final void setSessionVariableWithKeyAndValue(String key,
 String value)

Sets a session variable with the given key and value to the current AbstractClient. Will overwrite a previous session variable if the current AbstractClient contains already a session variable with the given key.

Parameter:

key -

value -

asConcrete

protected final C asConcrete()

Gibt zurück:

the current AbstractClient as concrete AbstractClient.

getDataFromCounterpart

protected final INode<?> getDataFromCounterpart(IChainedNode request)

Parameter:

request -

Gibt zurück:

the data the given request requests from the counterpart of the current AbstractClient.

Löst aus:

UnconnectedArgumentException - if the current AbstractClient is not connected.

getDataFromHere

protected abstract INode<?> getDataFromHere(IChainedNode request)

Parameter:

request -

Gibt zurück:

the data the given request requests from the current AbstractClient.

isConnected

protected final boolean isConnected()

Gibt zurück:

true if the current AbstractClient is connected.

runHere

protected abstract void runHere(IChainedNode command)

Lets the current AbstractClient run the given command.

Parameter:

command -

runOnCounterpart

protected final void runOnCounterpart(IChainedNode command)

Runs the given command on the counterpart of the current AbstractClient.

Parameter:

command -

Löst aus:

UnconnectedArgumentException - if the current AbstractClient is not connected.

runOnCounterpart

protected final void runOnCounterpart(ChainedNode command,
 ChainedNode... commands)

Runs the given commands on the counterpart of the current AbstractClient.

Parameter:

command -

commands -

Löst aus:

UnconnectedArgumentException - if the current AbstractClient is not connected.

runOnCounterpart

protected final void runOnCounterpart(Iterable<? extends IChainedNode> commands)

Runs the given commands on the counterpart of the current AbstractClient.

Parameter:

commands -

Löst aus:

UnconnectedArgumentException - if the current AbstractClient is not connected.