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 ()
+ ShadowConstructor (JsonObject, FormatMaskEnum) /** Shadow constructor for this class. Used instead of a real constructor since some transformations have to happen before its called, and since a constructor must be invoked first via SUPER or THIS-OBJECT, there's no room for those transformations. @param JsonObject The options in JSON form @param FormatMaskEnum The Format mask to use for this connection. */
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters

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

Property Summary
Options Name Purpose
# OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask /** The FormatMask property contains a mask to be used together with the ABL SUBSTITUTE function. It can include up to 9 substitutions (&1-&9) and should also include any key/value pair separators (space, usually). */
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters


Method Detail
Top

PROTECTED 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

PROTECTED 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

PROTECTED 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

PROTECTED 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

Initialise ()
Top

PUBLIC ShadowConstructor (JsonObject, FormatMaskEnum)
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Purpose: Shadow constructor for this class. Used instead of a real constructor since some transformations
have to happen before its called, and since a constructor must be invoked first via SUPER or THIS-OBJECT,
there's no room for those transformations.
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum


Constructor Detail
Top

PROTECTED UrlConnectionParameters (character)
Parameters:
pcOptions CHARACTER
Top

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


Property Detail
Top

PROTECTED OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
Inherited from OpenEdge.Core.ServerConnection.ConnectionParameters
Purpose: The FormatMask property contains a mask to be used together with
the ABL SUBSTITUTE function. It can include up to 9 substitutions (&1-&9)
and should also include any key/value pair separators (space, usually).
Returns OpenEdge.Core.ServerConnection.FormatMaskEnum


10.27.2015 12:36:27