Namespace: OpenEdge.Net
Class 
URI
Parent classes:
Progress.Lang.Object

Inherits: Progress.Lang.Object

Copyright (c) 2014, 2015 by Progress Software Corporation. All rights reserved.
File:URI
Purpose:A generic URI object, useful for making request over a network
Author(s):pjudge
Created:Wed Dec 18 13:02:50 EST 2013
Notes:* W3C spec at http://tools.ietf.org/html/rfc3986




Method Summary
Options Name Purpose
# AddQuery (character) /** Adds a name-only QueryMap argument. Equivalent to calling AddQueryMap(pcname, ?). @param character The QueryMap name */
# AddQuery (character, character) /** Adds a query argument @param character The query name @param character The query value */
+ BuildUri () /* constructs a string representation */
# CHARACTER Decode () /** Attempts to decode a previously-encoded URL. @return character A decoded URL */
# CHARACTER Decode (character) /** Attempts to decode a previously-encoded URL. @param character The URL to decode @return character A decoded URL */
# CHARACTER Encode () /** Encodes this URI @return character An encoded version of the URI */
# CHARACTER Encode (character, UriEncodingTypeEnum) /** Encodes a string for a particular purpose @param character The string to encode @param EncondingTypeEnum The type of encoding to apply @return character the encoded string */
# CHARACTER Encode (URI) /** Encodes a URI. @param URI The URI to encode @param character A character representaion of the URI */
# INTEGER GetQueryNames (character[]) /** Returns an array of query names @param character[] An array @return integer The number */
# CHARACTER GetQueryValue (character) /** Get a char query value from the query @param character The query name */
# OpenEdge.Net.URI Parse (character) /** Parses a string containing a URI and creates a URI object from it @param character a string URI (eg http://www.progress.com/) @return URI A URI representation of the string. */
# CHARACTER ToString () /** Returns a string representation of this URI @return character The string URI */

Constructor Summary
Options Name Purpose
# URI (character) /** Constructor. Defaults to HTTP scheme. @param character The host name. */
# URI (character, character) /** Constructor. @param character The scheme for this URI. @param character The host name. */
# URI (character, character, integer) /** Constructor. @param character The scheme for this URI. @param character The host name. @param integer The port to use. */
# URI (character, character, integer, character, IStringStringMap, character) /** Constructor. @param character The scheme for this URI. @param character The host name. @param integer The port to use. @param character The path @param IStringStringMap the QueryMap arguments @param character The fragment, if any */

Property Summary
Options Name Purpose
# CHARACTER BaseURI /** Returns a base URI (scheme, host, etc) */
# CHARACTER Fragment /** (optional) The URI fragment (ie trails the # at the end of the URI) */
# CHARACTER Host /** (mandatory) The host */
# CHARACTER Password /** (optional) The user's password */
# CHARACTER Path /** (optional) The URI path. May contain parameters. Must be empty or begin with a / */
# INTEGER Port /** (optional) The port for this URI. Some schemes assume a default (ie 80 for http) */
OpenEdge.Core.Collections.IStringStringMap QueryMap /** A map of QueryMap arguments. Set these value via AddQueryMap() */
# CHARACTER QueryString /** Returns the Query string, if any */
# CHARACTER RelativeURI /** Returns a relative URI (path, QueryMap et al) */
# CHARACTER Scheme /** (mandatory) The schema of the URI (ie http, https etc) */
# CHARACTER User /** (optional) A user for this URI */


Method Detail
Top

PROTECTED AddQuery (character)

Purpose: Adds a name-only QueryMap argument. Equivalent to calling
AddQueryMap(pcname, ?).
Parameters:
pcName CHARACTER
Top

PROTECTED AddQuery (character, character)

Purpose: Adds a query argument
Parameters:
pcName CHARACTER
pcValue CHARACTER
Top

PUBLIC BuildUri ()

/* constructs a string representation
Top

PROTECTED CHARACTER Decode ()

Purpose: Attempts to decode a previously-encoded URL.
Returns CHARACTER
character A decoded URL
Top

PROTECTED CHARACTER Decode (character)

Purpose: Attempts to decode a previously-encoded URL.
Parameters:
pcURI CHARACTER
Returns CHARACTER
character A decoded URL
Top

PROTECTED CHARACTER Encode ()

Purpose: Encodes this URI
Returns CHARACTER
character An encoded version of the URI
Top

PROTECTED CHARACTER Encode (character, UriEncodingTypeEnum)

Purpose: Encodes a string for a particular purpose
Parameters:
pcString CHARACTER
poEncodingType OpenEdge.Net.UriEncodingTypeEnum
Returns CHARACTER
character the encoded string
Top

PROTECTED CHARACTER Encode (URI)

Purpose: Encodes a URI.
Parameters:
poURI OpenEdge.Net.URI
Returns CHARACTER
Top

PROTECTED INTEGER GetQueryNames (character[])

Purpose: Returns an array of query names
Parameters:
pcNames CHARACTER
Returns INTEGER
integer The number
Top

PROTECTED CHARACTER GetQueryValue (character)

Purpose: Get a char query value from the query
Parameters:
pcName CHARACTER
Returns CHARACTER
Top

PROTECTED OpenEdge.Net.URI Parse (character)

Purpose: Parses a string containing a URI and creates a URI object from it
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.URI
URI A URI representation of the string.
Top

PROTECTED CHARACTER ToString ()

Purpose: Returns a string representation of this URI
Returns CHARACTER
character The string URI


Constructor Detail
Top

PROTECTED URI (character)

Purpose: Constructor. Defaults to HTTP scheme.
Parameters:
pcHost CHARACTER
Top

PROTECTED URI (character, character)

Purpose: Constructor.
Parameters:
pcScheme CHARACTER
pcHost CHARACTER
Top

PROTECTED URI (character, character, integer)

Purpose: Constructor.
Parameters:
pcScheme CHARACTER
pcHost CHARACTER
piPort INTEGER
Top

PROTECTED URI (character, character, integer, character, IStringStringMap, character)

Purpose: Constructor.
Parameters:
pcScheme CHARACTER
pcHost CHARACTER
piPort INTEGER
pcPath CHARACTER
poQueryMap OpenEdge.Core.Collections.IStringStringMap
pcFragment CHARACTER


Property Detail
Top

PROTECTED CHARACTER BaseURI

Purpose: Returns a base URI (scheme, host, etc)
Returns CHARACTER
Top

PROTECTED CHARACTER Fragment

Purpose: (optional) The URI fragment (ie trails the # at the end of the URI)
Returns CHARACTER
Top

PROTECTED CHARACTER Host

Purpose: (mandatory) The host
Returns CHARACTER
Top

PROTECTED CHARACTER Password

Purpose: (optional) The user's password
Returns CHARACTER
Top

PROTECTED CHARACTER Path

Purpose: (optional) The URI path. May contain parameters.
Must be empty or begin with a /
Returns CHARACTER
Top

PROTECTED INTEGER Port

Purpose: (optional) The port for this URI. Some schemes assume a default (ie 80 for http)
Returns INTEGER
Top

OpenEdge.Core.Collections.IStringStringMap QueryMap

Purpose: A map of QueryMap arguments. Set these value via AddQueryMap()
Returns OpenEdge.Core.Collections.IStringStringMap
Top

PROTECTED CHARACTER QueryString

Purpose: Returns the Query string, if any
Returns CHARACTER
Top

PROTECTED CHARACTER RelativeURI

Purpose: Returns a relative URI (path, QueryMap et al)
Returns CHARACTER
Top

PROTECTED CHARACTER Scheme

Purpose: (mandatory) The schema of the URI (ie http, https etc)
Returns CHARACTER
Top

PROTECTED CHARACTER User

Purpose: (optional) A user for this URI
Returns CHARACTER


10.27.2015 12:36:56