Class ContentDisposition

java.lang.Object
de.xima.fc.http.ContentDisposition
public final class ContentDisposition extends Object
Class for working with the Content-Disposition. Handles Unicode filenames properly, such as e.g. 
Content-Disposition:
attachment; filename*=UTF-8''foo%E9%A3%9F%E3%81%B9%E3%81%BE%E3%81%97%E3%81%9Fbar.bin; filename="foo___bar.bin"
Since:
8.0.0
Author:
XIMA MEDIA GmbH

  • Field Details

  • Method Details

    • getCharset

      public Charset getCharset()
      Gets the charset defined in filename* parameter, if present, or null if not defined.
      Returns:
      The charset defined in filename* parameter.

    • getFileName

      public String getFileName()
      Gets the filename, either from the filename or filename* directive, if present, or the empty string otherwise.
      Returns:
      The file name.
      See Also:

    • getName

      public String getName()
      Gets the name of the HTML field in the form that the content of this sub part refers to, if present, of the empty string otherwise.
      Returns:
      The name of the HTML field.

    • getType

      public String getType()
      Gets the content disposition type, usually either attachment or inline.
      Returns:
      The content disposition type.

    • builder

      public static ContentDisposition.Builder builder(String type)
      Creates a new builder for a content disposition with the given type.
      Parameters:
      type - The type of the content disposition, usually either attachment or inline.
      Returns:
      The new builder.

    • formatHeaderValue

      public static String formatHeaderValue(ContentDisposition disposition)
      Creates an HTTP header value for the given content disposition. Can be used e.g. for a Content-Disposition header.
      Parameters:
      disposition - The content disposition
      Returns:
      The HTTP header value

    • parseHeaderValue

      public static ContentDisposition parseHeaderValue(String contentDispositionHeader) throws ContentDispositionParseException
      Parses a Content-Disposition header value, such as 
      Content-Disposition:
attachment; filename*=UTF-8''foo%E9%A3%9F%E3%81%B9%E3%81%BE%E3%81%97%E3%81%9Fbar.bin; filename="foo___bar.bin"
      Parameters:
      contentDispositionHeader - Header to parse.
      Returns:
      The parsed header.
      Throws:
      ContentDispositionParseException - When the header value is invalid.