Class CQ.shared.HTTP

Package:	CQ.shared
Class:	HTTP
Extends:	Object
Clientlib:	cq.shared

Deprecated: use Granite.HTTP and Granite.$#ajax instead

A helper class providing a set of HTTP-related utilities.

This class is a singleton and cannot be created directly.

Public Properties

Property		Defined By
	EXTENSION_HTML : String <static> The extension for HTML files.	HTTP
	EXTENSION_JSON : String <static> The extension for JSON files.	HTTP
	HEADER_LOCATION : String <static> The Location header.	HTTP
	HEADER_MESSAGE : String <static> The Message header.	HTTP
	HEADER_PATH : String <static> The Path header.	HTTP
	HEADER_STATUS : String <static> The Status header.	HTTP
	PARAM_NO_CACHE : String <static> The parameter name for no caching.	HTTP
	encodePath : Object Encodes the specified path using encodeURI. Additionally +, # and ? are encoded. The following characters are not enc... Encodes the specified path using encodeURI. Additionally `+`, `#` and `?` are encoded. The following characters are not encoded: `0-9 a-z A-Z` `- _ . ! ~ * ( )` `/ : @ & =` Added in CQ 5.3.	HTTP
	encodePathOfURI : Object Encodes the path of the specified URL if it is not already encoded. Path means the part of the URL before the first q... Encodes the path of the specified URL if it is not already encoded. Path means the part of the URL before the first question mark or hash sign. See encodePath for details about the encoding. Sample: `/x/y+z.png?path=/x/y+z >> /x/y%2Bz.png?path=x/y+z` Note that the sample would not work because the "+" in the request parameter would be interpreted as a space. Parameters must be encoded separately. Added in CQ 5.3.	HTTP
	eval : Object <static> Evaluates and returns the body of the specified response object. Alternatively, a URL can be specified... <static> Evaluates and returns the body of the specified response object. Alternatively, a URL can be specified, in which case it will be requested using a synchornous get in order to acquire the response object. Added in CQ 5.3.	HTTP
	getContextPath : Object <static> Returns the context path used on the server. Added in CQ 5.3.	HTTP
	getPath : Object <static> Removes all parts but the path from the specified URL. Examples:/x/y.sel.html?param=abc => /x/y htt... <static> Removes all parts but the path from the specified URL. Examples: `/x/y.sel.html?param=abc => /x/y` `http://www.day.com/foo/bar.html => /foo/bar` Added in CQ 5.3.	HTTP
	getSchemeAndAuthority : Object <static> Returns the scheme and authority (user, hostname, port) part of the specified URL or an empty string i... <static> Returns the scheme and authority (user, hostname, port) part of the specified URL or an empty string if the URL does not include that part.	HTTP
	getXhrHook : Object Gets the XHR hooked URL if called in a portlet context	HTTP
	internalize : Object <static> Removes scheme, authority and context path from the specified absolute URL if it has the same scheme a... <static> Removes scheme, authority and context path from the specified absolute URL if it has the same scheme and authority as the specified document (or the current one).	HTTP
	removeAnchor : Object <static> Removes the anchor from the specified URL.	HTTP
	removeParameters : Object <static> Removes all parameter from the specified URL.	HTTP

Public Methods

Method		Defined By
	addParameter( `String url`, `String name`, `String/String[] value` ) : String <static> Adds a parameter to the specified URL. The parameter name and value will be URL-endcoded. <static> Adds a parameter to the specified URL. The parameter name and value will be URL-endcoded. Parameters: `url` : String The URL `name` : String The name of the parameter `value` : String/String[] The value of the parameter. Since 5.3, an array of strings can be passed Returns: `String` The URL with the new parameter	HTTP
	addSelector( `String url`, `String selector`, [`Number index`] ) : String Adds the specified selector to an URL. Adds the specified selector to an URL. Parameters: `url` : String The URL. The URL must contain a extension and must not contain a suffix (x.json/a/b). Anchor and request parameters are supported. `selector` : String The name of the selector to insert `index` : Number (optional) The index of the selector. If it is "-1" or bigger than the number of the existing selectors the selector will be appended. Defaults to "0". Returns: `String` The updated URL Added in CQ 5.3.	HTTP
	addSelectors( `String url`, `String[] selectors` ) : String Adds the specified selectors to an URL. Adds the specified selectors to an URL. Parameters: `url` : String The URL. The URL must contain a extension and must not contain a suffix (x.json/a/b). Anchor and request parameters are supported. `selectors` : String[] The name of the selectors to insert Returns: `String` The updated URL Added in CQ 5.5.	HTTP
	clearCookie( `String name`, [`String path`], [`String domain`], [`Boolean secure`] ) : void <static> Clears the cookie with the specified name. <static> Clears the cookie with the specified name. Parameters: `name` : String The name of the cookie `path` : String (optional) The server path the cookie applies to `domain` : String (optional) The server domain `secure` : Boolean (optional) True if the connection is secure Returns: `void`	HTTP
	externalize( `String url`, [`boolean encode`] ) : String <static> Makes sure the specified relative URL starts with the context path used on the server. If an absolute ... <static> Makes sure the specified relative URL starts with the context path used on the server. If an absolute URL is passed, it will be returned as-is. Parameters: `url` : String The URL `encode` : boolean true to encode the path of the URL (optional) Returns: `String` The externalized URL Added in CQ 5.3.	HTTP
	get( `String url`, [`Function callback`], [`Object scope`], [`Boolean suppressForbiddenCheck`] ) : Mixed <static> Requests the specified URL from the server using GET. The request will be synchronous, unless a callba... <static> Requests the specified URL from the server using GET. The request will be synchronous, unless a callback function is specified. Parameters: `url` : String The URL to request `callback` : Function (optional) The callback function which is called regardless of success or failure and is passed the following parameters: options : Object The parameter to the request call. success : Boolean True if the request succeeded. response : Object The response object. `scope` : Object The scope for the callback (optional) `suppressForbiddenCheck` : Boolean Suppress the check if the session has timed out (optional) Returns: `Mixed` The response object or, if the request is asynchronous, the transaction ID	HTTP
	getAnchor( `String url` ) : String <static> Returns the anchor part of the URL. <static> Returns the anchor part of the URL. Parameters: `url` : String The URL Returns: `String` The anchor	HTTP
	getCookie( `String name` ) : String <static> Returns the value of the cookie with the specified name. <static> Returns the value of the cookie with the specified name. Parameters: `name` : String The name of the cookie Returns: `String` The value of the cookie	HTTP
	getExtension( `String url` ) : String Returns the extension of an URL. This is the string after the last dot until the end of the url without any request p... Returns the extension of an URL. This is the string after the last dot until the end of the url without any request parameters, anchors or suffix, for example "html". Parameters: `url` : String The URL Returns: `String` The URL extension (without the dot) or an empty string if no was found. Added in CQ 5.4.	HTTP
	getParameter( `String url`, `String name` ) : String <static> Returns the value of the parameter with the specified name in the URL. Only the first value will be co... <static> Returns the value of the parameter with the specified name in the URL. Only the first value will be considered. Values will be URL-decoded. Parameters: `url` : String The URL `name` : String The name of the parameter Returns: `String` The value	HTTP
	getParameters( `String url`, `String name` ) : String[] <static> Returns the values of the parameters with the specified name in the URL. Values will be URL-decoded. <static> Returns the values of the parameters with the specified name in the URL. Values will be URL-decoded. Parameters: `url` : String The URL `name` : String The name of the parameter Returns: `String[]` The values	HTTP
	getSelectors( `String url` ) : Array <static> Returns an array with the selectors present in the given url. If no selectors are present, an empty ar... <static> Returns an array with the selectors present in the given url. If no selectors are present, an empty array is returned. Parameters: `url` : String The URL, optional. If no url is provided, the selectors as provided by CQURLInfo.selectors are taken, with a fallback to window.location.href. Returns: `Array` An array containing the selectors or an empty array if none were found. Added in CQ 5.4.	HTTP
	getSuffix() : String <static> Returns the current request suffix as provided by CQURLInfo.suffix. <static> Returns the current request suffix as provided by CQURLInfo.suffix. Parameters: None. Returns: `String` The suffix Added in CQ 5.5.	HTTP
	getXhrHookedURL( `String url`, `String method`, `Object params` ) : String Gets the XHR hooked URL if called in a portlet context Gets the XHR hooked URL if called in a portlet context Parameters: `url` : String The URL to get `method` : String The method to use to retrieve the XHR hooked URL `params` : Object The parameters Returns: `String` The XHR hooked URL if available, the provided URL otherwise	HTTP
	handleForbidden( `Object response`, `Boolean suppressLogin` ) : Boolean Returns if the specified response is of status 403/forbidden. If the status is 403 and suppressLogin is undefined the... Returns if the specified response is of status 403/forbidden. If the status is 403 and `suppressLogin` is undefined the document is redirected to the login page. The status is expected to be found in the "status" property of the response: `{ "status": 403 }` Parameters: `response` : Object The response `suppressLogin` : Boolean `true` to not redirect to the login page Returns: `Boolean` `true` if the status is 403	HTTP
	isOk( `Object response` ) : Boolean <static> Checks if the specified response is OK. The response object is expected to look like this: { headers: ... <static> Checks if the specified response is OK. The response object is expected to look like this: `{ headers: { "Status": 200, ... } }` See constants above for all supported headers. Parameters: `response` : Object The response object Returns: `Boolean` True if the response is OK, else false	HTTP
	isOkStatus( `Number status` ) : Boolean <static> Checks whether the specified status code is OK. <static> Checks whether the specified status code is OK. Parameters: `status` : Number The status code Returns: `Boolean` True if the status is OK, else false	HTTP
	noCaching( `String url` ) : String <static> Prevents caching by adding a timestamp to the specified URL. <static> Prevents caching by adding a timestamp to the specified URL. Parameters: `url` : String The URL Returns: `String` The URL with timestamp	HTTP
	post( `String url`, [`Function callback`], `Object params`, `Object scope`, `Boolean suppressErrorMsg`, [`Boolean suppressForbiddenCheck`] ) : Mixed <static> Requests the specified URL from the server using POST. The request will be synchronous, unless a callb... <static> Requests the specified URL from the server using POST. The request will be synchronous, unless a callback function is specified. The returned response object looks like this: `{ headers: { "Status": 200, ... } }` See constants above for all supported headers. Parameters: `url` : String The URL to request `callback` : Function (optional) The callback function which is called regardless of success or failure and is passed the following parameters: options : Object The parameter to the request call. success : Boolean True if the request succeeded. xhr : Object The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response. response : Object The response object. Added in CQ 5.3 `params` : Object The parameters `scope` : Object The scope for the callback `suppressErrorMsg` : Boolean Suppress the error msg notification `suppressForbiddenCheck` : Boolean Suppress the check if the session has timed out (optional) Returns: `Mixed` The response object or, if the request is asynchronous, the transaction ID	HTTP
	reloadHook( `String url` ) : String <static> Reloads the XHR hook (portlet context) <static> Reloads the XHR hook (portlet context) Parameters: `url` : String The URL Returns: `String` Updated URL if reload hook function exists	HTTP
	removeParameter( `String url`, `String name` ) : String <static> Removes a parameter from the specified URL. <static> Removes a parameter from the specified URL. Parameters: `url` : String The URL `name` : String The name of the parameter to remove Returns: `String` The URL without the parameter	HTTP
	setAnchor( `String url`, `String anchor` ) : String <static> Sets the anchor of the specified URL. <static> Sets the anchor of the specified URL. Parameters: `url` : String The URL `anchor` : String The anchor Returns: `String` The URL with anchor	HTTP
	setCookie( `String name`, `String value`, [`String path`], [`Number days`], [`String domain`], [`Boolean secure`] ) : String <static> Sets the value of the cookie with the specified name. <static> Sets the value of the cookie with the specified name. Parameters: `name` : String The name of the cookie `value` : String The value of the cookie `path` : String (optional) The server path the cookie applies to `days` : Number (optional) The number of days the cookie will live `domain` : String (optional) The server domain `secure` : Boolean (optional) True if the connection is secure Returns: `String` The value of the cookie	HTTP
	setParameter( `String url`, `String name`, `String value` ) : String <static> Overwrites a parameter in the specified URL. The parameter name and value will be URL-endcoded. <static> Overwrites a parameter in the specified URL. The parameter name and value will be URL-endcoded. Parameters: `url` : String The URL `name` : String The name of the parameter `value` : String The value of the parameter Returns: `String` The URL with the new parameter	HTTP
	setSelector( `String url`, `String selector`, `Number index` ) : String Replaces the selector at the given index position. If no selector exists at the index position, no change is made to ... Replaces the selector at the given index position. If no selector exists at the index position, no change is made to the URL. Parameters: `url` : String The URL. `selector` : String The value with which to replace the selector. `index` : Number The index of the selector to set/replace. Returns: `String` The URL with the selector replaced. Added in CQ 5.4.	HTTP

Public Events

This class has no public events.