パッケージ org.wcardinal.configuration

インタフェース WCardinalConfiguration

既知の実装クラスのリスト:
WCardinalConfigurationSupport
public interface WCardinalConfiguration
Provides methods for configuring Winter Cardinal.

  • メソッドの詳細

    • getMaximumBinaryMessageSize

      int getMaximumBinaryMessageSize()
      Returns the maximum size of binary messages in bytes. The default value is 500000. The default value can be changed by setting a property `wcardinal.message.binary.size.max` in properties files, command-line arguments, etc.
      戻り値:
      the maximum size of binary messages in bytes.
      関連項目:

    • setMaximumBinaryMessageSize

      WCardinalConfiguration setMaximumBinaryMessageSize(int limit)
      Sets the maximum size of binary messages.
      パラメータ:
      limit - the maximum size of binary messages in bytes
      戻り値:
      this
      関連項目:

    • getMaximumTextMessageSize

      int getMaximumTextMessageSize()
      Returns the maximum size of text messages. The default value is 62500. The default value can be changed by setting a property `wcardinal.message.text.size.max` in properties files, command-line arguments, etc.
      戻り値:
      the maximum size of text messages
      関連項目:

    • setMaximumTextMessageSize

      WCardinalConfiguration setMaximumTextMessageSize(int limit)
      Sets the maximum size of text messages.
      パラメータ:
      limit - the maximum size of text messages in bytes
      戻り値:
      this
      関連項目:

    • getMaximumIdleTime

      long getMaximumIdleTime()
      Returns the maximum idle time in milliseconds. The default value is 30000. The default value can be changed by setting a property `wcardinal.idle.max` in properties files, command-line arguments, etc.
      戻り値:
      the maximum idle time in milliseconds
      関連項目:

    • setMaximumIdleTime

      WCardinalConfiguration setMaximumIdleTime(long idleTime)
      Sets the maximum idle time in milliseconds. A browser who have not sent any messages for this time span is considered inactive and disconnected.
      パラメータ:
      idleTime - the maximum idle time in milliseconds
      戻り値:
      this
      関連項目:

    • getMaximumDisconnectionTime

      long getMaximumDisconnectionTime()
      Returns the maximum disconnection time in milliseconds. If it is negative, the maximum disconnection time is not checked. The default value is -1. The default value can be changed by setting a property `wcardinal.disconnection.max` in properties files, command-line arguments, etc.
      戻り値:
      the maximum disconnection time in milliseconds
      関連項目:

    • setMaximumDisconnectionTime

      WCardinalConfiguration setMaximumDisconnectionTime(long disconnectionTime)
      Sets the maximum disconnection time in milliseconds. A browser who have been disconnected for this time span is considered inactive.
      パラメータ:
      disconnectionTime - the maximum disconnection time in milliseconds
      戻り値:
      this
      関連項目:

    • getWebSocketPath

      String getWebSocketPath()
      Returns the URL of the WebSocket endpoint. The default value is "**\/wcardinal-websocket". The default value can be changed by setting a property `wcardinal.websocket.path` in properties files, command-line arguments, etc.
      戻り値:
      the URL of the WebSocket endpoint
      関連項目:

    • setWebSocketPath

      WCardinalConfiguration setWebSocketPath(String path)
      Sets the URL of the WebSocket endpoint.
      パラメータ:
      path - the URL of the WebSocket endpoint
      戻り値:
      this
      関連項目:

    • getAllowedOrigins

      String[] getAllowedOrigins()
      Returns the allowed origins. The default value is an empty string array. The default value can be changed by setting a property `wcardinal.allowed-origins` in properties files, command-line arguments, etc.
      戻り値:
      the allowed origins
      関連項目:

    • setAllowedOrigins

      WCardinalConfiguration setAllowedOrigins(String... origins)
      Sets the allowed origins.
      パラメータ:
      origins - allowed origin
      戻り値:
      this
      関連項目:

    • isControllerHttpEnabled

      boolean isControllerHttpEnabled()
      Returns true if HTTP requests of controllers area allowed. The default value is true. The default value can be changed by setting a property `wcardinal.controller.http` in properties files, command-line arguments, etc.
      戻り値:
      true if HTTP requests of controllers area allowed
      関連項目:

    • setControllerHttpEnabled

      WCardinalConfiguration setControllerHttpEnabled(boolean enabled)
      Sets whether HTTP requests of controllers are allowed.
      パラメータ:
      enabled - true to allow, false to disallow the controller requests
      戻り値:
      this
      関連項目:

    • isControllerVariableEmbeddable

      boolean isControllerVariableEmbeddable()
      Returns true if controller variables are embeddable. The default value is true. The default value can be changed by setting a property `wcardinal.controller.variable.embedding` in properties files, command-line arguments, etc.
      戻り値:
      true if controller variables are embeddable
      関連項目:

    • setControllerVariableEmbeddable

      WCardinalConfiguration setControllerVariableEmbeddable(boolean embeddable)
      Sets whether controller variables are embeddable.
      パラメータ:
      embeddable - true to make controller variables embeddable
      戻り値:
      this
      関連項目:

    • setEmbeddedControllerVariableEncoding

      WCardinalConfiguration setEmbeddedControllerVariableEncoding(ControllerVariableEncoding encoding)
      Sets to the specified encoding of embedded controller variables. The default value is "REPLACE". The default value can be changed by setting a property `wcardinal.controller.variable.embedding.encoding` in properties files, command-line arguments, etc.
      パラメータ:
      encoding - encoding
      戻り値:
      this
      関連項目:

    • getEmbeddedControllerVariableEncoding

      ControllerVariableEncoding getEmbeddedControllerVariableEncoding()
      Returns the encoding of embedded controller variables.
      戻り値:
      the encoding of embedded controller variables
      関連項目:

    • getPollingPath

      String getPollingPath()
      Returns the URL of the polling endpoint. The default value is "**\/wcardinal-polling". The default value can be changed by setting a property `wcardinal.polling.path` in properties files, command-line arguments, etc.
      戻り値:
      the URL of the polling endpoint
      関連項目:

    • setPollingPath

      WCardinalConfiguration setPollingPath(String path)
      Sets the URL of the polling endpoint.
      パラメータ:
      path - the URL of the polling endpoint
      戻り値:
      this
      関連項目:

    • getPollingTimeout

      int getPollingTimeout()
      Returns the polling timeout in seconds. The default value is 10000. The default value can be changed by setting a property `wcardinal.polling.timeout` in properties files, command-line arguments, etc.
      戻り値:
      the polling timeout in seconds
      関連項目:

    • setPollingTimeout

      WCardinalConfiguration setPollingTimeout(int timeout)
      Sets the the polling timeout in seconds.
      パラメータ:
      timeout - the polling timeout in seconds
      戻り値:
      this
      関連項目:

    • getThreadPoolSize

      int getThreadPoolSize()
      Returns the default thread pool size. The default value is 30. The default value can be changed by setting a property `wcardinal.thread.pool.size` in properties files, command-line arguments, etc.
      戻り値:
      the default thread pool size
      関連項目:

    • setThreadPoolSize

      WCardinalConfiguration setThreadPoolSize(int poolSize)
      Sets the default thread pool size.
      パラメータ:
      poolSize - the default thread pool size
      戻り値:
      this
      関連項目:

    • getMessagePoolSize

      int getMessagePoolSize()
      Returns the message pool size. The default value is 30. The default value can be changed by setting a property `wcardinal.message.pool.size` in properties files, command-line arguments, etc.
      戻り値:
      the message pool size
      関連項目:

    • setMessagePoolSize

      WCardinalConfiguration setMessagePoolSize(int poolSize)
      Sets the message pool size.
      パラメータ:
      poolSize - the message pool size
      戻り値:
      this
      関連項目:

    • isPartialMessageEnabled

      boolean isPartialMessageEnabled()
      Returns true if partial messages are enabled. The default value is true. The default value can be changed by setting a property `wcardinal.message.partial` in properties files, command-line arguments, etc.
      戻り値:
      true if partial messages are enabled
      関連項目:

    • setPartialMessageEnabled

      WCardinalConfiguration setPartialMessageEnabled(boolean enabled)
      Sets whether partial messages are enabled.
      パラメータ:
      enabled - true to enable partial messages
      戻り値:
      itselt
      関連項目:

    • getPartialMessageSize

      int getPartialMessageSize()
      Returns the partial message size. The default value is 10000. The default value can be changed by setting a property `wcardinal.message.partial.size` in properties files, command-line arguments, etc.
      戻り値:
      partial message size
      関連項目:

    • setPartialMessageSize

      WCardinalConfiguration setPartialMessageSize(int size)
      Sets the partial message size.
      パラメータ:
      size - partial message size
      戻り値:
      this
      関連項目:

    • isSharedConnectionEnabled

      boolean isSharedConnectionEnabled()
      Returns true if shared connections are enabled. The default value is false. The default value can be changed by setting a property `wcardinal.io.shared` in properties files, command-line arguments, etc.
      戻り値:
      true if shared connections are enabled
      関連項目:

    • setSharedConnectionEnabled

      WCardinalConfiguration setSharedConnectionEnabled(boolean enabled)
      Sets whether shared connections are enabled.
      パラメータ:
      enabled - true to enable shared connections
      戻り値:
      this
      関連項目:

    • getDefaultProtocols

      String[] getDefaultProtocols()
      Returns the default communication protocols. The default value is "websocket,polling-100". The default value can be changed by setting a property `wcardinal.io.protocol.defaults` in properties files, command-line arguments, etc.
      戻り値:
      default communication protocols
      関連項目:

    • setDefaultProtocols

      WCardinalConfiguration setDefaultProtocols(String... protocols)
      Sets the default communication protocols.
      パラメータ:
      protocols - default communication protocols
      戻り値:
      this
      関連項目:

    • getSyncConnectTimeout

      long getSyncConnectTimeout()
      Returns the connection request timeout of the synchronization process. The default value is 5000. The default value can be changed by setting a property `wcardinal.sync.connect.timeout` in properties files, command-line arguments, etc.
      戻り値:
      the connection request timeout of the synchronization process
      関連項目:

    • setSyncConnectTimeout

      WCardinalConfiguration setSyncConnectTimeout(long timeout)
      Sets the connection request timeout in the synchronization process.
      パラメータ:
      timeout - connection request timeout in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncUpdateTimeout

      long getSyncUpdateTimeout()
      Returns the update request timeout in the synchronization process. The default value is 5000. The default value can be changed by setting a property `wcardinal.sync.update.timeout` in properties files, command-line arguments, etc.
      戻り値:
      the update request timeout in the synchronization process
      関連項目:

    • setSyncUpdateTimeout

      WCardinalConfiguration setSyncUpdateTimeout(long timeout)
      Sets the update request timeout in the synchronization process.
      パラメータ:
      timeout - update request timeout in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncUpdateInterval

      long getSyncUpdateInterval()
      Returns the update request interval in the synchronization process. The default value is 10000. The default value can be changed by setting a property `wcardinal.sync.update.interval` in properties files, command-line arguments, etc.
      戻り値:
      the update request interval in the synchronization process
      関連項目:

    • setSyncUpdateInterval

      WCardinalConfiguration setSyncUpdateInterval(long interval)
      Sets the update request interval in the synchronization process.
      パラメータ:
      interval - update request interval in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncClientConnectTimeout

      long getSyncClientConnectTimeout()
      Returns the client-side connection request timeout of the synchronization process. The default value is 5000. The default value can be changed by setting a property `wcardinal.sync.client.connect.timeout` in properties files, command-line arguments, etc.
      戻り値:
      the client-side connection request timeout of the synchronization process
      関連項目:

    • setSyncClientConnectTimeout

      WCardinalConfiguration setSyncClientConnectTimeout(long timeout)
      Sets the client-side connection request timeout in the synchronization process.
      パラメータ:
      timeout - client-side connection request timeout in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncClientUpdateTimeout

      long getSyncClientUpdateTimeout()
      Returns the client-side update request timeout in the synchronization process. The default value is 5000. The default value can be changed by setting a property `wcardinal.sync.client.update.timeout` in properties files, command-line arguments, etc.
      戻り値:
      the client-side update request timeout in the synchronization process
      関連項目:

    • setSyncClientUpdateTimeout

      WCardinalConfiguration setSyncClientUpdateTimeout(long timeout)
      Sets the client-side update request timeout in the synchronization process.
      パラメータ:
      timeout - client-side update request timeout in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncClientUpdateInterval

      long getSyncClientUpdateInterval()
      Returns the client-side update request interval in the synchronization process. The default value is 10000. The default value can be changed by setting a property `wcardinal.sync.client.update.interval` in properties files, command-line arguments, etc.
      戻り値:
      the client-side update request interval in the synchronization process
      関連項目:

    • setSyncClientUpdateInterval

      WCardinalConfiguration setSyncClientUpdateInterval(long interval)
      Sets the client-side update request interval in the synchronization process.
      パラメータ:
      interval - client-side update request interval in the synchronization process
      戻り値:
      this
      関連項目:

    • getSyncClientProcessInterval

      long getSyncClientProcessInterval()
      Returns the client-side sync process interval in milliseconds. If the interval is 0 or less, sync messages are processed immediately. The default value is 0. The default value can be changed by setting a property `wcardinal.sync.client.process.interval` in properties files, command-line arguments, etc.
      戻り値:
      the client-side sync process interval in milliseconds.
      関連項目:

    • setSyncClientProcessInterval

      WCardinalConfiguration setSyncClientProcessInterval(long interval)
      Sets the client-side sync process interval in milliseconds.
      パラメータ:
      interval - the client-side sync process interval in milliseconds.
      戻り値:
      this
      関連項目:

    • getMaximumTriggerQueueSize

      int getMaximumTriggerQueueSize()
      Returns the maximum number of queued trigger requests per controllers. This is to avoid consuming large memory. If it is 0 or less, imposes no restrictions. The default value is 100. The default value can be changed by setting a property `wcardinal.trigger.queue.size.max` in properties files, command-line arguments, etc.
      戻り値:
      the maximum number of queued trigger messages.
      関連項目:

    • setMaximumTriggerQueueSize

      WCardinalConfiguration setMaximumTriggerQueueSize(int size)
      Sets the maximum number of queued trigger requests.
      パラメータ:
      size - maximum number of queued trigger requests.
      戻り値:
      this
      関連項目: