Class PTTransformer

Object
   |
   +--PTTransformer

class PTTransformer

A utility class for gateway transformer methods. This object contains no public fields or methods.
Defined in PTTransformer.js

Constructor Detail

PTTransformer

PTTransformer()

PTTransformer static object constructor.

addPortToURL

<static> Object addPortToURL(uri, portNumber)

Takes a String url, parses it, and swaps or adds the given portNumber.

changeUri

<static> Object changeUri(uri,propertyName,newValue)

Takes a url object and assigns the given property a new value. uri - an object which is created via parseUri(sourceUri) propertyName - a property of the given input uri object newValue - a new value for the given property of the given uri object

doesURLbeginWithSlash

<static> Object doesURLbeginWithSlash(URL)

doesURLendWithSlash

<static> Object doesURLendWithSlash(URL)

makeAbsoluteURL

<static>  <private> Object makeAbsoluteURL(URL,remoteRequestURL,remoteBaseURL)

Make an URL into an absolute URL

Parameters:
URL -
The URL to make absolute (string)
remoteRequestURL -
Protocol, host name, and port number of remote server (string) (eg. 'http://remoteserver.domain.com')
remoteBaseURL -
Base URL to remote server resource (string) (eg. 'http://remoteserver.domain.com/collab/project/myProjects')

Returns:
string

makeAbsoluteURLforRunner

<static> Object makeAbsoluteURLforRunner(URL,remoteRequestURL,remoteBaseURL)

makeRelativeURL

<static>  <private> Object makeRelativeURL(remoteAbsoluteURL,remoteBaseURL)

Make an absolute URL into a relatice URL

Parameters:
remoteAbsoluteURL -
The URL to make relative (string)
remoteBaseURL -
Base URL to remote server resource (string) (eg. 'http://remoteserver.domain.com/collab/project/myProjects')

Returns:
string

parseURL

<static> Object parseURL(_url)

Takes any string url object and parses it into queryable/settable segments: "wholeUrl" - the matching url, input url "protocol" - http or https, possibly null for relative urls "domain" - everything between the "protocol" and the "portWithPrecedingColon" "portWithPrecedingColon" - port # preceded with :, ie ":80" "restOfURLafterPort" - everything after the port number (queryString, anchor, etc)

prepUrlForTransformAlgor

<static> Object prepUrlForTransformAlgor(url)

Preps an URL for transformation by adding default ports 80/443 to urls which don't already have them. Transformation logic is dependant on the existence of those port numbers.

transformURLasPortal

<static>  <private> Object transformURLasPortal(URL,remoteRequestURL,remoteBaseURL,gatewayPrefixURL,secureGatewayPrefixURL)

Transform a URL to be gatewayed

Parameters:
URL -
The URL to be gatewayed (string)
remoteRequestURL -
Protocol, host name, and port number of remote server (string) (eg. 'http://remoteserver.domain.com')
remoteBaseURL -
Base URL to remote server resource (string) (eg. 'http://remoteserver.domain.com/collab/project/myProjects')
gatewayPrefixURL -
URL for gateway prefix (string) (eg. 'http://portal.domain.com/portal/server.pt/gateway/PTARGS_0_1_203_0_1_43/')
secureGatewayPrefixURL -
URL for secure gateway prefix (string) (eg. 'https://portal.domain.com/portal/server.pt/gateway/PTARGS_0_1_203_0_1_43/')

Returns:
string

transformURLasRunner

<static> Object transformURLasRunner(URL,remoteRequestURL,remoteBaseURL,gatewayPrefixURL,secureGatewayPrefixURL)