Namespace: OpenEdge.Net.HTTP.Filter.Payload
Class
JsonEntityWriter
Parent classes:
Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter

Copyright (c) 2015-2019 by Progress Software Corporation. All rights reserved.
File:JsonEntityWriter
Author(s):pjudge
Created:Thu Jan 29 10:47:13 EST 2015
Notes:- Write() operations are destructive (they replace the existing
Entity).




Method Summary
Options Name Purpose
Close () /* Closes the writer */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Close ()
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 */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Open ()
INT64 Write (character) /** Write data to/from the message @param character Data to write @return int64 The number ofbytes written */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (character)
Progress.Json.ObjectModel.JsonObject Write (Cookie) /* Writes an HTTP Cookie into a JSON property & value @param Cookie THe cookie to write */
INT64 Write (handle) /** Write data to/from the message @param handle Data to write @return int64 The number ofbytes written */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (handle)
Progress.Json.ObjectModel.JsonObject Write (HttpHeader) /* Writes an HTTP header into a JSON property & value @param HttpHeader The header to write */
INT64 Write (longchar) /** Write data to/from the message @param longchar Data to write @return int64 The number ofbytes written */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (longchar)
INT64 Write (memptr) /** Write data to/from the message @param memptr Data to write @return int64 The number ofbytes written */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (memptr)
INT64 Write (memptr, int64, int64) /* no-op */
Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
INT64 Write (Object) /** Write data to/from the message @param Progress.Lang.Object Data to write @return int64 The number ofbytes written @throws P.L.AppError if an type is not supported */
Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
WriteError (Error)
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
INT64 WriteHandle (handle) /** Write data to/from the message @param handle Data to write @return int64 The number ofbytes written */
WriteMap (IMap)
WriteTuple (Object, Object) /* Writes a tuple (key-value pair) as a JSON property & value @param Progress.Lang.Object The key value - property name (required) @param Progress.Lang.Object A value to be written for teh proeprty. May be null. */

Constructor Summary
Options Name Purpose
JsonEntityWriter () /* Default constructor */
JsonEntityWriter (Class) /** Default constructor. */

Property Summary
Options Name Purpose
Progress.Lang.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 ()

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Close ()
/* 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 ()

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Open ()
/* Opens the writer
Top

PUBLIC INT64 Write (character)

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (character)
Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
Returns INT64
int64 The number ofbytes written
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Write (Cookie)

/* Writes an HTTP Cookie into a JSON property & value
Parameters:
pCookie OpenEdge.Net.HTTP.Cookie
Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC INT64 Write (handle)

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (handle)
Purpose: Write data to/from the message
Parameters:
phData HANDLE
Returns INT64
int64 The number ofbytes written
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Write (HttpHeader)

/* Writes an HTTP header into a JSON property & value
Parameters:
pHeader OpenEdge.Net.HTTP.HttpHeader
Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC INT64 Write (longchar)

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (longchar)
Purpose: Write data to/from the message
Parameters:
pcData LONGCHAR
Returns INT64
int64 The number ofbytes written
Top

PUBLIC INT64 Write (memptr)

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (memptr)
Purpose: Write data to/from the message
Parameters:
pmData OpenEdge.Core.Memptr
Returns INT64
int64 The number ofbytes written
Top

PUBLIC INT64 Write (memptr, int64, int64)

Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
/* no-op
Parameters:
p0 OpenEdge.Core.Memptr
p1 INT64
p2 INT64
Returns INT64
Top

PUBLIC INT64 Write (Object)

Overrides OpenEdge.Net.HTTP.Filter.Payload.MessageWriter:Write (Object)
Purpose: Write data to/from the message
@throws P.L.AppError if an type is not supported
Parameters:
poData Progress.Lang.Object
Returns INT64
int64 The number ofbytes written
Top

PROTECTED WriteError (Error)

Parameters:
poError Progress.Lang.Error
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.
Top

PUBLIC INT64 WriteHandle (handle)

Purpose: Write data to/from the message
Parameters:
phData HANDLE
Returns INT64
int64 The number ofbytes written
Top

PROTECTED WriteMap (IMap)

Parameters:
pValue OpenEdge.Core.Collections.IMap
Top

PROTECTED WriteTuple (Object, Object)

/* Writes a tuple (key-value pair) as a JSON property & value
Parameters:
pKey Progress.Lang.Object
pValue Progress.Lang.Object


Constructor Detail
Top

PUBLIC JsonEntityWriter ()

/* Default constructor
Top

PROTECTED JsonEntityWriter (Class)

Purpose: Default constructor.
Parameters:
pType Progress.Lang.Class


Property Detail
Top

PUBLIC Progress.Lang.Object Entity

Inherited from OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Returns Progress.Lang.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