Namespace: OpenEdge.Net.HTTP.Filter.Payload
Class
MultipartFormEntityWriter
Parent classes:
Progress.IO.OutputStream
OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter
OpenEdge.Net.HTTP.Filter.Payload.MultipartFormEntityWriter

Inherits: OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter

Copyright (c) 2018 by Progress Software Corporation. All rights reserved.
File:MultipartFormEntityWriter
Purpose:Creates a MultipartEntity per http://tools.ietf.org/html/rfc2046 for multipart/form-data messages
Author(s):pjudge
Created:2018-03-22
Notes:* This uses the WEB-CONTEXT object when possible, for performance reasons.
OpenEdge.Net.HTTP.Filter.Payload.MultipartFormSimpleEntityWriter is the fastest parser and
does NOT read any part headers.
Entity).
/* Default constructor




Method Summary
Options Name Purpose
Close () /** Closes the writer. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
LogMessage (character, integer) /** Logs a message. @param character The message to log @param integer The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
LogMessage (character, LogLevelEnum) /** Logs a message @param character The message to log @param LogLevelEnum The level this message should be logged at */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Open () /** Opens the writer for output. Open/Close allows us to write the same message multiple times without requiring a new writer each time. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (character) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (handle) /** Write data to/from the entity @param handle Data to write */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (longchar) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (memptr) /* Writes a multipart entity based on the WEB-CONTEXT, if possible; includes any headers in the body. @param memptr The multipart message body @return int64 The number of bytes written */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter:Write (memptr)
INT64 Write (memptr, int64, int64) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (MessagePart) /* Writes a message part into this entity @param MessagePart The new part to add @return int64 The number of bytes written */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter
INT64 Write (Object) /** Write data to/from the entity @param Object Data to write */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter:Write (Object)
INT64 WriteFileStream (FileInputStream) /** Reads the contents of a file and writes the bytes as memptr @param FileInputStream A valid file stream @return int64 The number of bytes read. */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter

Constructor Summary
Options Name Purpose
MultipartFormEntityWriter () /* Default constructor */

Property Summary
Options Name Purpose
CHARACTER Boundary
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter
Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Method Detail
Top

PUBLIC Close ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Closes the writer.
Top

PROTECTED LogMessage (character, integer)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message.
Parameters:
pcMessage CHARACTER
piLogLevel INTEGER
Top

PROTECTED LogMessage (character, LogLevelEnum)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Logs a message
Parameters:
pcMessage CHARACTER
poLogLevel LogLevelEnum
Top

PUBLIC Open ()
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Opens the writer for output. Open/Close allows us to write the same message multiple
times without requiring a new writer each time.
Top

PUBLIC INT64 Write (character)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 CHARACTER
Returns INT64
Top

PUBLIC INT64 Write (handle)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Write data to/from the entity
Parameters:
phData HANDLE
Returns INT64
Top

PUBLIC INT64 Write (longchar)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 LONGCHAR
Returns INT64
Top

PUBLIC INT64 Write (memptr)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter:Write (memptr)
/* Writes a multipart entity based on the WEB-CONTEXT, if possible;
includes any headers in the body.
Parameters:
pData MEMPTR
Returns INT64
int64 The number of bytes written
Top

PUBLIC INT64 Write (memptr, int64, int64)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 MEMPTR
p1 INT64
p2 INT64
Returns INT64
Top

PROTECTED INT64 Write (MessagePart)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter
/* Writes a message part into this entity
Parameters:
pData OpenEdge.Net.MessagePart
Returns INT64
int64 The number of bytes written
Top

PUBLIC INT64 Write (Object)
Overrides OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter:Write (Object)
Purpose: Write data to/from the entity
Parameters:
poData Object
Returns INT64
Top

PROTECTED INT64 WriteFileStream (FileInputStream)
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Purpose: Reads the contents of a file and writes the bytes as memptr
Parameters:
pStream FileInputStream
Returns INT64
int64 The number of bytes read.


Constructor Detail
Top

PUBLIC MultipartFormEntityWriter ()
/* Default constructor


Property Detail
Top

PUBLIC CHARACTER Boundary
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter
Returns CHARACTER
Top

PUBLIC Object Entity
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Object
Top

PUBLIC Progress.Lang.Class EntityType
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.Class
Top

PUBLIC ILogWriter Logger
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns ILogWriter


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0