Namespace: OpenEdge.DataAdmin.Rest
Class
RestRequestInfo
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Rest.RestRequestInfo

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.Rest.IRestRequestInfo

/* Copyright (c) 2012 by Progress Software Corporation.
/*
/* All rights reserved. No part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from Progress Software Corporation.
File:RestRequestInfo
Author(s):hdaniels
Created:Thu Mar 15 14:40:57 EDT 2012




Method Summary
Options Name Purpose
CHARACTER GetFileExtension (character)
CHARACTER GetFullPathName (JSonObject, character)
InitFromJSON (character, JsonObject) /** initialize from json object */
InitFromJSONFile (character) /** initialize from json file */
ReadJson (character) /* returns json object from the json file*/
ReadProperties (JSONObject)
ReadRequest (JsonObject)
CHARACTER StripFileExtension (character)

Constructor Summary
Options Name Purpose
RestRequestInfo ()

Property Summary
Options Name Purpose
CHARACTER CaptureFileName /** capture file - output to in batch mode - unexpected errors */
CHARACTER Collection /** rest collection - the first */
CHARACTER Connection /** connection - db connection */
INTEGER ConnectionsPos /** the slash entry position of the the connections collection in the URL */
CHARACTER DownloadFileName /** a file that will be generated by the app - for example .p */
CHARACTER ErrorFileName /** error file - "expected" errors - return OutFileName as default */
CHARACTER FileName /** Request body - json */
CHARACTER LogFileName /** Log file for asynch request */
CHARACTER Method /** URL method - POST, PUT, GET, DELETE */
CHARACTER OutFileName /** Request response file. HTTP status header. json body if not asynch */
CHARACTER Path /** path for files */
CHARACTER ProcedureName /** run procedure */
CHARACTER StatusFileName /** app specifc status output */
INTEGER StatusInterval /** log status info for load/dump- time interval in milliseconds */
CHARACTER UploadFileName /** a file to upload by the app - for example .df */
CHARACTER Url /** request URL */


Method Detail
Top

CHARACTER GetFileExtension (character)
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

CHARACTER GetFullPathName (JSonObject, character)
Parameters:
pJson Progress.Json.ObjectModel.JSonObject
pcProp CHARACTER
Returns CHARACTER
Top

InitFromJSON (character, JsonObject)
Purpose: initialize from json object
Parameters:
pcPath CHARACTER
pJson Progress.Json.ObjectModel.JsonObject
Top

InitFromJSONFile (character)
Purpose: initialize from json file
Parameters:
pcFileName CHARACTER
Top

ReadJson (character)
/* returns json object from the json file
Parameters:
pcFile CHARACTER
Top

ReadProperties (JSONObject)
Parameters:
pJson Progress.Json.ObjectModel.JSONObject
Top

ReadRequest (JsonObject)
Parameters:
pJson Progress.Json.ObjectModel.JsonObject
Top

CHARACTER StripFileExtension (character)
Parameters:
pcFile CHARACTER
Returns CHARACTER


Constructor Detail
Top

RestRequestInfo ()


Property Detail
Top

CHARACTER CaptureFileName
Purpose: capture file - output to in batch mode - unexpected errors
Returns CHARACTER
Top

CHARACTER Collection
Purpose: rest collection - the first
Returns CHARACTER
Top

CHARACTER Connection
Purpose: connection - db connection
Returns CHARACTER
Top

INTEGER ConnectionsPos
Purpose: the slash entry position of the the connections collection in the URL
Returns INTEGER
Top

CHARACTER DownloadFileName
Purpose: a file that will be generated by the app - for example .p
Returns CHARACTER
Top

CHARACTER ErrorFileName
Purpose: error file - "expected" errors - return OutFileName as default
Returns CHARACTER
Top

CHARACTER FileName
Purpose: Request body - json
Returns CHARACTER
Top

CHARACTER LogFileName
Purpose: Log file for asynch request
Returns CHARACTER
Top

CHARACTER Method
Purpose: URL method - POST, PUT, GET, DELETE
Returns CHARACTER
Top

CHARACTER OutFileName
Purpose: Request response file. HTTP status header. json body if not asynch
Returns CHARACTER
Top

CHARACTER Path
Purpose: path for files
Returns CHARACTER
Top

CHARACTER ProcedureName
Purpose: run procedure
Returns CHARACTER
Top

CHARACTER StatusFileName
Purpose: app specifc status output
Returns CHARACTER
Top

INTEGER StatusInterval
Purpose: log status info for load/dump- time interval in milliseconds
Returns INTEGER
Top

CHARACTER UploadFileName
Purpose: a file to upload by the app - for example .df
Returns CHARACTER
Top

CHARACTER Url
Purpose: request URL
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7