Package com.pushtechnology.diffusion.api.config

Interface RestServiceConfig.RestApiConfig

All Superinterfaces:
Config
Enclosing interface:
RestServiceConfig
public static interface RestServiceConfig.RestApiConfig extends Config
REST API specific configuration.

Each REST API wraps an instance of HTTPServiceConfig, which will be used to serve the REST calls.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaximumInboundRequestSize()
    Gets the maximum inbound request size for associated HTTP service config.
    RestServiceConfig.RestApiType
    getRestApiType()
    Gets type of REST API.
    boolean
    isDebug()
    Gets the debug value, set for associated HTTP service config.
    void
    setDebug(boolean debug)
    Sets debug option for associated HTTP service config.
    void
    setMaximumInboundRequestSize(int maximumInboundRequestSize)
    Sets maximum inbound request size for associated HTTP service config.

    Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

    isLocked

  • Method Details

    • getRestApiType

      RestServiceConfig.RestApiType getRestApiType()
      Gets type of REST API.
      Returns:
      REST API type

    • setDebug

      void setDebug(boolean debug)
      Sets debug option for associated HTTP service config.

      By default, this is false.

      This value can be set when the server is running.

      Parameters:
      debug - true to set.

    • setMaximumInboundRequestSize

      void setMaximumInboundRequestSize(int maximumInboundRequestSize) throws ConfigException
      Sets maximum inbound request size for associated HTTP service config.

      If it is not set then the value is 0 indicating that maximum message size is to be used.

      Parameters:
      maximumInboundRequestSize - the maximum number of bytes that the HTTP request may have.
      Throws:
      ConfigException - if unable to set property

    • isDebug

      boolean isDebug()
      Gets the debug value, set for associated HTTP service config.
      Returns:
      true if debug set

    • getMaximumInboundRequestSize

      int getMaximumInboundRequestSize()
      Gets the maximum inbound request size for associated HTTP service config.
      Returns:
      maximum inbound request size for associated HTTPServiceConfig.