Package com.oorian.jakarta

Class JakartaHttpRequest

java.lang.Object

com.oorian.jakarta.JakartaHttpRequest

All Implemented Interfaces:

OorianHttpRequest

public class JakartaHttpRequest
extends Object
implements OorianHttpRequest

Adapter that wraps a HttpServletRequest to implement the framework-agnostic OorianHttpRequest interface.

This class is used by the thin Jakarta library to bridge between the servlet container and the Oorian common library.

Since:

2.1

Version:

1.0

Author:

Oorian Framework

See Also:

• OorianHttpRequest

Constructor Summary

Constructors

Constructor	Description
JakartaHttpRequest(jakarta.servlet.http.HttpServletRequest request)	Creates a new adapter wrapping the given servlet request.

Method Summary

Modifier and Type	Method	Description
String	changeSessionId()	Changes the session ID associated with this request.
Object	getAttribute(String name)	Returns the value of the specified request attribute.
String	getCharacterEncoding()	Returns the character encoding of the request body.
int	getContentLength()	Returns the length of the request body in bytes, or -1 if not known.
String	getContentType()	Returns the content type of the request body.
String	getContextPath()	Returns the context path of the web application.
OorianCookie[]	getCookies()	Returns the cookies sent with this request.
jakarta.servlet.http.HttpServletRequest	getDelegate()	Returns the underlying Jakarta servlet request.
String	getHeader(String name)	Returns the value of the specified request header.
Enumeration<String>	getHeaderNames()	Returns an enumeration of all header names in this request.
Enumeration<String>	getHeaders(String name)	Returns all values of the specified request header as an enumeration.
InputStream	getInputStream()	Returns an input stream for reading the request body as binary data.
Locale	getLocale()	Returns the preferred locale of the client, based on the Accept-Language header.
String	getMethod()	Returns the HTTP method of this request (GET, POST, PUT, DELETE, etc.).
String	getParameter(String name)	Returns the value of a request parameter.
Map<String,String[]>	getParameterMap()	Returns a map of all request parameters.
Collection<OorianUploadPart>	getParts()	Returns the multipart parts of this request.
String	getPathInfo()	Returns the path info portion of the request URL.
String	getQueryString()	Returns the query string portion of the request URL.
BufferedReader	getReader()	Returns a BufferedReader for reading the request body as character data.
String	getRemoteAddr()	Returns the IP address of the client that sent the request.
String	getRequestURI()	Returns the request URI.
StringBuffer	getRequestURL()	Returns the request URL as a StringBuffer.
String	getScheme()	Returns the scheme (protocol) used for the request (e.g., "http" or "https").
String	getServerName()	Returns the name of the server that received the request.
int	getServerPort()	Returns the port number on which the request was received.
String	getServletPath()	Returns the servlet path portion of the request URL.
OorianHttpSession	getSession(boolean create)	Returns the session associated with this request.
boolean	isSecure()	Returns whether this request was made using a secure channel (HTTPS).
void	setAttribute(String name, Object value)	Sets a request attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JakartaHttpRequest

public JakartaHttpRequest(jakarta.servlet.http.HttpServletRequest request)

Creates a new adapter wrapping the given servlet request.

Parameters:

request - The Jakarta servlet request to wrap.

Method Details

getHeader

public String getHeader(String name)

Description copied from interface: OorianHttpRequest

Returns the value of the specified request header.

Specified by:

getHeader in interface OorianHttpRequest

Parameters:

name - the header name

Returns:

the header value, or null if not present

getPathInfo

public String getPathInfo()

Description copied from interface: OorianHttpRequest

Returns the path info portion of the request URL.

Specified by:

getPathInfo in interface OorianHttpRequest

Returns:

the path info, or null if none

getQueryString

public String getQueryString()

Description copied from interface: OorianHttpRequest

Returns the query string portion of the request URL.

Specified by:

getQueryString in interface OorianHttpRequest

Returns:

the query string, or null if none

getRequestURL

public StringBuffer getRequestURL()

Description copied from interface: OorianHttpRequest

Returns the request URL as a StringBuffer.

Specified by:

getRequestURL in interface OorianHttpRequest

Returns:

the request URL

getRequestURI

public String getRequestURI()

Description copied from interface: OorianHttpRequest

Returns the request URI.

Specified by:

getRequestURI in interface OorianHttpRequest

Returns:

the request URI

getServletPath

public String getServletPath()

Description copied from interface: OorianHttpRequest

Returns the servlet path portion of the request URL.

Specified by:

getServletPath in interface OorianHttpRequest

Returns:

the servlet path

getParameter

public String getParameter(String name)

Description copied from interface: OorianHttpRequest

Returns the value of a request parameter.

Specified by:

getParameter in interface OorianHttpRequest

Parameters:

name - the parameter name

Returns:

the parameter value, or null if not present

getParameterMap

public Map<String,String[]> getParameterMap()

Description copied from interface: OorianHttpRequest

Returns a map of all request parameters.

Specified by:

getParameterMap in interface OorianHttpRequest

Returns:

the parameter map

getContentType

public String getContentType()

Description copied from interface: OorianHttpRequest

Returns the content type of the request body.

Specified by:

getContentType in interface OorianHttpRequest

Returns:

the content type, or null if not specified

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: OorianHttpRequest

Returns the character encoding of the request body.

Specified by:

getCharacterEncoding in interface OorianHttpRequest

Returns:

the character encoding, or null if not specified

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: OorianHttpRequest

Returns the IP address of the client that sent the request.

Specified by:

getRemoteAddr in interface OorianHttpRequest

Returns:

the remote address

getContextPath

public String getContextPath()

Description copied from interface: OorianHttpRequest

Returns the context path of the web application.

Specified by:

getContextPath in interface OorianHttpRequest

Returns:

the context path

getCookies

public OorianCookie[] getCookies()

Description copied from interface: OorianHttpRequest

Returns the cookies sent with this request.

Specified by:

getCookies in interface OorianHttpRequest

Returns:

an array of cookies, or null if no cookies were sent

getParts

public Collection<OorianUploadPart> getParts()
                                      throws IOException

Description copied from interface: OorianHttpRequest

Returns the multipart parts of this request.

Specified by:

getParts in interface OorianHttpRequest

Returns:

a collection of upload parts

Throws:

IOException - if an I/O error occurs

getSession

public OorianHttpSession getSession(boolean create)

Description copied from interface: OorianHttpRequest

Returns the session associated with this request.

Specified by:

getSession in interface OorianHttpRequest

Parameters:

create - whether to create a new session if one doesn't exist

Returns:

the web session, or null if create is false and no session exists

getServerName

public String getServerName()

Description copied from interface: OorianHttpRequest

Returns the name of the server that received the request.

Specified by:

getServerName in interface OorianHttpRequest

Returns:

the server name

getMethod

public String getMethod()

Description copied from interface: OorianHttpRequest

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

Specified by:

getMethod in interface OorianHttpRequest

Returns:

the HTTP method name

getReader

public BufferedReader getReader()
                         throws IOException

Description copied from interface: OorianHttpRequest

Returns a BufferedReader for reading the request body as character data.

Specified by:

getReader in interface OorianHttpRequest

Returns:

a BufferedReader for reading the request body

Throws:

IOException - if an I/O error occurs

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: OorianHttpRequest

Returns an input stream for reading the request body as binary data.

Specified by:

getInputStream in interface OorianHttpRequest

Returns:

the input stream

Throws:

IOException - if an I/O error occurs

getScheme

public String getScheme()

Description copied from interface: OorianHttpRequest

Returns the scheme (protocol) used for the request (e.g., "http" or "https").

Specified by:

getScheme in interface OorianHttpRequest

Returns:

the scheme

getServerPort

public int getServerPort()

Description copied from interface: OorianHttpRequest

Returns the port number on which the request was received.

Specified by:

getServerPort in interface OorianHttpRequest

Returns:

the server port

isSecure

public boolean isSecure()

Description copied from interface: OorianHttpRequest

Returns whether this request was made using a secure channel (HTTPS).

Specified by:

isSecure in interface OorianHttpRequest

Returns:

true if the request is secure

getHeaderNames

public Enumeration<String> getHeaderNames()

Description copied from interface: OorianHttpRequest

Returns an enumeration of all header names in this request.

Specified by:

getHeaderNames in interface OorianHttpRequest

Returns:

an enumeration of header names

getHeaders

public Enumeration<String> getHeaders(String name)

Description copied from interface: OorianHttpRequest

Returns all values of the specified request header as an enumeration.

Specified by:

getHeaders in interface OorianHttpRequest

Parameters:

name - the header name

Returns:

an enumeration of header values

getContentLength

public int getContentLength()

Description copied from interface: OorianHttpRequest

Returns the length of the request body in bytes, or -1 if not known.

Specified by:

getContentLength in interface OorianHttpRequest

Returns:

the content length, or -1

getAttribute

public Object getAttribute(String name)

Description copied from interface: OorianHttpRequest

Returns the value of the specified request attribute.

Specified by:

getAttribute in interface OorianHttpRequest

Parameters:

name - the attribute name

Returns:

the attribute value, or null if not set

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from interface: OorianHttpRequest

Sets a request attribute.

Specified by:

setAttribute in interface OorianHttpRequest

Parameters:

name - the attribute name

value - the attribute value

getLocale

public Locale getLocale()

Description copied from interface: OorianHttpRequest

Returns the preferred locale of the client, based on the Accept-Language header.

Specified by:

getLocale in interface OorianHttpRequest

Returns:

the preferred locale

changeSessionId

public String changeSessionId()

Description copied from interface: OorianHttpRequest

Changes the session ID associated with this request.

This method generates a new session ID for the current session while preserving all session attributes. It is used for session fixation protection after authentication.

Specified by:

changeSessionId in interface OorianHttpRequest

Returns:

the new session ID

getDelegate

public jakarta.servlet.http.HttpServletRequest getDelegate()

Returns the underlying Jakarta servlet request.

Returns:

The wrapped HttpServletRequest.