Interface InputPart

All Known Implementing Classes:
MultipartInputImpl.PartImpl
public interface InputPart
Represents one part of a multipart message.
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Details

    • DEFAULT_CONTENT_TYPE_PROPERTY

      static final String DEFAULT_CONTENT_TYPE_PROPERTY
      If no content-type header is sent in a multipart message part "text/plain; charset=ISO-8859-1" is assumed.

      This can be overwritten by setting a different String value in HttpRequest.setAttribute(String, Object) with this ("resteasy.provider.multipart.inputpart.defaultContentType") String as key. It should be done in a ContainerRequestFilter.

      See Also:

    • DEFAULT_CHARSET_PROPERTY

      static final String DEFAULT_CHARSET_PROPERTY
      If there is a content-type header without a charset parameter, charset=US-ASCII is assumed.

      This can be overwritten by setting a different String value in HttpRequest.setAttribute(String, Object) with this ("resteasy.provider.multipart.inputpart.defaultCharset") String as key. It should be done in a ContainerRequestFilter.

      See Also:

  • Method Details

    • getHeaders

      jakarta.ws.rs.core.MultivaluedMap<String,String> getHeaders()
      Returns:
      headers of this part

    • getBodyAsString

      String getBodyAsString() throws IOException
      Throws:
      IOException

    • getBody

      <T> T getBody(Class<T> type, Type genericType) throws IOException
      Throws:
      IOException

    • getBody

      <T> T getBody(jakarta.ws.rs.core.GenericType<T> type) throws IOException
      Throws:
      IOException

    • getBody

      default InputStream getBody() throws IOException
      Returns the body content as an input stream.
      Returns:
      the body content
      Throws:
      IOException - if an error occurs reading the content

    • getFileName

      default String getFileName()
      Returns the filename parameter of the content disposition of this Entity.
      Returns:
      the filename or null if one does not exist

    • getMediaType

      jakarta.ws.rs.core.MediaType getMediaType()
      Returns:
      "Content-Type" of this part

    • isContentTypeFromMessage

      boolean isContentTypeFromMessage()
      Returns:
      true if the Content-Type was resolved from the message, false if it was resolved from the server default

    • setMediaType

      void setMediaType(jakarta.ws.rs.core.MediaType mediaType)
      Change the media type of the body part before you extract it. Useful for specifying a charset.
      Parameters:
      mediaType - media type