org.jwebsocket.kit

Class PlugInResponse

java.lang.Object

org.jwebsocket.kit.PlugInResponse

public class PlugInResponse
extends Object

Implements the response class to return results from the plug-in chain to the server. The server can forward data packets to a chain of plug-ins. Each plug-in can either process or ignore the packet. If the packet was successfully processed the plug-in can abort the chain.

Author:

aschulze

Constructor Summary

Constructors

Constructor and Description
PlugInResponse()

Method Summary

Methods

Modifier and Type	Method and Description
void	abortChain() Signals that the plug-in chain has to be be aborted.
void	breakChain() Signals that the plug-in chain has to be be aborted.
void	continueChain() Signals that the plug-in chain has to be be continued.
String	getMessage()
int	getReturnCode()
Boolean	isChainAborted() Returns if the plug-in chain has to be aborted after a plug-in has finished its work.
void	setMessage(String aMessage)
void	setReturnCode(int aReturnCode)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlugInResponse

public PlugInResponse()

Method Detail

isChainAborted

public Boolean isChainAborted()

Returns if the plug-in chain has to be aborted after a plug-in has finished its work.

Returns:

the chainAborted

abortChain

public void abortChain()

Signals that the plug-in chain has to be be aborted. The token has not been processed.

breakChain

public void breakChain()

Signals that the plug-in chain has to be be aborted. The token has been processed.

continueChain

public void continueChain()

Signals that the plug-in chain has to be be continued.

getReturnCode

public int getReturnCode()

Returns:

the mReturnCode

setReturnCode

public void setReturnCode(int aReturnCode)

Parameters:

mReturnCode - the mReturnCode to set

getMessage

public String getMessage()

Returns:

the mMessage

setMessage

public void setMessage(String aMessage)

Parameters:

mMessage - the mMessage to set