docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 6.1System Developer Manual JavaReference for Roxen Java classes
Copyright © 2018, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com

   

AbstractLocationModule
ExperimentalModule
FileExtensionModule
Frame
HTTP
LastResortModule
LocationModule
Module
ParserModule
ProviderModule
RXML
RXML.Backtrace
RoxenClassLoader
RoxenConfiguration
RoxenFileResponse
RoxenLib
RoxenRXMLResponse
RoxenRequest
RoxenResponse
RoxenStringResponse
SecurityModule
SimpleTagCaller
UniqueModule

RoxenRequest

: Class RoxenRequest

com.roxen.roxen
Class RoxenRequest


java.lang.Object
  |
  +--com.roxen.roxen.RoxenRequest
public class RoxenRequest
extends java.lang.Object

A class representing requests from clients.

Field Summary
 java.lang.String clientprot
          The protocol actually requested by the client
 RoxenConfiguration conf
          The virtual server which is handling this request
 java.lang.String method
          The method of the request, such as "GET" or "POST"
 java.lang.String notQuery
          The requested URL path, without any query part
 java.lang.String prot
          The protocol used when talking to the client, such as "HTTP/1.1" or "FTP"
 java.lang.String query
          The query part of the requested URL path, if any
 java.lang.String raw
          The exact text of the client's request, if available
 java.lang.String rawURL
          The requested URL path, exactly as sent by the client
 java.lang.String realfile
          The filename of the file in the host filesystem used to satisfy this request, if any
 java.lang.String remoteaddr
          The IP address of the client system
 long time
          Time of the request, number of milliseconds since January 1, 1970, 00:00:00 GMT.
 java.lang.String virtfile
          The pathname of the resource in the namespace of the virtual server used to satisfy this request, if any
 
Method Summary
 void cache(int sec)
          Sets maximum cache time for this request
 RoxenConfiguration configuration()
          Returns the configuration object of the virtual server by which this request is handled
 java.util.Map cookies()
          Returns a Map with all the cookies of the request
 void noCache()
          Disable caching for this request
 java.util.Set pragma()
          Returns a Set with all pragmas sent by the client
 java.util.Set prestate()
          Returns a Set with all prestates sent by the client
 java.util.Map requestHeaders()
          Returns a Map with all the headers of the request
 java.util.Set supports()
          Returns a Set with all known supported features of the client
 java.util.Map variables()
          Returns a Map with all the query variables of the request
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

conf


public final RoxenConfiguration conf
The virtual server which is handling this request

rawURL


public final java.lang.String rawURL
The requested URL path, exactly as sent by the client

prot


public final java.lang.String prot
The protocol used when talking to the client, such as "HTTP/1.1" or "FTP"

clientprot


public final java.lang.String clientprot
The protocol actually requested by the client

method


public final java.lang.String method
The method of the request, such as "GET" or "POST"

realfile


public final java.lang.String realfile
The filename of the file in the host filesystem used to satisfy this request, if any

virtfile


public final java.lang.String virtfile
The pathname of the resource in the namespace of the virtual server used to satisfy this request, if any

raw


public final java.lang.String raw
The exact text of the client's request, if available

query


public final java.lang.String query
The query part of the requested URL path, if any

notQuery


public final java.lang.String notQuery
The requested URL path, without any query part

remoteaddr


public final java.lang.String remoteaddr
The IP address of the client system

time


public final long time
Time of the request, number of milliseconds since January 1, 1970, 00:00:00 GMT.
Method Detail

configuration


public final RoxenConfiguration configuration()
Returns the configuration object of the virtual server by which this request is handled
Returns:
the configuration

variables


public java.util.Map variables()
Returns a Map with all the query variables of the request
Returns:
the query variables

requestHeaders


public java.util.Map requestHeaders()
Returns a Map with all the headers of the request
Returns:
the headers

cookies


public java.util.Map cookies()
Returns a Map with all the cookies of the request
Returns:
the cookies

supports


public java.util.Set supports()
Returns a Set with all known supported features of the client
Returns:
the feature set

pragma


public java.util.Set pragma()
Returns a Set with all pragmas sent by the client
Returns:
the pragmas

prestate


public java.util.Set prestate()
Returns a Set with all prestates sent by the client
Returns:
the prestates

cache


public void cache(int sec)
Sets maximum cache time for this request
Parameters:
sec - the number of seconds to cache

noCache


public void noCache()
Disable caching for this request