Package org.apache.manifoldcf.agents.output.solr

Class ModifiedHttpMultipart

  • public class ModifiedHttpMultipart
extends java.lang.Object
    HttpMultipart represents a collection of MIME multipart encoded content bodies. This class is capable of operating either in the strict (RFC 822, RFC 2045, RFC 2046 compliant) or the browser compatible modes.
    Since:
    4.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ModifiedHttpMultipart​(java.lang.String subType, java.lang.String boundary)  
      ModifiedHttpMultipart​(java.lang.String subType, java.nio.charset.Charset charset, java.lang.String boundary)
      Creates an instance with the specified settings.
      ModifiedHttpMultipart​(java.lang.String subType, java.nio.charset.Charset charset, java.lang.String boundary, org.apache.http.entity.mime.HttpMultipartMode mode)
      Creates an instance with the specified settings.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBodyPart​(org.apache.http.entity.mime.FormBodyPart part)  
      java.util.List<org.apache.http.entity.mime.FormBodyPart> getBodyParts()  
      java.lang.String getBoundary()  
      java.nio.charset.Charset getCharset()  
      org.apache.http.entity.mime.HttpMultipartMode getMode()  
      java.lang.String getSubType()  
      long getTotalLength()
      Determines the total length of the multipart content (content length of individual parts plus that of extra elements required to delimit the parts from one another).
      void writeTo​(java.io.OutputStream out)
      Writes out the content in the multipart/form encoding.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ModifiedHttpMultipart

        public ModifiedHttpMultipart​(java.lang.String subType,
                             java.nio.charset.Charset charset,
                             java.lang.String boundary,
                             org.apache.http.entity.mime.HttpMultipartMode mode)
        Creates an instance with the specified settings.
        Parameters:
        subType - mime subtype - must not be null
        charset - the character set to use. May be null, in which case MIME.DEFAULT_CHARSET - i.e. US-ASCII - is used.
        boundary - to use - must not be null
        mode - the mode to use
        Throws:
        java.lang.IllegalArgumentException - if charset is null or boundary is null

      • ModifiedHttpMultipart

        public ModifiedHttpMultipart​(java.lang.String subType,
                             java.nio.charset.Charset charset,
                             java.lang.String boundary)
        Creates an instance with the specified settings. Mode is set to HttpMultipartMode.STRICT
        Parameters:
        subType - mime subtype - must not be null
        charset - the character set to use. May be null, in which case MIME.DEFAULT_CHARSET - i.e. US-ASCII - is used.
        boundary - to use - must not be null
        Throws:
        java.lang.IllegalArgumentException - if charset is null or boundary is null

      • ModifiedHttpMultipart

        public ModifiedHttpMultipart​(java.lang.String subType,
                             java.lang.String boundary)

    • Method Detail

      • getSubType

        public java.lang.String getSubType()

      • getCharset

        public java.nio.charset.Charset getCharset()

      • getMode

        public org.apache.http.entity.mime.HttpMultipartMode getMode()

      • getBodyParts

        public java.util.List<org.apache.http.entity.mime.FormBodyPart> getBodyParts()

      • addBodyPart

        public void addBodyPart​(org.apache.http.entity.mime.FormBodyPart part)

      • getBoundary

        public java.lang.String getBoundary()

      • writeTo

        public void writeTo​(java.io.OutputStream out)
             throws java.io.IOException
        Writes out the content in the multipart/form encoding. This method produces slightly different formatting depending on its compatibility mode.
        Throws:
        java.io.IOException
        See Also:
        getMode()

      • getTotalLength

        public long getTotalLength()
        Determines the total length of the multipart content (content length of individual parts plus that of extra elements required to delimit the parts from one another). If any of the @{link BodyPart}s contained in this object is of a streaming entity of unknown length the total length is also unknown.

        This method buffers only a small amount of data in order to determine the total length of the entire entity. The content of individual parts is not buffered.

        Returns:
        total length of the multipart entity if known, -1 otherwise.