Namespace: OpenEdge.Net.HTTP.Lib.ABLSockets
Class 
ABLSocketLibraryBuilder
Parent classes:
Inherits: OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder

Copyright (c) 2015 by Progress Software Corporation. All rights reserved.
File:ABLSocketLibraryBuilder
Author(s):pjudge
Created:Wed Jan 14 14:01:12 EST 2015




Method Summary
Options Name Purpose
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslCipher (character) /** Adds (appends) a single SSL cipher to the config. @param character A non-empty cipher. @return ClientLibraryBuilder This builder object */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslProtocol (character) /** Adds (appends) a single SSL protocol to the config. @param character A non-empty protocols. @return ClientLibraryBuilder This builder object */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Build () /** Builder director method. @return ClientBuilder A builder for the requested type */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters BuildSocketConnectionParams () /** Builds the connection parameter from the config options. @return ClientSocketConnectionParameters The complete connection parameters. */
OpenEdge.Net.ServerConnection.ClientSocket CreateClientSocket () /** Creates the ABL socket wrapper/holder class, based on the config */
+ InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
+ OpenEdge.Net.HTTP.IHttpClientLibrary NewLib () /** helper method to do the actual build */
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, character) /** Adds or overwrites an option for the client library. @param character The name of the option @param character The value of the option (can be anything) @return ClientLibraryBuilder This builder object. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, decimal) /** Adds or overwrites an option for the client library. @param character The name of the option @param decimal The value of the option (can be anything) @return ClientLibraryBuilder This builder object. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, int64) /** Adds or overwrites an option for the client library. @param character The name of the option @param int64 The value of the option (can be anything) @return ClientLibraryBuilder This builder object. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, logical) /** Adds or overwrites an option for the client library. @param character The name of the option @param logical The value of the option (can be anything) @return ClientLibraryBuilder This builder object. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, Object) /** Adds or overwrites an option for the client library. @param character The name of the option @param Object The value of the option (can be anything) @return ClientLibraryBuilder This builder object. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslCiphers (character[]) /** Add an array of SSL ciphers to the config. Replaces any existing ciphers. @param character[] A non-empty array of ciphers. @return ClientLibraryBuilder This builder object */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslProtocols (character[]) /** Add an array of SSL protocols to the config. Replaces any existing protocols. @param character[] A non-empty array of protocols. @return ClientLibraryBuilder This builder object */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
# OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SslVerifyHost (logical) /** Determines whether the SSL host should be verified @param logical True if host verification should be enabled @return ClientLibraryBuilder This builder object */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder

Constructor Summary
Options Name Purpose
# ABLSocketLibraryBuilder ()

Property Summary
Options Name Purpose
+ CHARACTER LIB_NAME /* constants. private and properties to make immutable */
+ CHARACTER LIB_VERSION
# OpenEdge.Net.HTTP.IHttpClientLibrary Library
Overrides OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder:Library
# BuilderRegistry Registry /** Registry for the mapping of library types to their builder. */
Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder


Method Detail
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslCipher (character)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds (appends) a single SSL cipher to the config.
Parameters:
pcCipher CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder AddSslProtocol (character)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds (appends) a single SSL protocol to the config.
Parameters:
pcProtocol CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Build ()

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Builder director method.
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientBuilder A builder for the requested type
Top

OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters BuildSocketConnectionParams ()

Purpose: Builds the connection parameter from the config options.
Returns OpenEdge.Net.ServerConnection.ClientSocketConnectionParameters
ClientSocketConnectionParameters The complete connection parameters.
Top

OpenEdge.Net.ServerConnection.ClientSocket CreateClientSocket ()

Purpose: Creates the ABL socket wrapper/holder class, based on the config
Returns OpenEdge.Net.ServerConnection.ClientSocket
Top

PUBLIC InitializeRegistry (BuilderRegistry)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds initial values into the registry
Parameters:
poRegistry BuilderRegistry
Top

PUBLIC OpenEdge.Net.HTTP.IHttpClientLibrary NewLib ()

Purpose: helper method to do the actual build
Returns OpenEdge.Net.HTTP.IHttpClientLibrary
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, character)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object.
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, decimal)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
pdValue DECIMAL
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object.
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, int64)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
piValue INT64
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object.
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, logical)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
plValue LOGICAL
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object.
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder Option (character, Object)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Adds or overwrites an option for the client library.
Parameters:
pcName CHARACTER
poValue Object
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object.
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslCiphers (character[])

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Add an array of SSL ciphers to the config. Replaces any existing
ciphers.
Parameters:
pcCiphers CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SetSslProtocols (character[])

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Add an array of SSL protocols to the config. Replaces any existing
protocols.
Parameters:
pcProtocols CHARACTER
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object
Top

PROTECTED OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder SslVerifyHost (logical)

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Determines whether the SSL host should be verified
Parameters:
plVerify LOGICAL
Returns OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
ClientLibraryBuilder This builder object


Constructor Detail
Top

PROTECTED ABLSocketLibraryBuilder ()



Property Detail
Top

PUBLIC CHARACTER LIB_NAME

/* constants. private and properties to make immutable
Returns CHARACTER
Top

PUBLIC CHARACTER LIB_VERSION

Returns CHARACTER
Top

PROTECTED OpenEdge.Net.HTTP.IHttpClientLibrary Library

Overrides OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder:Library
Returns OpenEdge.Net.HTTP.IHttpClientLibrary
Top

PROTECTED BuilderRegistry Registry

Inherited from OpenEdge.Net.HTTP.Lib.ClientLibraryBuilder
Purpose: Registry for the mapping of library types to their builder.
Returns BuilderRegistry


10.27.2015 12:36:51