Package de.xima.fc.mdl.request

Class ParameterWrapper

java.lang.Object
de.xima.fc.mdl.request.ParameterWrapper
All Implemented Interfaces:
Closeable, Serializable, AutoCloseable
public final class ParameterWrapper extends Object implements Serializable, AutoCloseable, Closeable
Request-Parameter-Wrapper
See Also:

  • Constructor Details

    • ParameterWrapper

      public ParameterWrapper()

  • Method Details

    • registerProzessParameter

      public void registerProzessParameter(String name, String... value)

    • registerRenderParameter

      public void registerRenderParameter(String name, String... value)

    • registerValue

      public void registerValue(String name, String... value)

    • registerValue

      public void registerValue(String name, boolean expandExisting, String... value)

    • registerHeader

      public void registerHeader(String name, String... values)

    • registerUpload

      public void registerUpload(String name, org.apache.commons.fileupload.FileItem upload)

    • registerAttachment

      public void registerAttachment(String name, AttachmentData data)

    • getRenderParam

      @Deprecated public String getRenderParam(String key)
      Deprecated.
      When multiple values exists for a render parameters, this returns all of them separated with a comma. This usually occurs when the render parameter is specified twice (such as via URL and post parameters) -- in that case, it usually has the same value. Use getRenderParameter(String) to get that value. Otherwise, if you expect multiple values, use getRenderParameters(String).
      Parameters:
      key - The key of a render parameter to retrieve. This key may or may not start with the CmnConst.RenderParams.PREFIX.
      Returns:
      All values for the given key, separated with commas. When no value exists for the given key, returns the empty string.

    • getRenderParameter

      public String getRenderParameter(String key)
      Parameters:
      key - The key of a render parameter to retrieve. When the key does not start with CmnConst.RenderParams.PREFIX, that prefix is added to the key.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty string.

    • getRenderParameters

      public List<String> getRenderParameters(String key)
      Parameters:
      key - The key of a render parameter to retrieve. When the key does not start with CmnConst.RenderParams.PREFIX, that prefix is added to the key.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty list.

    • getProzessParam

      @Deprecated public String getProzessParam(String key)
      Deprecated.
      When multiple values exists for a processing parameters, this returns all of them separated with a comma. This usually occurs when the processing parameter is specified twice (as a URL parameter and as an input field) -- in that case, it usually has the same value. Use getProcessParameter(String) to get that value. Otherwise, if you expect multiple values, use getProcessParameters(String).
      Parameters:
      key - The key of a process parameter to retrieve. This key may or may not start with the CmnConst.ProzessParams.PREFIX.
      Returns:
      All values for the given key, separated with commas. When no value exists for the given key, returns the empty string.

    • getProcessParameter

      public String getProcessParameter(String key)
      Parameters:
      key - The key of a process parameter to retrieve. The CmnConst.ProzessParams.PREFIX is added when the key does not have that prefix already.
      Returns:
      The first value for the given key. When no value exists for the given key, returns the empty string.

    • getProcessParameters

      public List<String> getProcessParameters(String key)
      Parameters:
      key - The key of a process parameter to retrieve. The CmnConst.ProzessParams.PREFIX is added when the key does not have that prefix already.
      Returns:
      All values for the given processing parameters key. When no value exists for the given key, returns the empty list.

    • getUploadParameters

      public UploadParameters getUploadParameters()
      Returns:
      All uploaded files from multipart requests.

    • getValueParameters

      public ValueParameters getValueParameters()
      Returns:
      All URL and multipart parameters.

    • getHeaderParameters

      public HeaderParameters getHeaderParameters()
      Returns:
      All header parameters from the request.

    • logTraceDataDump

      public void logTraceDataDump(org.slf4j.Logger logger)

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • cleanup

      @Deprecated public void cleanup()
      Deprecated.
      use close()

    • getDataDump

      @Deprecated public String getDataDump()
      Deprecated.
      user logTraceDataDump(Logger)
      Returns:
      String data-dump

    • registerProzessPrameter

      @Deprecated public void registerProzessPrameter(String name, String... value)
      Deprecated.
      use registerProzessParameter(String, String...)
      Registers an prozess-parameter
      Parameters:
      name - parameter-name
      value - parameter-value

    • registerRenderPrameter

      @Deprecated public void registerRenderPrameter(String name, String... value)
      Deprecated.
      use registerRenderParameter(String, String...)
      Registers an render-parameter
      Parameters:
      name - parameter-name
      value - parameter-value