OpenEdge ABL API Reference

OpenEdge.Core.ServerConnection.UrlConnectionParameters

Save PDF

Save PDF

Namespace:

OpenEdge.Core.ServerConnection

Type: 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. */
		Initialise ()

Constructor Summary

	Options	Name	Purpose
		UrlConnectionParameters (character)
		UrlConnectionParameters (JsonObject)

Method Detail

Top

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

Constructor Detail

Top

Top

Parameters:
poOptions	Progress.Json.ObjectModel.JsonObject