Class MaximalBodyDescriptor

java.lang.Object
org.apache.james.mime4j.message.MaximalBodyDescriptor
All Implemented Interfaces:
BodyDescriptor, ContentDescriptor
public class MaximalBodyDescriptor extends Object implements BodyDescriptor
Extended BodyDescriptor implementation with complete content details.

  • Field Details

    • CONTENT_TYPE

      private static final String CONTENT_TYPE

    • CONTENT_LENGTH

      private static final String CONTENT_LENGTH

    • CONTENT_TRANSFER_ENCODING

      private static final String CONTENT_TRANSFER_ENCODING

    • CONTENT_DISPOSITION

      private static final String CONTENT_DISPOSITION

    • CONTENT_ID

      private static final String CONTENT_ID

    • CONTENT_MD5

      private static final String CONTENT_MD5

    • CONTENT_DESCRIPTION

      private static final String CONTENT_DESCRIPTION

    • CONTENT_LANGUAGE

      private static final String CONTENT_LANGUAGE

    • CONTENT_LOCATION

      private static final String CONTENT_LOCATION

    • MIME_VERSION

      private static final String MIME_VERSION

    • mediaType

      private final String mediaType

    • subType

      private final String subType

    • mimeType

      private final String mimeType

    • boundary

      private final String boundary

    • charset

      private final String charset

    • fields

      private final Map<String, ParsedField> fields

  • Constructor Details

  • Method Details

    • getMimeType

      public String getMimeType()
      Description copied from interface: ContentDescriptor
      Returns the body descriptors MIME type.
      Specified by:
      getMimeType in interface ContentDescriptor
      Returns:
      The MIME type, which has been parsed from the content-type definition. Must not be null, but "text/plain", if no content-type was specified.
      See Also:

    • getBoundary

      public String getBoundary()
      Description copied from interface: BodyDescriptor
      Returns the body descriptors boundary.
      Specified by:
      getBoundary in interface BodyDescriptor
      Returns:
      Boundary string, if known, or null. The latter may be the case, in particular, if the body is no multipart entity.

    • getCharset

      public String getCharset()
      Description copied from interface: ContentDescriptor

      The body descriptors character set, defaulted appropriately for the MIME type.

      For TEXT types, this will be defaulted to us-ascii. For other types, when the charset parameter is missing this property will be null.

      Specified by:
      getCharset in interface ContentDescriptor
      Returns:
      Character set, which has been parsed from the content-type definition. Not null for TEXT types, when unset will be set to default us-ascii. For other types, when unset, null will be returned.

    • getMediaType

      public String getMediaType()
      Description copied from interface: ContentDescriptor
      Gets the defaulted MIME media type for this content. For example TEXT, IMAGE, MULTIPART
      Specified by:
      getMediaType in interface ContentDescriptor
      Returns:
      the MIME media type when content-type specified, otherwise the correct default (TEXT)
      See Also:

    • getSubType

      public String getSubType()
      Description copied from interface: ContentDescriptor
      Gets the defaulted MIME sub type for this content.
      Specified by:
      getSubType in interface ContentDescriptor
      Returns:
      the MIME media type when content-type is specified, otherwise the correct default (PLAIN)
      See Also:

    • getContentTypeParameters

      public Map<String,String> getContentTypeParameters()

    • getTransferEncoding

      public String getTransferEncoding()
      Description copied from interface: ContentDescriptor
      Returns the body descriptors transfer encoding.
      Specified by:
      getTransferEncoding in interface ContentDescriptor
      Returns:
      The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.

    • getContentLength

      public long getContentLength()
      Description copied from interface: ContentDescriptor
      Returns the body descriptors content-length.
      Specified by:
      getContentLength in interface ContentDescriptor
      Returns:
      Content length, if known, or -1, to indicate the absence of a content-length header.

    • getMimeMajorVersion

      public int getMimeMajorVersion()
      Gets the MIME major version as specified by the MIME-Version header. Defaults to one.
      Returns:
      positive integer

    • getMimeMinorVersion

      public int getMimeMinorVersion()
      Gets the MIME minor version as specified by the MIME-Version header. Defaults to zero.
      Returns:
      positive integer

    • getContentDescription

      public String getContentDescription()
      Gets the value of the RFC Content-Description header.
      Returns:
      value of the Content-Description when present, null otherwise

    • getContentId

      public String getContentId()
      Gets the value of the RFC Content-ID header.
      Returns:
      value of the Content-ID when present, null otherwise

    • getContentDispositionType

      public String getContentDispositionType()
      Gets the disposition type of the content-disposition field. The value is case insensitive and will be converted to lower case. See RFC2183.
      Returns:
      content disposition type, or null when this has not been set

    • getContentDispositionParameters

      public Map<String,String> getContentDispositionParameters()
      Gets the parameters of the content-disposition field. See RFC2183.
      Returns:
      parameter value strings indexed by parameter name strings, not null

    • getContentDispositionFilename

      public String getContentDispositionFilename()
      Gets the filename parameter value of the content-disposition field. See RFC2183.
      Returns:
      filename parameter value, or null when it is not present

    • getContentDispositionModificationDate

      public Date getContentDispositionModificationDate()
      Gets the modification-date parameter value of the content-disposition field. See RFC2183.
      Returns:
      modification-date parameter value, or null when this is not present

    • getContentDispositionCreationDate

      public Date getContentDispositionCreationDate()
      Gets the creation-date parameter value of the content-disposition field. See RFC2183.
      Returns:
      creation-date parameter value, or null when this is not present

    • getContentDispositionReadDate

      public Date getContentDispositionReadDate()
      Gets the read-date parameter value of the content-disposition field. See RFC2183.
      Returns:
      read-date parameter value, or null when this is not present

    • getContentDispositionSize

      public long getContentDispositionSize()
      Gets the size parameter value of the content-disposition field. See RFC2183.
      Returns:
      size parameter value, or -1 if this size has not been set

    • getContentLanguage

      public List<String> getContentLanguage()
      Get the content-language header values. Each applicable language tag will be returned in order. See RFC4646 http://tools.ietf.org/html/rfc4646.
      Returns:
      list of language tag Strings, or null if no header exists

    • getContentLocation

      public String getContentLocation()
      Get the content-location header value. See RFC2557
      Returns:
      the URL content-location or null if no header exists

    • getContentMD5Raw

      public String getContentMD5Raw()
      Gets the raw, Base64 encoded value of the Content-MD5 field. See RFC1864.
      Returns:
      raw encoded content-md5 or null if no header exists

    • toString

      public String toString()
      Overrides:
      toString in class Object