Response

Overview

Module

• package: org.eclipse.dirigible.sdk.http
• source: http/Response.java

Writes the outbound HTTP response bound to the calling thread — status, headers, cookies, body. Useful from @Controller methods that want to stream bytes, set explicit status codes, or send 30x redirects.

Most controllers can rely on the dispatcher's automatic Jackson serialization of return values and reach for this class only at the edges (file downloads, binary responses, manual error shapes). getNative() hands back the underlying HttpServletResponse when you need a Servlet-only method.

Key Features:

• Thread-bound: All methods operate on the response bound to the current thread.
• Servlet Escape Hatch: getNative() exposes the underlying HttpServletResponse.
• Convenient Body Helpers: print, println, and write cover the common cases of writing text or binary bytes; getOutputStream() is available for streaming.

Example Usage:

import org.eclipse.dirigible.sdk.http.Response;

Response.setStatus(201);
Response.setContentType("application/json");
Response.setHeader("Location", "/services/java/orders/42");
Response.print("{\"id\":42}");
Response.flush();

Methods

getNative()

Returns the underlying Servlet response.

public static HttpServletResponse getNative();

Returns

• Type: jakarta.servlet.http.HttpServletResponse

isValid()

Returns whether an HTTP response is bound to the current thread.

public static boolean isValid();

Returns

• Type: boolean

print()

Writes the given text or object to the response body.

public static void print(String text);
public static void print(Object o);

Parameter	Type	Description
text	String	Text to write.
o	Object	Object to write (converted via toString()).

println()

Writes the given text followed by a newline.

public static void println(String text);

Parameter	Type	Description
text	String	Text to write.

write()

Writes raw bytes or a string to the response body.

public static void write(byte[] bytes);
public static void write(String input);

Parameter	Type	Description
bytes	byte[]	Bytes to write.
input	String	String to write.

isCommitted()

Returns whether the response has been committed (headers sent).

public static boolean isCommitted();

Returns

• Type: boolean

setContentType()

Sets the response Content-Type header.

public static void setContentType(String contentType);

Parameter	Type	Description
contentType	String	A media-type value.

getContentType()

Returns the response Content-Type header.

public static String getContentType();

Returns

• Type: String

flush()

Flushes any buffered output to the client.

public static void flush();

close()

Closes the response output stream.

public static void close();

addCookie()

Adds a cookie to the response.

public static void addCookie(String cookieJson);

Parameter	Type	Description
cookieJson	String	A JSON document describing the cookie (name, value, path, maxAge, domain, secure, httpOnly, …).

containsHeader()

Returns whether the response already contains the named header.

public static boolean containsHeader(String name);

Parameter	Type	Description
name	String	Header name.

Returns

• Type: boolean

encodeURL()

Encodes the given URL for use in this response, rewriting it to include the session ID if necessary.

public static String encodeURL(String url);

Parameter	Type	Description
url	String	URL to encode.

Returns

• Type: String

encodeRedirectURL()

Encodes the given URL for use in a sendRedirect call.

public static String encodeRedirectURL(String url);

Parameter	Type	Description
url	String	URL to encode.

Returns

• Type: String

sendError()

Sends an error response with the given status code (and optional message).

public static void sendError(int code, String message) throws IOException;
public static void sendError(int code) throws IOException;

Parameter	Type	Description
code	int	HTTP status code.
message	String	Optional error message.

sendRedirect()

Sends a temporary redirect (302) response to the given location.

public static void sendRedirect(String location) throws IOException;

Parameter	Type	Description
location	String	The redirect URL.

setCharacterEncoding()

Sets the response character encoding.

public static void setCharacterEncoding(String charset);

Parameter	Type	Description
charset	String	Charset name (e.g. UTF-8).

getCharacterEncoding()

Returns the response character encoding.

public static String getCharacterEncoding();

Returns

• Type: String

setContentLength()

Sets the Content-Length header.

public static void setContentLength(int length);

Parameter	Type	Description
length	int	Body length in bytes.

setHeader()

Sets (replaces) a response header.

public static void setHeader(String name, String value);

Parameter	Type	Description
name	String	Header name.
value	String	Header value.

addHeader()

Adds a response header (allowing multiple values).

public static void addHeader(String name, String value);

Parameter	Type	Description
name	String	Header name.
value	String	Header value.

getHeader()

Returns the value of a response header.

public static String getHeader(String name);

Parameter	Type	Description
name	String	Header name.

Returns

• Type: String

getHeaders()

Returns all values for a response header.

public static String getHeaders(String name);

Parameter	Type	Description
name	String	Header name.

Returns

• Type: String
• Description: A JSON-encoded list of header values.

getHeaderNames()

Returns the names of all response headers.

public static String getHeaderNames();

Returns

• Type: String
• Description: A JSON-encoded list of header names.

setStatus()

Sets the HTTP status code.

public static void setStatus(int code);

Parameter	Type	Description
code	int	HTTP status code.

reset()

Resets buffered output, headers, and status code.

public static void reset();

setLocale()

Sets the response locale.

public static void setLocale(String language);

Parameter	Type	Description
language	String	Language tag (e.g. en, de-DE).

getLocale()

Returns the response locale.

public static String getLocale();

Returns

• Type: String

getOutputStream()

Returns the raw response output stream — useful for streaming binary responses.

public static OutputStream getOutputStream() throws IOException;

Returns

• Type: java.io.OutputStream