Web API

Request

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Method Summary
Request clean()

Returns this request with clean mode enabled which removes all non ASCII characters and any control characters.

  clearSessionData()

Deletes all data objects set by setSessionData.

  clearSessionValues()

Deletes all values set by setSessionValue.

  deleteCookie(String name)

Deletes the specified cookie.

  deleteCookies()

Deletes all cookies.

String get(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

String getAjaxTarget()

If set, returns the ajax-target attribute of the request.

String getCookie(String name)

Returns the specified cookie or null if no cookie exists.

Data getData()

Returns the Data object for this request. This will contain all the form field values posted from the client.

String getDomain()

Returns the domain of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns www.mysite.com.

String getEncryptedValue(String key)

Returns the decrypted value for the specified input field. Returns null if no value exists or if the parameter is not encrypted.

String[] getEncryptedValues(String key)

Returns an array of decrypted values for the specified input field. Returns null if no values exist or if the parameter is not encrypted.

String getHTML(String name)

Returns the html content from the specified input field. Limit 5000 characters. Name limit is 80 characters.

String getHeader(String header)

Returns the specified header

PacketDataList getHeaders()

Returns all the headers as a datalist

String getPage()

Returns the path and page of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns page.html.

String[] getParameterNames()

Returns an array of all parameters sent from the client.

String[] getParameterValues(String name)

Returns an array of all values of the specified parameter.

String getPath()

Returns the path of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns information/subject.

String getReferrer()

Returns the hostname of the referrer of the request.

String getRequestMethod()

Returns the http method.

String getRequestUrl()

Returns the url requested (which may not be the same as that configured in the Pal, if you are using an alias).

Data getSecureData(boolean clear)
⚠Deprecated since 11-17-2015. Use secure web pals. See Pal.getSecureWebUrl().

Returns the information entered by the user on a secure connection (see secure-data tag). This information is session only and will automatically be disposed, however pass clear=true to immediately clear it.

Data getSessionData(String key)

Returns the data stored in the session. Returns null if no data exists with the specified key.

String getSessionValue(String key)

Returns the specified value it it exists.

String getSubDomain()

Returns the subdomain of the http request host. If the URL is http://www.mysite.com/information/subject/page.html this returns www.

String getValue(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

String getXML(String name, String tag, String id)

Returns the xhtml content from the specified input field. Tag name to wrap the content with and ID are optional.

boolean isAjax()

Returns true if the request was made from an ajax call. Note that the ajax.js resource sends a header 'nxAjax'=true. If you use another AJAX library you must send this header for this method to return true.

boolean isPost()

Returns true if the request came from an HTTP POST (as opposed to GET).

String readBody()

Reads the body of the request. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.

  setCookie(String name, String value, boolean secure, int maxAge)

Sets the specified cookie. Set maxAge=0 to create a session cookie. maxAge is in seconds from now.

  setSessionData(String key, Data data)

Stores the data in the session. Max size allowed is 10K and max entries per session is 2.

  setSessionValue(String key, String value)

Sets the specified session value. Use null for the value to remove it from the session.

String toString()

Returns a description of this object.

Method Detail


Request clean()

Returns this request with clean mode enabled which removes all non ASCII characters and any control characters.

Returns:  Request

Since: 12-13-2022

top

clearSessionData()

Deletes all data objects set by setSessionData.

Since: 04-18-2012

top

clearSessionValues()

Deletes all values set by setSessionValue.

Since: 06-18-2020

top

deleteCookie(String name)

Deletes the specified cookie.

Parameters:

  • String   name

Since: 07-11-2008

top

deleteCookies()

Deletes all cookies.

Since: 07-11-2008

top

String get(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

Parameters:

  • String   key Required parameter.

Returns:  String

Since: 08-30-2018

top

String getAjaxTarget()

If set, returns the ajax-target attribute of the request.

Returns:  String

Since: 12-20-2017

top

String getCookie(String name)

Returns the specified cookie or null if no cookie exists.

Parameters:

  • String   name

Returns:  String

Since: 07-11-2008

top

Data getData()

Returns the Data object for this request. This will contain all the form field values posted from the client.

Returns:  Data

Since: 07-11-2008

top

String getDomain()

Returns the domain of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns www.mysite.com.

Returns:  String

Since: 12-22-2010

top

String getEncryptedValue(String key)

Returns the decrypted value for the specified input field. Returns null if no value exists or if the parameter is not encrypted.

Parameters:

  • String   key

Returns:  String

Since: 09-17-2009

top

String[] getEncryptedValues(String key)

Returns an array of decrypted values for the specified input field. Returns null if no values exist or if the parameter is not encrypted.

Parameters:

  • String   key

Returns:  String[]

Since: 09-17-2009

top

String getHTML(String name)

Returns the html content from the specified input field. Limit 5000 characters. Name limit is 80 characters.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80

Returns:  String

Since: 08-09-2010

top

String getHeader(String header)

Returns the specified header

Parameters:

  • String   header Required parameter.

Returns:  String

Since: 11-12-2018

top

PacketDataList getHeaders()

Returns all the headers as a datalist

Returns:  PacketDataList


DataList Name: headers
DataList Fields: name, value

Since: 01-10-2020

top

String getPage()

Returns the path and page of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns page.html.

Returns:  String

Since: 12-02-2009

top

String[] getParameterNames()

Returns an array of all parameters sent from the client.

Returns:  String[]

Since: 07-11-2008

top

String[] getParameterValues(String name)

Returns an array of all values of the specified parameter.

Parameters:

  • String   name

Returns:  String[]

Since: 07-11-2008

top

String getPath()

Returns the path of the http request. If the URL is http://www.mysite.com/information/subject/page.html this returns information/subject.

Returns:  String

Since: 12-02-2009

top

String getReferrer()

Returns the hostname of the referrer of the request.

Returns:  String

Since: 12-09-2009

top

String getRequestMethod()

Returns the http method.

Returns:  String

Since: 01-10-2020

top

String getRequestUrl()

Returns the url requested (which may not be the same as that configured in the Pal, if you are using an alias).

Returns:  String

Since: 12-09-2009

top

Data getSecureData(boolean clear)

Returns the information entered by the user on a secure connection (see secure-data tag). This information is session only and will automatically be disposed, however pass clear=true to immediately clear it.

Parameters:

  • boolean   clear

Returns:  Data

Since: 12-02-2009

This method has been deprecated since 11-17-2015. Use secure web pals. See Pal.getSecureWebUrl().

top

Data getSessionData(String key)

Returns the data stored in the session. Returns null if no data exists with the specified key.

Parameters:

  • String   key Required parameter.

Returns:  Data

Since: 04-18-2012

top

String getSessionValue(String key)

Returns the specified value it it exists.

Parameters:

  • String   key Required parameter.

Returns:  String

Since: 12-02-2009

top

String getSubDomain()

Returns the subdomain of the http request host. If the URL is http://www.mysite.com/information/subject/page.html this returns www.

Returns:  String

Since: 12-22-2010

top

String getValue(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

Parameters:

  • String   key

Returns:  String

Since: 07-11-2008

top

String getXML(String name, String tag, String id)

Returns the xhtml content from the specified input field. Tag name to wrap the content with and ID are optional.

Parameters:

  • String   name
  • String   tag
  • String   id

Returns:  String

Since: 05-12-2009

top

boolean isAjax()

Returns true if the request was made from an ajax call. Note that the ajax.js resource sends a header 'nxAjax'=true. If you use another AJAX library you must send this header for this method to return true.

Returns:  boolean

Since: 09-24-2010

top

boolean isPost()

Returns true if the request came from an HTTP POST (as opposed to GET).

Returns:  boolean

Since: 05-21-2009

top

String readBody()

Reads the body of the request. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.

Returns:  String

Since: 11-12-2018

top

setCookie(String name, String value, boolean secure, int maxAge)

Sets the specified cookie. Set maxAge=0 to create a session cookie. maxAge is in seconds from now.

Parameters:

  • String   name
  • String   value
  • boolean   secure
  • int   maxAge

Since: 07-11-2008

top

setSessionData(String key, Data data)

Stores the data in the session. Max size allowed is 10K and max entries per session is 2.

Parameters:

  • String   key Required parameter.
  • Data   data  - Pass null to remove from session.

Since: 04-18-2012

top

setSessionValue(String key, String value)

Sets the specified session value. Use null for the value to remove it from the session.

Parameters:

  • String   key Required parameter.
  • String   value

Since: 12-02-2009

top

String toString()

Returns a description of this object.

Returns:  String

Since: 07-11-2008

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM