ch.ralscha.extdirectspring.controller

Class Configuration

java.lang.Object

ch.ralscha.extdirectspring.controller.Configuration

public class Configuration
extends Object

Configuration class to configure different aspects of extdirectspring.

Author:

Ralph Schaer

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultExceptionMessage()
Object	getEnableBuffer()
Map<Class<?>,String>	getExceptionToMessage()
Integer	getMaxRetries()
String	getMessage(Throwable exception) Returns an error message for the supplied exception and based on this configuration.
Integer	getTimeout()
boolean	isAlwaysWrapStoreResponse()
boolean	isSendExceptionMessage()
boolean	isSendStacktrace()
boolean	isStreamResponse()
boolean	isSynchronizeOnSession()
void	setAlwaysWrapStoreResponse(boolean alwaysWrapStoreResponse) If alwaysWrapStoreResponse is true, responses of STORE_READ and STORE_MODIFY methods are always wrapped in an ExtDirectStoreResponse object.
void	setDefaultExceptionMessage(String defaultExceptionMessage) Changes the default message when an exception occurred and there is no mapping found in getExceptionToMessage() and isSendExceptionMessage() is false.
void	setEnableBuffer(Object enableBuffer) true or false to enable or disable combining of method calls.
void	setExceptionToMessage(Map<Class<?>,String> exceptionToMessage) Sets the new exception-to-message map.
void	setMaxRetries(Integer maxRetries) Sets the number of times the client will try to send a message to the server before throwing a failure.
void	setSendExceptionMessage(boolean sendExceptionMessage) Changes the way BaseResponse.setMessage(String) is called.
void	setSendStacktrace(boolean sendStacktrace) If sendStacktrace is true, the library sends, in case of an exception, the full stacktrace in BaseResponse.setWhere(String) back to the client.
void	setStreamResponse(boolean streamResponse) If streamResponse is true, the JSON response will be directly written into the ServletResponse.getOutputStream() without setting the Content-Length header.
void	setSynchronizeOnSession(boolean synchronizeOnSession) If synchronizeOnSession is true, execution of all methods is synchronized on the session object.
void	setTimeout(Integer timeout) Sets the timeout in milliseconds for remote calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

getDefaultExceptionMessage

public String getDefaultExceptionMessage()

setDefaultExceptionMessage

public void setDefaultExceptionMessage(String defaultExceptionMessage)

Changes the default message when an exception occurred and there is no mapping found in getExceptionToMessage() and isSendExceptionMessage() is false.

Default value is "Server Error".

This value is set into BaseResponse.setMessage(String) and sent to the client.

Parameters:

defaultExceptionMessage - new default exception message

See Also:

setExceptionToMessage(Map), setDefaultExceptionMessage(String)

isSendExceptionMessage

public boolean isSendExceptionMessage()

setSendExceptionMessage

public void setSendExceptionMessage(boolean sendExceptionMessage)

Changes the way BaseResponse.setMessage(String) is called.

If this flag is set to true and an exception occurred instead of getDefaultExceptionMessage() Throwable.getMessage() is put into the message field of the response. Only if there is no mapping found in getExceptionToMessage().

Default value is false.

Parameters:

sendExceptionMessage - new flag

See Also:

setExceptionToMessage(Map), setDefaultExceptionMessage(String)

isSendStacktrace

public boolean isSendStacktrace()

setSendStacktrace

public void setSendStacktrace(boolean sendStacktrace)

If sendStacktrace is true, the library sends, in case of an exception, the full stacktrace in BaseResponse.setWhere(String) back to the client.

Should only set to true in development.

Default value is false

Parameters:

sendStacktrace - new flag

getExceptionToMessage

public Map<Class<?>,String> getExceptionToMessage()

setExceptionToMessage

public void setExceptionToMessage(Map<Class<?>,String> exceptionToMessage)

Sets the new exception-to-message map.

If there is a mapping for the exception in getExceptionToMessage() and the value is not null put this value in BaseResponse.setMessage(String).

If there is a mapping for the exception in getExceptionToMessage() and the value is null use Throwable.getMessage().

If there is no mapping and isSendExceptionMessage() is true use Throwable.getMessage().

If there is no mapping and isSendExceptionMessage() is false use getDefaultExceptionMessage().

Parameters:

exceptionToMessage - new mapping from exception to message

See Also:

setDefaultExceptionMessage(String), setSendExceptionMessage(boolean)

isAlwaysWrapStoreResponse

public boolean isAlwaysWrapStoreResponse()

setAlwaysWrapStoreResponse

public void setAlwaysWrapStoreResponse(boolean alwaysWrapStoreResponse)

If alwaysWrapStoreResponse is true, responses of STORE_READ and STORE_MODIFY methods are always wrapped in an ExtDirectStoreResponse object.

Parameters:

alwaysWrapStoreResponse - new flag

isSynchronizeOnSession

public boolean isSynchronizeOnSession()

setSynchronizeOnSession

public void setSynchronizeOnSession(boolean synchronizeOnSession)

If synchronizeOnSession is true, execution of all methods is synchronized on the session object. To serialize parallel invocations from the same client and to prevent concurrency issues if the server accesses global or session resources.

Instead of globally enable this it's possible to set the flag on a per method basis with ExtDirectMethod.synchronizeOnSession().

Parameters:

synchronizeOnSession - new flag

getTimeout

public Integer getTimeout()

setTimeout

public void setTimeout(Integer timeout)

Sets the timeout in milliseconds for remote calls. This parameter is part of the configuration object api.js sends to the client and configures the timeout property of the RemotingProvider.

Parameters:

timeout - new timeout value

getMaxRetries

public Integer getMaxRetries()

setMaxRetries

public void setMaxRetries(Integer maxRetries)

Sets the number of times the client will try to send a message to the server before throwing a failure. Default value is 1. This parameter is part of the configuration object api.js sends to the client and configures the maxRetries property of the RemotingProvider.

Parameters:

maxRetries - new number of max retries

getEnableBuffer

public Object getEnableBuffer()

setEnableBuffer

public void setEnableBuffer(Object enableBuffer)

true or false to enable or disable combining of method calls. If a number is specified this is the amount of time in milliseconds to wait before sending a batched request. Calls which are received within the specified timeframe will be concatenated together and sent in a single request, optimizing the application by reducing the amount of round trips that have to be made to the server.

This parameter is part of the configuration object api.js sends to the client and configures the enableBuffer property of the RemotingProvider.

Defaults to: 10

Parameters:

enableBuffer - new enableBuffer value

getMessage

public String getMessage(Throwable exception)

Returns an error message for the supplied exception and based on this configuration.

Parameters:

exception - the thrown exception

Returns:

exception message

See Also:

setDefaultExceptionMessage(String), setSendExceptionMessage(boolean), setExceptionToMessage(Map)

isStreamResponse

public boolean isStreamResponse()

setStreamResponse

public void setStreamResponse(boolean streamResponse)

If streamResponse is true, the JSON response will be directly written into the ServletResponse.getOutputStream() without setting the Content-Length header. The old ExtDirectSpring 1.0.x behavior.

If false the RouterController writes the JSON into an internal buffer, sets the Content-Length header in HttpServletResponse and writes the buffer into ServletResponse.getOutputStream().

Instead of globally enable this it's possible to set the flag on a per method basis with ExtDirectMethod.streamResponse().

Default value is false

Parameters:

streamResponse - new flag