Package com.levigo.jadice.web.server.config

Class DefaultServerConfiguration

java.lang.Object

com.levigo.jadice.web.server.config.DefaultServerConfiguration

All Implemented Interfaces:

ServerConfiguration

Direct Known Subclasses:

SpringPropertiesServerConfiguration

public class DefaultServerConfiguration
extends Object
implements ServerConfiguration

A default, "hard-coded" implementation of a class holding a bunch of properties used by the JWT server.

Nested Class Summary

Nested classes/interfaces inherited from interface com.levigo.jadice.web.server.config.ServerConfiguration

ServerConfiguration.NetworkConfiguration, ServerConfiguration.TileCompressionType

Constructor Summary

Constructors

Constructor	Description
DefaultServerConfiguration()

Method Summary

Modifier and Type	Method	Description
ClientConfiguration	getClientConfiguration()
List<DocumentReadMetricsFilter>	getDocumentReadMetricsFilters()
long	getDocumentReadSubTaskTimeout()	Returns the timeout for document read subtasks.
ExportConfiguration	getExportConfiguration()
int	getFlowWorkerMaxQueueSizeActive()	Returns the maximum amount flow requests that can be in the queue of the executor
int	getFlowWorkerPoolCoreSize()
int	getFlowWorkerPoolMaxSize()
int	getGeneralPoolCoreSize()	Returns the core pool size for general tasks which is the minimum number of workers to keep alive (and not allow to time out etc).
int	getGeneralPoolMaxSize()	Returns the maximum pool size for general tasks.
int	getJadiceCoreMaxPoolSize()	Set the maximum size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService
int	getJadiceCorePoolSize()	Get the size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService
MetricNamesConfiguration	getMetricNames()
ServerConfiguration.NetworkConfiguration	getNetworkConfiguration()
List<PageSegmentHandleMetricsFilter>	getPageSegmentHandleMetricsFilters()
com.levigo.jadice.format.pdf.settings.PDFStructureReaderSettings.PDFStructureReadStrategy	getPdfStructureReadStrategy()	Returns the configured Read-Strategy for PDF files.
List<RenderControlsMetricsFilter>	getRenderControlsMetricsFilters()
SaveAnnotationsHandler	getSaveAnnotationHandler(String handlerID)	Use AnnotationService instead
HashMap<String,SaveAnnotationsHandler>	getSaveAnnotationsHandlers()	For internal use only
int	getTextContentBunchSize()
int	getTileCachingHeaderExpiryTime()	Returns the expiry time of tiles in the clients browser-cache in seconds.
ServerConfiguration.TileCompressionType	getTileCompressionType()	Returns the ServerConfiguration.TileCompressionType used by the TileServlet to write the PNG tiles
int	getTileRendererMaxParallelRenderingPerClient()	Returns the amount of how many rendering-threads a single client can utilize
int	getTileRendererMaxPendingRequestsSize()	Returns the maximum amount Tile-requests that can be in the queue of pending requests
int	getTileRendererMaxQueueSizeActive()	Returns the maximum amount Tile-requests that can be in the queue of the executor
int	getTileRendererPoolCoreSize()	Returns the core pool size for tile rendering which is the minimum number of workers to keep alive (and not allow to time out etc).
int	getTileRendererPoolMaxSize()	Returns the maximum pool size for tile rendering.
boolean	isCacheFilterEnabled()	Returns true if the Servlet-Filter that sets caching-headers to static resources is enabled or not (default: true)
boolean	isNoCacheFilterEnabled()	Returns true if the Servlet-Filter that sets caching-headers to static resources is enabled or not (default: true)
boolean	isTileCacheFilterEnabled()	Returns true if the Servlet-Filter that sets caching-headers to Tiles is enabled or not (default: true)
boolean	isTileCachingEnabled()	Returns whether server side tile caching is enabled or not.
boolean	isTileCancellationEnabled()
boolean	isTileSecurityFilterEnabled()	Returns true, when the Tile-Security-Filter is enabled.
boolean	isUseSessionSpecificDocumentKey()
void	setCacheFilterEnabled(boolean cacheFilterEnabled)	Enabled/disables the Servlet-Filter that sets caching-headers to static resources
void	setClientConfiguration(ClientConfiguration clientConfiguration)	replace the default configuration
void	setDocumentReadMetricsFilters(List<DocumentReadMetricsFilter> filters)	Clear the existing list and add all filters passed in
void	setDocumentReadSubTaskTimeout(long documentReadSubTaskTimeout)	Sets the timeout for document read subtasks.
void	setFlowWorkerMaxQueueSizeActive(int flowWorkerMaxQueueSizeActive)	Sets the maximum amount of flow requests that can be in the queue of the executor
void	setFlowWorkerPoolCoreSize(int flowWorkerPoolCoreSize)	Sets the core pool size for jadice flow workers which is the minimum number of workers to keep alive (and not allow to time out etc).
void	setFlowWorkerPoolMaxSize(int flowWorkerPoolMaxSize)	Sets the maximum pool size for flow workers.
void	setGeneralPoolCoreSize(int generalPoolCoreSize)	Sets the core pool size for general tasks which is the minimum number of workers to keep alive (and not allow to time out etc).
void	setGeneralPoolMaxSize(int generalPoolMaxSize)	Sets the maximum pool size for general tasks.
void	setJadiceCoreMaxPoolSize(int jadiceCoreMaxPoolSize)	Set the maximum size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService
void	setJadiceCorePoolSize(int jadiceCorePoolSize)	Set the size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService
void	setMetricNames(MetricNamesConfiguration metricNames)
void	setNoCacheFilterEnabled(boolean noCacheFilterEnabled)	Enabled/disables the Servlet-Filter that sets caching-headers to static resources
void	setPageSegmentHandleMetricsFilters(List<PageSegmentHandleMetricsFilter> pageSegmentHandleMetricsFilters)	Clear the existing list and add all filters passed in
void	setPdfStructureReadStrategy(com.levigo.jadice.format.pdf.settings.PDFStructureReaderSettings.PDFStructureReadStrategy pdfStructureReadStrategy)	Sets the Read-Strategy for PDF files.
void	setRenderControlsMetricsFilters(List<RenderControlsMetricsFilter> filters)	Clear the existing list and add all filters passed in
void	setSaveAnnotationHandlers(HashMap<String,SaveAnnotationsHandler> saveAnnotationsHandlers)	Make your SaveAnnotationsHandler a Spring Component so it will be automatically registered
void	setTextContentBunchSize(int bunchSize)	If using the com.levigo.jadice.web.client.config.ClientConfiguration's setIsTextContentStreaming method, you can set here how many Line objects you want to bundle before sending the bundle within one single message over the JWT connection framework
void	setTileCacheFilterEnabled(boolean tileCacheFilterEnabled)	Enabled/disables the Servlet-Filter that sets caching-headers to Tiles
void	setTileCachingEnabled(boolean tileCachingEnabled)	This enables the server side caching of tiles, so that they do not need to be rendered every time.
void	setTileCachingHeaderExpiryTime(int tileCachingHeaderExpiryTime)	Sets the expiry time of tiles in the clients browser-cache in seconds.
void	setTileCancellationEnabled(boolean tileCancellationEnabled)
void	setTileCompressionType(ServerConfiguration.TileCompressionType tileCompressionType)	Sets the ServerConfiguration.TileCompressionType used by the TileServlet to write the PNG tiles
void	setTileRendererMaxParallelRenderingPerClient(int tileRendererMaxParallelRenderingPerClient)	Sets the number of how many rendering-threads a single client can utilize.
void	setTileRendererMaxPendingRequestsSize(int tileRendererMaxPendingRequestsSize)	Sets the maximum amount Tile-requests that can be in the queue of the pending requests
void	setTileRendererMaxQueueSizeActive(int tileRendererMaxQueueSizeActive)	Sets the maximum amount Tile-requests that can be in the queue of the executor
void	setTileRendererPoolCoreSize(int tileRendererPoolCoreSize)	Sets the core pool size for tile rendering which is the minimum number of workers to keep alive (and not allow to time out etc).
void	setTileRendererPoolMaxSize(int tileRendererPoolMaxSize)	Sets the maximum pool size for tile rendering.
void	setTileSecurityFilterEnabled(boolean tileSecurityFilterEnabled)	Enable or disable the Tile-Security-Filter.
void	setUseSessionSpecificDocumentKey(boolean useSessionSpecificDocumentKey)	The PlainInvocationContext in the TileServlet uses the authentication-info of AuthenticationInfoManager if it is present.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultServerConfiguration

public DefaultServerConfiguration()

Method Details

setMetricNames

public void setMetricNames(MetricNamesConfiguration metricNames)

Specified by:

setMetricNames in interface ServerConfiguration

Parameters:

metricNames - set the MetricNamesConfiguration used to individually rename metrics generated by the jadice web toolkit

getMetricNames

public MetricNamesConfiguration getMetricNames()

Specified by:

getMetricNames in interface ServerConfiguration

Returns:

the MetricNamesConfiguration used to individually rename metrics generated by the jadice web toolkit

isTileCachingEnabled

public boolean isTileCachingEnabled()

Description copied from interface: ServerConfiguration

Returns whether server side tile caching is enabled or not.

Specified by:

isTileCachingEnabled in interface ServerConfiguration

Returns:

true if the server side tile caching is enabled, false if not

setTileCachingEnabled

public void setTileCachingEnabled(boolean tileCachingEnabled)

Description copied from interface: ServerConfiguration

This enables the server side caching of tiles, so that they do not need to be rendered every time. It is highly recommended to enable it.

Specified by:

setTileCachingEnabled in interface ServerConfiguration

Parameters:

tileCachingEnabled - True if tile caching should be enabled, false if not

getTileCompressionType

public ServerConfiguration.TileCompressionType getTileCompressionType()

Description copied from interface: ServerConfiguration

Returns the ServerConfiguration.TileCompressionType used by the TileServlet to write the PNG tiles

Specified by:

getTileCompressionType in interface ServerConfiguration

Returns:

the TileCompressionType

setTileCompressionType

public void setTileCompressionType(ServerConfiguration.TileCompressionType tileCompressionType)

Description copied from interface: ServerConfiguration

Sets the ServerConfiguration.TileCompressionType used by the TileServlet to write the PNG tiles

Specified by:

setTileCompressionType in interface ServerConfiguration

Parameters:

tileCompressionType - the TileCompressionType

getGeneralPoolCoreSize

public int getGeneralPoolCoreSize()

Description copied from interface: ServerConfiguration

Returns the core pool size for general tasks which is the minimum number of workers to keep alive (and not allow to time out etc).

Specified by:

getGeneralPoolCoreSize in interface ServerConfiguration

setGeneralPoolCoreSize

public void setGeneralPoolCoreSize(int generalPoolCoreSize)

Description copied from interface: ServerConfiguration

Sets the core pool size for general tasks which is the minimum number of workers to keep alive (and not allow to time out etc). Must not be less than 0

Specified by:

setGeneralPoolCoreSize in interface ServerConfiguration

Parameters:

generalPoolCoreSize -

getGeneralPoolMaxSize

public int getGeneralPoolMaxSize()

Description copied from interface: ServerConfiguration

Returns the maximum pool size for general tasks.

Specified by:

getGeneralPoolMaxSize in interface ServerConfiguration

setGeneralPoolMaxSize

public void setGeneralPoolMaxSize(int generalPoolMaxSize)

Description copied from interface: ServerConfiguration

Sets the maximum pool size for general tasks. Must be greater than 0

Specified by:

setGeneralPoolMaxSize in interface ServerConfiguration

Parameters:

generalPoolMaxSize -

setJadiceCorePoolSize

public void setJadiceCorePoolSize(int jadiceCorePoolSize)

Description copied from interface: ServerConfiguration

Set the size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService

Specified by:

setJadiceCorePoolSize in interface ServerConfiguration

getJadiceCorePoolSize

public int getJadiceCorePoolSize()

Description copied from interface: ServerConfiguration

Get the size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService

Specified by:

getJadiceCorePoolSize in interface ServerConfiguration

setJadiceCoreMaxPoolSize

public void setJadiceCoreMaxPoolSize(int jadiceCoreMaxPoolSize)

Description copied from interface: ServerConfiguration

Set the maximum size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService

Specified by:

setJadiceCoreMaxPoolSize in interface ServerConfiguration

getJadiceCoreMaxPoolSize

public int getJadiceCoreMaxPoolSize()

Description copied from interface: ServerConfiguration

Set the maximum size of the thread pool, that is used by jadice utils / jadice core in ThreadPoolTaskService

Specified by:

getJadiceCoreMaxPoolSize in interface ServerConfiguration

getTileRendererPoolMaxSize

public int getTileRendererPoolMaxSize()

Description copied from interface: ServerConfiguration

Returns the maximum pool size for tile rendering.

Specified by:

getTileRendererPoolMaxSize in interface ServerConfiguration

setTileRendererPoolMaxSize

public void setTileRendererPoolMaxSize(int tileRendererPoolMaxSize)

Description copied from interface: ServerConfiguration

Sets the maximum pool size for tile rendering. Must be greater than 0

Specified by:

setTileRendererPoolMaxSize in interface ServerConfiguration

Parameters:

tileRendererPoolMaxSize -

getTileRendererPoolCoreSize

public int getTileRendererPoolCoreSize()

Description copied from interface: ServerConfiguration

Returns the core pool size for tile rendering which is the minimum number of workers to keep alive (and not allow to time out etc).

Specified by:

getTileRendererPoolCoreSize in interface ServerConfiguration

setTileRendererPoolCoreSize

public void setTileRendererPoolCoreSize(int tileRendererPoolCoreSize)

Description copied from interface: ServerConfiguration

Sets the core pool size for tile rendering which is the minimum number of workers to keep alive (and not allow to time out etc). Must not be less than 0

Specified by:

setTileRendererPoolCoreSize in interface ServerConfiguration

Parameters:

tileRendererPoolCoreSize -

getTileRendererMaxParallelRenderingPerClient

public int getTileRendererMaxParallelRenderingPerClient()

Description copied from interface: ServerConfiguration

Returns the amount of how many rendering-threads a single client can utilize

Specified by:

getTileRendererMaxParallelRenderingPerClient in interface ServerConfiguration

Returns:

tileRendererMaxParallelRenderingPerClient

setTileRendererMaxParallelRenderingPerClient

public void setTileRendererMaxParallelRenderingPerClient(int tileRendererMaxParallelRenderingPerClient)

Description copied from interface: ServerConfiguration

Sets the number of how many rendering-threads a single client can utilize. By default, the value is determined by ServerConfiguration.getTileRendererPoolMaxSize(). If this value is set to more than 8, tileRendererMaxParallelRenderingPerClient will be the value minus 2, if it is less than 8, tileRendererMaxParallelRenderingPerClient will be the value minus 1. Set 0 if a client can utilize all rendering-threads.

Specified by:

setTileRendererMaxParallelRenderingPerClient in interface ServerConfiguration

Parameters:

tileRendererMaxParallelRenderingPerClient - the amount of how many rendering-threads a single client can utilize

getNetworkConfiguration

public ServerConfiguration.NetworkConfiguration getNetworkConfiguration()

Specified by:

getNetworkConfiguration in interface ServerConfiguration

Returns:

the ServerConfiguration.NetworkConfiguration used to initialize values of the network layer.

setClientConfiguration

public void setClientConfiguration(ClientConfiguration clientConfiguration)

Description copied from interface: ServerConfiguration

replace the default configuration

Specified by:

setClientConfiguration in interface ServerConfiguration

Parameters:

clientConfiguration - the ClientConfiguration used to expose configs for all clients by the server

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Specified by:

getClientConfiguration in interface ServerConfiguration

Returns:

the ClientConfiguration used to expose configs for all clients by the server

getExportConfiguration

public ExportConfiguration getExportConfiguration()

Specified by:

getExportConfiguration in interface ServerConfiguration

toString

public String toString()

Overrides:

toString in class Object

getTileRendererMaxQueueSizeActive

public int getTileRendererMaxQueueSizeActive()

Description copied from interface: ServerConfiguration

Returns the maximum amount Tile-requests that can be in the queue of the executor

Specified by:

getTileRendererMaxQueueSizeActive in interface ServerConfiguration

Returns:

the maximum amount Tile-requests that can be in the queue of the executor

setTileRendererMaxQueueSizeActive

public void setTileRendererMaxQueueSizeActive(int tileRendererMaxQueueSizeActive)

Description copied from interface: ServerConfiguration

Sets the maximum amount Tile-requests that can be in the queue of the executor

Specified by:

setTileRendererMaxQueueSizeActive in interface ServerConfiguration

Parameters:

tileRendererMaxQueueSizeActive - the maximum amount Tile-requests that can be in the queue of the executor

getTileRendererMaxPendingRequestsSize

public int getTileRendererMaxPendingRequestsSize()

Description copied from interface: ServerConfiguration

Returns the maximum amount Tile-requests that can be in the queue of pending requests

Specified by:

getTileRendererMaxPendingRequestsSize in interface ServerConfiguration

Returns:

the maximum amount Tile-requests that can be in the queue of pending requests

setTileRendererMaxPendingRequestsSize

public void setTileRendererMaxPendingRequestsSize(int tileRendererMaxPendingRequestsSize)

Description copied from interface: ServerConfiguration

Sets the maximum amount Tile-requests that can be in the queue of the pending requests

Specified by:

setTileRendererMaxPendingRequestsSize in interface ServerConfiguration

Parameters:

tileRendererMaxPendingRequestsSize - the maximum amount Tile-requests that can be in the queue of pending requests

getTileCachingHeaderExpiryTime

public int getTileCachingHeaderExpiryTime()

Description copied from interface: ServerConfiguration

Returns the expiry time of tiles in the clients browser-cache in seconds. A value of 0 means that the tile will not be cached.

Specified by:

getTileCachingHeaderExpiryTime in interface ServerConfiguration

Returns:

the time a tile will be kept in the clients browser-cache

See Also:

• for server-side tile-caching

setTileCachingHeaderExpiryTime

public void setTileCachingHeaderExpiryTime(int tileCachingHeaderExpiryTime)

Description copied from interface: ServerConfiguration

Sets the expiry time of tiles in the clients browser-cache in seconds. To disable caching on the client browser set this value to 0 (this will also disable the Etag-Header).

Specified by:

setTileCachingHeaderExpiryTime in interface ServerConfiguration

Parameters:

tileCachingHeaderExpiryTime - the time a tile will be kept in the clients browser-cache

See Also:

• for server-side tile-caching

isCacheFilterEnabled

public boolean isCacheFilterEnabled()

Description copied from interface: ServerConfiguration

Returns true if the Servlet-Filter that sets caching-headers to static resources is enabled or not (default: true)

Specified by:

isCacheFilterEnabled in interface ServerConfiguration

Returns:

true if it is enabled, false otherwise

setCacheFilterEnabled

public void setCacheFilterEnabled(boolean cacheFilterEnabled)

Description copied from interface: ServerConfiguration

Enabled/disables the Servlet-Filter that sets caching-headers to static resources

Specified by:

setCacheFilterEnabled in interface ServerConfiguration

Parameters:

cacheFilterEnabled - enable or disable the Servlet-Filter

isNoCacheFilterEnabled

public boolean isNoCacheFilterEnabled()

Description copied from interface: ServerConfiguration

Returns true if the Servlet-Filter that sets caching-headers to static resources is enabled or not (default: true)

Specified by:

isNoCacheFilterEnabled in interface ServerConfiguration

Returns:

true if it is enabled, false otherwise

setNoCacheFilterEnabled

public void setNoCacheFilterEnabled(boolean noCacheFilterEnabled)

Description copied from interface: ServerConfiguration

Enabled/disables the Servlet-Filter that sets caching-headers to static resources

Specified by:

setNoCacheFilterEnabled in interface ServerConfiguration

Parameters:

noCacheFilterEnabled - enable or disable the Servlet-Filter

isTileCacheFilterEnabled

public boolean isTileCacheFilterEnabled()

Description copied from interface: ServerConfiguration

Returns true if the Servlet-Filter that sets caching-headers to Tiles is enabled or not (default: true)

Specified by:

isTileCacheFilterEnabled in interface ServerConfiguration

Returns:

true if it is enabled, false otherwise

setTileCacheFilterEnabled

public void setTileCacheFilterEnabled(boolean tileCacheFilterEnabled)

Description copied from interface: ServerConfiguration

Enabled/disables the Servlet-Filter that sets caching-headers to Tiles

Specified by:

setTileCacheFilterEnabled in interface ServerConfiguration

Parameters:

tileCacheFilterEnabled - enable or disable the Servlet-Filter

getFlowWorkerPoolCoreSize

public int getFlowWorkerPoolCoreSize()

Specified by:

getFlowWorkerPoolCoreSize in interface ServerConfiguration

Returns:

The core pool size for jadice flow workers which is the minimum number of workers to keep alive (and not allow to time out etc).

setFlowWorkerPoolCoreSize

public void setFlowWorkerPoolCoreSize(int flowWorkerPoolCoreSize)

Description copied from interface: ServerConfiguration

Sets the core pool size for jadice flow workers which is the minimum number of workers to keep alive (and not allow to time out etc). Must not be less than 0

Specified by:

setFlowWorkerPoolCoreSize in interface ServerConfiguration

Parameters:

flowWorkerPoolCoreSize -

getFlowWorkerPoolMaxSize

public int getFlowWorkerPoolMaxSize()

Specified by:

getFlowWorkerPoolMaxSize in interface ServerConfiguration

Returns:

the maximum pool size for flow workers.

setFlowWorkerPoolMaxSize

public void setFlowWorkerPoolMaxSize(int flowWorkerPoolMaxSize)

Description copied from interface: ServerConfiguration

Sets the maximum pool size for flow workers.

Specified by:

setFlowWorkerPoolMaxSize in interface ServerConfiguration

Parameters:

flowWorkerPoolMaxSize - Must be greater than 0

getFlowWorkerMaxQueueSizeActive

public int getFlowWorkerMaxQueueSizeActive()

Description copied from interface: ServerConfiguration

Returns the maximum amount flow requests that can be in the queue of the executor

Specified by:

getFlowWorkerMaxQueueSizeActive in interface ServerConfiguration

Returns:

the maximum amount flow requests that can be in the queue of the executor

setFlowWorkerMaxQueueSizeActive

public void setFlowWorkerMaxQueueSizeActive(int flowWorkerMaxQueueSizeActive)

Description copied from interface: ServerConfiguration

Sets the maximum amount of flow requests that can be in the queue of the executor

Specified by:

setFlowWorkerMaxQueueSizeActive in interface ServerConfiguration

Parameters:

flowWorkerMaxQueueSizeActive - the maximum amount flow requests that can be in the queue of the executor

setRenderControlsMetricsFilters

public void setRenderControlsMetricsFilters(List<RenderControlsMetricsFilter> filters)

Description copied from interface: ServerConfiguration

Clear the existing list and add all filters passed in

Specified by:

setRenderControlsMetricsFilters in interface ServerConfiguration

Parameters:

filters - the filters used for exposing finer grained render metrics

getRenderControlsMetricsFilters

public List<RenderControlsMetricsFilter> getRenderControlsMetricsFilters()

Specified by:

getRenderControlsMetricsFilters in interface ServerConfiguration

Returns:

the filters used for exposing finer grained render metrics

setDocumentReadMetricsFilters

public void setDocumentReadMetricsFilters(List<DocumentReadMetricsFilter> filters)

Description copied from interface: ServerConfiguration

Clear the existing list and add all filters passed in

Specified by:

setDocumentReadMetricsFilters in interface ServerConfiguration

Parameters:

filters - the filters used for exposing finer grained document read metrics

getDocumentReadMetricsFilters

public List<DocumentReadMetricsFilter> getDocumentReadMetricsFilters()

Specified by:

getDocumentReadMetricsFilters in interface ServerConfiguration

Returns:

the filters used for exposing finer grained document read metrics

setPageSegmentHandleMetricsFilters

public void setPageSegmentHandleMetricsFilters(List<PageSegmentHandleMetricsFilter> pageSegmentHandleMetricsFilters)

Description copied from interface: ServerConfiguration

Clear the existing list and add all filters passed in

Specified by:

setPageSegmentHandleMetricsFilters in interface ServerConfiguration

Parameters:

pageSegmentHandleMetricsFilters - the filters used for exposing finer grained render metrics, that are PageSegmentHandler based.

getPageSegmentHandleMetricsFilters

public List<PageSegmentHandleMetricsFilter> getPageSegmentHandleMetricsFilters()

Specified by:

getPageSegmentHandleMetricsFilters in interface ServerConfiguration

Returns:

the filters used for exposing finer grained render metrics, that are PageSegmentHandler based.

isUseSessionSpecificDocumentKey

public boolean isUseSessionSpecificDocumentKey()

Specified by:

isUseSessionSpecificDocumentKey in interface ServerConfiguration

Returns:

setUseSessionSpecificDocumentKey

public void setUseSessionSpecificDocumentKey(boolean useSessionSpecificDocumentKey)

Description copied from interface: ServerConfiguration

The PlainInvocationContext in the TileServlet uses the authentication-info of AuthenticationInfoManager if it is present. To receive the authentication-info the client-id is used. The client-id is generated by the client at creation time of the client (application loaded in browser).

If this flag is true, instead of the browser-defined client-id the session-id is used (HttpSession).

Specified by:

setUseSessionSpecificDocumentKey in interface ServerConfiguration

Parameters:

useSessionSpecificDocumentKey - set true, if you want to use the session-id for the client-id while retrieving the authentication-info in the id-generation step of the TileServlet

isTileCancellationEnabled

public boolean isTileCancellationEnabled()

Specified by:

isTileCancellationEnabled in interface ServerConfiguration

setTileCancellationEnabled

public void setTileCancellationEnabled(boolean tileCancellationEnabled)

Specified by:

setTileCancellationEnabled in interface ServerConfiguration

setTextContentBunchSize

public void setTextContentBunchSize(int bunchSize)

Description copied from interface: ServerConfiguration

If using the com.levigo.jadice.web.client.config.ClientConfiguration's setIsTextContentStreaming method, you can set here how many Line objects you want to bundle before sending the bundle within one single message over the JWT connection framework

Specified by:

setTextContentBunchSize in interface ServerConfiguration

Parameters:

bunchSize - how many lines to bundle

getTextContentBunchSize

public int getTextContentBunchSize()

Specified by:

getTextContentBunchSize in interface ServerConfiguration

Returns:

the value set in ServerConfiguration.setTextContentBunchSize(int)

getPdfStructureReadStrategy

public com.levigo.jadice.format.pdf.settings.PDFStructureReaderSettings.PDFStructureReadStrategy getPdfStructureReadStrategy()

Description copied from interface: ServerConfiguration

Returns the configured Read-Strategy for PDF files.

Specified by:

getPdfStructureReadStrategy in interface ServerConfiguration

Returns:

setPdfStructureReadStrategy

public void setPdfStructureReadStrategy(com.levigo.jadice.format.pdf.settings.PDFStructureReaderSettings.PDFStructureReadStrategy pdfStructureReadStrategy)

Description copied from interface: ServerConfiguration

Sets the Read-Strategy for PDF files.

Specified by:

setPdfStructureReadStrategy in interface ServerConfiguration

Parameters:

pdfStructureReadStrategy -

getDocumentReadSubTaskTimeout

public long getDocumentReadSubTaskTimeout()

Description copied from interface: ServerConfiguration

Returns the timeout for document read subtasks.

Specified by:

getDocumentReadSubTaskTimeout in interface ServerConfiguration

Returns:

timeout in milliseconds.

setDocumentReadSubTaskTimeout

public void setDocumentReadSubTaskTimeout(long documentReadSubTaskTimeout)

Description copied from interface: ServerConfiguration

Sets the timeout for document read subtasks.

Specified by:

setDocumentReadSubTaskTimeout in interface ServerConfiguration

Parameters:

documentReadSubTaskTimeout - timeout in milliseconds.

getSaveAnnotationHandler

public SaveAnnotationsHandler getSaveAnnotationHandler(String handlerID)

Description copied from interface: ServerConfiguration

Use AnnotationService instead

Specified by:

getSaveAnnotationHandler in interface ServerConfiguration

setSaveAnnotationHandlers

public void setSaveAnnotationHandlers(HashMap<String,SaveAnnotationsHandler> saveAnnotationsHandlers)

Description copied from interface: ServerConfiguration

Make your SaveAnnotationsHandler a Spring Component so it will be automatically registered

Specified by:

setSaveAnnotationHandlers in interface ServerConfiguration

getSaveAnnotationsHandlers

public HashMap<String,SaveAnnotationsHandler> getSaveAnnotationsHandlers()

Description copied from interface: ServerConfiguration

For internal use only

Specified by:

getSaveAnnotationsHandlers in interface ServerConfiguration

isTileSecurityFilterEnabled

public boolean isTileSecurityFilterEnabled()

Description copied from interface: ServerConfiguration

Returns true, when the Tile-Security-Filter is enabled. Caution: the Filter only works if an HTTP-session is present (e.g. by enabling ConnectionConfiguration.setAlwaysCreateHttpSession(boolean)). The Tile-Security-Filter works by binding a client-id to an HTTP-session-id. With this feature you can not copy a tile-url and open it with a different client (which is generally a good idea).

Specified by:

isTileSecurityFilterEnabled in interface ServerConfiguration

Returns:

true if the filter is enabled

setTileSecurityFilterEnabled

public void setTileSecurityFilterEnabled(boolean tileSecurityFilterEnabled)

Description copied from interface: ServerConfiguration

Enable or disable the Tile-Security-Filter. Caution: the Filter only works if an HTTP-session is present (e.g. by enabling ConnectionConfiguration.setAlwaysCreateHttpSession(boolean)). The Tile-Security-Filter works by binding a client-id to an HTTP-session-id. With this feature you can not copy a tile-url and open it with a different client (which is generally a good idea).

Specified by:

setTileSecurityFilterEnabled in interface ServerConfiguration

Parameters:

tileSecurityFilterEnabled - enable or disable the filter