Namespace: OpenEdge.Core.ServerConnection
Class
UrlConnectionParameters
Parent classes:
Progress.Lang.Object
OpenEdge.Core.ServerConnection.ConnectionParameters
OpenEdge.Core.ServerConnection.UrlConnectionParameters

Inherits: OpenEdge.Core.ServerConnection.ConnectionParameters

Copyright (c) 2013 by Progress Software Corporation. All rights reserved.
File:UrlConnectionParameters
Purpose:Builds a URL from a set of (JSON) connection parameters
Author(s):pjudge
Created:Thu Feb 28 15:07:49 EST 2013
Notes:* The Options property contains JSON data, which for a URL must have
the follopwing structure
{"protocol":"http|https|...",
"host":"localhost|192.168.0.1|...",
"port":80,
"user":"<username>",
"password":"<password>",
"path": "/app/path",
"query": [{"name":"query-param-name-1", "value":"query-param-value-1"}, ... , {"name":"query-param-name-N", "value":"query-param-value-N"} ] }
Alternatively, provide a complete URL
{"URL":"http://localhost/index.html"}




Method Summary
Options Name Purpose
CHARACTER GetConnectionString () /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param character The format mask to use. This value is IGNORED for this class. @return character A useable string of connection parameters. */
Overrides OpenEdge.Core.ServerConnection.ConnectionParameters:GetConnectionString ()
CHARACTER GetConnectionString (character) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param character The format mask to use. Overrides the mask specified by the property. @return character A useable string of connection parameters. */
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
CHARACTER GetConnectionString (FormatMaskEnum) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param FormatMaskEnum The format mask to use. Overrides the mask specified by the property. @return character A useable string of connection parameters. */
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
CHARACTER GetConnectionString (JsonObject, character) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param JsonObject Options in JSON format. @param character The format mask to use. @return character A useable string of connection parameters. */
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Initialise ()
Overrides OpenEdge.Core.ServerConnection.ConnectionParameters:Initialise ()

Constructor Summary
Options Name Purpose
UrlConnectionParameters (character)
UrlConnectionParameters (JsonObject)

Property Summary
Options Name Purpose
OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Progress.Json.ObjectModel.JsonObject Options
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
CHARACTER ResolvedOptions
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters


Method Detail
Top

PUBLIC CHARACTER GetConnectionString ()
Overrides OpenEdge.Core.ServerConnection.ConnectionParameters:GetConnectionString ()
Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
Returns CHARACTER
character A useable string of connection parameters.
Top

PUBLIC CHARACTER GetConnectionString (character)
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
specified by the property.
Parameters:
pcFormatMask CHARACTER
Returns CHARACTER
character A useable string of connection parameters.
Top

PUBLIC CHARACTER GetConnectionString (FormatMaskEnum)
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
specified by the property.
Parameters:
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum
Returns CHARACTER
character A useable string of connection parameters.
Top

PUBLIC CHARACTER GetConnectionString (JsonObject, character)
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
pcFormatMask CHARACTER
Returns CHARACTER
character A useable string of connection parameters.
Top

PROTECTED Initialise ()
Overrides OpenEdge.Core.ServerConnection.ConnectionParameters:Initialise ()


Constructor Detail
Top

PUBLIC UrlConnectionParameters (character)
Parameters:
pcOptions CHARACTER
Top

PUBLIC UrlConnectionParameters (JsonObject)
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject


Property Detail
Top

PUBLIC OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Returns OpenEdge.Core.ServerConnection.FormatMaskEnum
Top

PROTECTED Progress.Json.ObjectModel.JsonObject Options
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED CHARACTER ResolvedOptions
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0