Appearance

API: request ​

Source: http/request.ts

The Request API under the HTTP module is responsible for managing standard HTTP request parameters, headers, cookies, and request metadata provided to server-side scripting services.

Usage ​

javascript
import { request, response } from "sdk/http";

let method = request.getMethod();

response.println("[Method]: " + method);
response.flush();
response.close();

Classes ​

Request ​

Represents the HTTP Request object available within a service execution
context. It provides access to HTTP metadata, query parameters, request
body content, cookies, and security information.

All functions in this class are static: no instance of Request
needs to be created.

Methods ​

isValid ​

  • isValid ():boolean

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

    @returns true if called in a valid HTTP request context, otherwise false.

getMethod ​

  • getMethod ():string

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

getRemoteUser ​

  • getRemoteUser ():string

    Returns the authenticated remote user name if available.

getPathInfo ​

  • getPathInfo ():string

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

getPathTranslated ​

  • getPathTranslated ():string

    Returns the translated file system path for the request.

getHeader ​

  • getHeader (name:string):string

    Returns the value of a specific HTTP header.

    @param name - Header name to retrieve.
    @returns The header value or undefined if not found.

isUserInRole ​

  • isUserInRole (role:string):boolean

    Checks whether the remote user has the given role.

    @param role - The role name to check.

getAttribute ​

  • getAttribute (name:string):string|undefined

    Returns a request attribute value previously associated with the request.

    @param name - The attribute name.
    @returns A string value or undefined.

getAuthType ​

  • getAuthType ():string

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

getCookies ​

  • getCookies ():Cookie[]

    Returns all cookies sent with the request.

    @returns An array of Cookie objects.

getAttributeNames ​

  • getAttributeNames ():string[]

    Returns all available request attribute names.

getCharacterEncoding ​

  • getCharacterEncoding ():string

    Returns the character encoding used in the request body.

getContentLength ​

  • getContentLength ():number

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

getHeaders ​

  • getHeaders (name:string):string[]

    Returns all values of a specific header.

    @param name - Header name to retrieve.

getContentType ​

  • getContentType ():string

    Returns the MIME content type of the request body.

getBytes ​

  • getBytes ():any[]

    Returns the raw request body as a byte array.

getText ​

  • getText ()void

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

json ​

  • json ():any}|undefined

    Returns the request body parsed as JSON if valid.

    @returns A JSON object or undefined if parsing fails.

getJSON ​

  • getJSON ():any}|undefined

    Same as json(); explicit form.

getParameter ​

  • getParameter (name:string):string

    Returns a request parameter value.

getParameters ​

  • getParameters ():string[]}

    Returns a map of request parameters to arrays of values.

getResourcePath ​

  • getResourcePath ():string

    Returns the allocated request resource path.

getHeaderNames ​

  • getHeaderNames ():string[]

    Returns all header names.

getParameterNames ​

  • getParameterNames ():string[]

    Returns all parameter names.

getParameterValues ​

  • getParameterValues (name:string):string[]

    Returns all values for a given parameter name.

getProtocol ​

  • getProtocol ():string

    Returns the HTTP protocol version.

getScheme ​

  • getScheme ():string

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

getContextPath ​

  • getContextPath ():string

    Returns the context path of the request.

getServerName ​

  • getServerName ():string

    Returns the server host name.

getServerPort ​

  • getServerPort ():number

    Returns the server port number.

getQueryString ​

  • getQueryString ():string

    Returns the full raw query string.

getQueryParametersMap ​

  • getQueryParametersMap ():string|string[]}

    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.

getRemoteAddress ​

  • getRemoteAddress ():string

    Returns the remote client IP address.

getRemoteHost ​

  • getRemoteHost ():string

    Returns the remote client host name.

setAttribute ​

  • setAttribute (name:string, value:string):void

    Assigns a new attribute to the request.

removeAttribute ​

  • removeAttribute (name:string):void

    Removes an attribute from the request.

getLocale ​

  • getLocale ():any

    Returns the client locale preferences.

getRequestURI ​

  • getRequestURI ():string

    Returns the full request URI.

isSecure ​

  • isSecure ():boolean

    Returns true if the request was made over HTTPS.

getRequestURL ​

  • getRequestURL ():string

    Returns the full request URL including protocol and host.

getServicePath ​

  • getServicePath ():string

    Returns the internal service path for routing.

getRemotePort ​

  • getRemotePort ():number

    Returns the remote client port number.

getLocalName ​

  • getLocalName ():string

    Returns the local network host name.

getLocalAddress ​

  • getLocalAddress ():string

    Returns the local IP address.

getLocalPort ​

  • getLocalPort ():number

    Returns the server local port number handling the request.

getInputStream ​

  • getInputStream ():InputStream

    Returns the request body as a binary input stream.

    Useful for processing binary uploads.