http/request

Documentation

• source: http/request.ts

Overview

Classes

Request

isValid()

Determines whether the current thread is handling a valid HTTP request.

static isValid(): boolean;

Returns

• Type: boolean
• Description: `true` if called in a valid HTTP request context, otherwise `false`.

getMethod()

Returns the HTTP method (GET, POST, PUT, DELETE, etc.).

static getMethod(): string;

Returns

• Type: string
• Description:

getRemoteUser()

Returns the authenticated remote user name if available.

static getRemoteUser(): string;

Returns

• Type: string
• Description:

getPathInfo()

Returns the portion of the request path following the servlet path.

static getPathInfo(): string;

Returns

• Type: string
• Description:

getPathTranslated()

Returns the translated file system path for the request.

static getPathTranslated(): string;

Returns

• Type: string
• Description:

getHeader()

Returns the value of a specific HTTP header.

static getHeader(name: string): string;

Parameter	Type	Description
name	string	Header name to retrieve.

Returns

• Type: string
• Description: The header value or `undefined` if not found.

isUserInRole()

Checks whether the remote user has the given role.

static isUserInRole(role: string): boolean;

Parameter	Type	Description
role	string	The role name to check.

Returns

• Type: boolean
• Description:

getAttribute()

Returns a request attribute value previously associated with the request.

static getAttribute(name: string): string;

Parameter	Type	Description
name	string	The attribute name.

Returns

• Type: string
• Description: A string value or `undefined`.

getAuthType()

Returns the authentication type if known (BASIC, CLIENT_CERT, etc.).

static getAuthType(): string;

Returns

• Type: string
• Description:

getCookies()

Returns all cookies sent with the request.

static getCookies(): void;

Returns

• Type: void
• Description: An array of Cookie objects.

getAttributeNames()

Returns all available request attribute names.

static getAttributeNames(): void;

Returns

• Type: void
• Description:

getCharacterEncoding()

Returns the character encoding used in the request body.

static getCharacterEncoding(): string;

Returns

• Type: string
• Description:

getContentLength()

Returns the size of the request body in bytes, if known.

static getContentLength(): number;

Returns

• Type: number
• Description:

getHeaders()

Returns all values of a specific header.

static getHeaders(name: string): void;

Parameter	Type	Description
name	string	Header name to retrieve.

Returns

• Type: void
• Description:

getContentType()

Returns the MIME content type of the request body.

static getContentType(): string;

Returns

• Type: string
• Description:

getBytes()

Returns the raw request body as a byte array.

static getBytes(): void;

Returns

• Type: void
• Description:

getText()

Returns the request body as text. This is computed once and cached.

static getText(): string;

Returns

• Type: string
• Description:

json()

Returns the request body parsed as JSON if valid.

static json(): void;

Returns

• Type: void
• Description: A JSON object or `undefined` if parsing fails.

getJSON()

Same as json(); explicit form.

static getJSON(): void;

Returns

• Type: void
• Description:

getParameter()

Returns a request parameter value.

static getParameter(name: string): string;

Parameter	Type	Description
name	string

Returns

• Type: string
• Description:

getParameters()

Returns a map of request parameters to arrays of values.

static getParameters(): void;

Returns

• Type: void
• Description:

getResourcePath()

Returns the allocated request resource path.

static getResourcePath(): string;

Returns

• Type: string
• Description:

getHeaderNames()

Returns all header names.

static getHeaderNames(): void;

Returns

• Type: void
• Description:

getParameterNames()

Returns all parameter names.

static getParameterNames(): void;

Returns

• Type: void
• Description:

getParameterValues()

Returns all values for a given parameter name.

static getParameterValues(name: string): void;

Parameter	Type	Description
name	string

Returns

• Type: void
• Description:

getProtocol()

Returns the HTTP protocol version.

static getProtocol(): string;

Returns

• Type: string
• Description:

getScheme()

Returns the transport scheme (e.g., http, https).

static getScheme(): string;

Returns

• Type: string
• Description:

getContextPath()

Returns the context path of the request.

static getContextPath(): string;

Returns

• Type: string
• Description:

getServerName()

Returns the server host name.

static getServerName(): string;

Returns

• Type: string
• Description:

getServerPort()

Returns the server port number.

static getServerPort(): number;

Returns

• Type: number
• Description:

getQueryString()

Returns the full raw query string.

static getQueryString(): string;

Returns

• Type: string
• Description:

getQueryParametersMap()

Parses the query string and returns a map of parameter keys to values. If the same key appears multiple times, values are collected into arrays.

static getQueryParametersMap(): void;

Returns

• Type: void
• Description:

getRemoteAddress()

Returns the remote client IP address.

static getRemoteAddress(): string;

Returns

• Type: string
• Description:

getRemoteHost()

Returns the remote client host name.

static getRemoteHost(): string;

Returns

• Type: string
• Description:

setAttribute()

Assigns a new attribute to the request.

static setAttribute(name: string, value: string): void;

Parameter	Type	Description
name	string
value	string

Returns

• Type: void
• Description:

removeAttribute()

Removes an attribute from the request.

static removeAttribute(name: string): void;

Parameter	Type	Description
name	string

Returns

• Type: void
• Description:

getLocale()

Returns the client locale preferences.

static getLocale(): any;

Returns

• Type: any
• Description:

getRequestURI()

Returns the full request URI.

static getRequestURI(): string;

Returns

• Type: string
• Description:

isSecure()

Returns `true` if the request was made over HTTPS.

static isSecure(): boolean;

Returns

• Type: boolean
• Description:

getRequestURL()

Returns the full request URL including protocol and host.

static getRequestURL(): string;

Returns

• Type: string
• Description:

getServicePath()

Returns the internal service path for routing.

static getServicePath(): string;

Returns

• Type: string
• Description:

getRemotePort()

Returns the remote client port number.

static getRemotePort(): number;

Returns

• Type: number
• Description:

getLocalName()

Returns the local network host name.

static getLocalName(): string;

Returns

• Type: string
• Description:

getLocalAddress()

Returns the local IP address.

static getLocalAddress(): string;

Returns

• Type: string
• Description:

getLocalPort()

Returns the server local port number handling the request.

static getLocalPort(): number;

Returns

• Type: number
• Description:

getInputStream()

Returns the request body as a binary input stream.

Useful for processing binary uploads.

static getInputStream(): InputStream;

Returns

• Type: InputStream
• Description: