Namespace: OpenEdge.BusinessRules
Class
RulesServerConnectionParameters
Parent classes:
Progress.Lang.Object
OpenEdge.BusinessRules.RulesServerConnectionParameters

Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.ServerConnection.IConnectionParameters

Copyright ( c) 2013, 2018-2021 by Progress Software Corporation. All rights reserved.
File:RulesServerConnectionParameters
Purpose:Purposed connection parameters for connecting to a Rules Server
Author(s):pjudge
Created:Thu Feb 28 15:07:49 EST 2013
Notes:* The Options property contains JSON data, which for a Rules Server Connection must have
the following structure
{ "URL": Parameters as per OpenEdge.Core.ServerConnection.WebServiceConnectionParameters
OR a host name like "http://localhost:8980/"
OR a simple pathed URL like "http://localhost:8980/axis/services/"
OR something else in the future
}
specified. Note that if a WSDL is specified, it overrides the value specified by the URL property
{"WSDL": Parameters as per OpenEdge.Core.ServerConnection.WebServiceConnectionParameters,
which includes a simple string like "wsdl/CorticonExecuteMod.wsdl"
}
thus overriding the value or the URL property. The URL property is always
used for the Admin Service.
default paths or queries added to it.
absence of a WSDL property.
Path: /axis/services/<ServiceName>
ServiceName: either Corticon or CorticonAdmin
Query: ?wsdl
If the URL property is in one of the following formats, this
object will add the necessary default values to allow a call
to a Corticon Server.
- No path, no query: eg http://localhost:8980
- Matching path: eg http://localhost:8980/axis/services
- No path, no WSDL query: eg http://localhost:8980?name1=value1
In all of these cases, the URL will be modified with the missing
parts. For example, the resulting Decision Service URL will be
http://localhost:8980/axis/services/Corticon?wsdl
The protocol, host, port and user/password aspects of the URL
are not modified. Only the path and query may change.
property specified, the Admin Service cannot be contacted and thus
any Admin Service APIs will throw an error.
Decision Service connection




Method Summary
Options Name Purpose
AddServiceWsdl (JsonObject, character)
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. @return character A useable string of connection parameters. */
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. Typically overrides the mask specified by the property. @return character A useable string of connection parameters. */
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. */
Initialise (JsonObject)
ShadowConstructor (JsonObject) /** 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 */

Constructor Summary
Options Name Purpose
RulesServerConnectionParameters (character)
RulesServerConnectionParameters (IConnectionParameters, IConnectionParameters) /* Constructor. @param IConnectionParameters Connection parameters for the Corticon ADMIN service @param IConnectionParameters Connection parameters for the Corticon decusion service */
RulesServerConnectionParameters (JsonObject)

Property Summary
Options Name Purpose
OpenEdge.Core.ServerConnection.IConnectionParameters AdminServiceConnectionParameters
OpenEdge.Core.ServerConnection.IConnectionParameters DecisionServiceConnectionParameters
OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask


Method Detail
Top

AddServiceWsdl (JsonObject, character)
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
pcServiceName CHARACTER
Top

CHARACTER 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

CHARACTER GetConnectionString (character)
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

CHARACTER GetConnectionString (FormatMaskEnum)
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

Initialise (JsonObject)
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
Top

ShadowConstructor (JsonObject)
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


Constructor Detail
Top

RulesServerConnectionParameters (character)
Parameters:
pcOptions CHARACTER
Top

RulesServerConnectionParameters (IConnectionParameters, IConnectionParameters)
/* Constructor.
Parameters:
pAdminServiceParams OpenEdge.Core.ServerConnection.IConnectionParameters
pDecisionServiceParams OpenEdge.Core.ServerConnection.IConnectionParameters
Top

RulesServerConnectionParameters (JsonObject)
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject


Property Detail
Top

OpenEdge.Core.ServerConnection.IConnectionParameters AdminServiceConnectionParameters
Returns OpenEdge.Core.ServerConnection.IConnectionParameters
Top

OpenEdge.Core.ServerConnection.IConnectionParameters DecisionServiceConnectionParameters
Returns OpenEdge.Core.ServerConnection.IConnectionParameters
Top

OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
Returns OpenEdge.Core.ServerConnection.FormatMaskEnum


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15