Package com.pushtechnology.diffusion.api.config

Interface HTTPServiceConfig

All Superinterfaces:
Config
public interface HTTPServiceConfig extends Config
Web Server HTTP Service Config.

Any number of HTTP services can be defined for a Web Server configuration.

Most values can not be changed after the server has been started.

Since:
4.4

  • Method Details

    • getName

      String getName()
      Gets the service name.
      Returns:
      service name

    • getClassName

      String getClassName()
      Gets the service class.
      Returns:
      service class name

    • getUrlPattern

      String getUrlPattern()
      Gets the URL pattern.
      Returns:
      URL pattern.

    • setLog

      @Deprecated void setLog(String log) throws ConfigException
      Deprecated.
      since 6.8
      This method no longer does anything and will be removed in a future release.
      Throws:
      ConfigException

    • getLog

      @Deprecated String getLog()
      Deprecated.
      since 6.8
      This method no longer does anything and will be removed in a future release.
      Returns:
      always null

    • setMaximumInboundRequestSize

      void setMaximumInboundRequestSize(int maxSize) throws ConfigException
      Sets maximum inbound request size.
      Parameters:
      maxSize - the maximum number of bytes that the HTTP request may have. A value of 0 (the default) indicates that the maximum message size should be used.
      Throws:
      ConfigException - if unable to set property

    • getMaximumInboundRequestSize

      int getMaximumInboundRequestSize()
      Gets the maximum inbound request size.
      Returns:
      maximum inbound request size.

    • setDebug

      void setDebug(boolean debug)
      Sets debug option.

      By default this is false.

      This value can be set when the server is running.

      Parameters:
      debug - true to set.

    • isDebug

      boolean isDebug()
      Is debug set?
      Returns:
      true if debug set

    • getProperties

      List<PropertyConfig> getProperties()
      Gets list of Service properties.

      Returns:
      list of service properties (may be empty)

    • getProperty

      PropertyConfig getProperty(String name)
      Get a named property.
      Parameters:
      name - property name
      Returns:
      property config or null if not defined

    • addProperty

      PropertyConfig addProperty(String name, String value) throws ConfigException
      Add a service property.
      Parameters:
      name - the property name
      value - the property value
      Returns:
      the property configuration
      Throws:
      ConfigException - if unable to add property

    • addProperty

      PropertyConfig addProperty(String name, String type, String value) throws ConfigException
      Add a service property.
      Parameters:
      name - the property name
      type - the property type
      value - the property value
      Returns:
      the property configuration
      Throws:
      ConfigException - if unable to add property