Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> tripi >> [ asp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.tripi.asp
Class Response  

java.lang.Object
  com.tripi.asp.Response

---

public class Response

extends java.lang.Object

ASP "Response" object. This object handles communication from ASP back to the client. Implementation state:

• Cookies - Implemented.
• Buffer - Implemented
• CacheControl - Implemented
• Charset - Implemented
• ContentType - Implemented
• Expires - Implementes, NOTE Expires is not updated properly when ExpiresAbsolute is used.
• ExpiresAbsolute - Fully implemented.
• IsClientConnected - TODO Not implemented.
• PICS - TODO Not implemented.
• Status - Fully implemented.
• AddHeader - Fully supported.
• AppendToLog - TODO Not implemented.
• BinaryWrite - Fully supported.
• Clear - Implemented.
• End - Implemented.
• Flush - Implemented.
• Redirect - Implemented.
• Write - Implemented.

Version:

0.9

---

Nested Class Summary
class	Response.CookieJar           Cookie Jar class

 

Field Summary
(package private)  AspDate	_expiryDate           Current expiry string.
(package private)  int	_expiryMinutes           Current expiry time, in minutes.
java.lang.String	cacheControl           Cache-control setting
java.lang.String	charset           Charset setting
java.lang.String	contentType           Content type setting
Response.CookieJar	Cookies           Cookie jar to hold cookies to be sent to the client.
(package private)  org.apache.log4j.Category	DBG           Log4j debugging object
(package private)  javax.servlet.http.HttpServletResponse	response           JSDK servlet response object
(package private)  boolean	sentHeaders           Have the headers been sent?
(package private)  java.lang.StringBuffer	stringBuf           Buffer for when Buffer = TRUE.

 

Constructor Summary

Response(javax.servlet.http.HttpServletResponse response)           Constructor.

 

Method Summary
void	AddHeader(java.lang.String name, java.lang.String value)           ASP-accessible function to add a header to the response stream.
void	BinaryWrite(byte[] arr)           This ASP-accessible BinaryWrite function writes binary data to the output stream.
boolean	Buffer()           This ASP-accessible function obtains the buffer status
void	Buffer(boolean bBuffer)           This ASP-accessible function acts as the ASP field 'buffer', which enables or disables buffering.
void	Clear()           The ASP-accessible Clear function clears any buffered text.
void	End()           The ASP-accessible End function ends the current ASP script immediately.
int	Expires()           This ASP-accessible function obtains the number of minutes the expiry time is set to.
void	Expires(int minutes)           This ASP-accessible function sets the expiry time to the specified number of minutes from the current date/time.
AspDate	ExpiresAbsolute()           This ASP-accessible function obtains the number of minutes the expiry time is set to.
void	ExpiresAbsolute(AspDate date)           This ASP-accessible function sets the expiry time to the specified absolute date.
void	Flush()           ASP-accessible function to output any buffered text to the client.
javax.servlet.http.HttpServletResponse	getHttpServletResponse()           This unsupported ASP-accessible function obtains the HTTP response object that this Response object points to.
void	Redirect(java.lang.String redir)           ASP-accessible function to redirect the user to a different URL.
(package private)  void	sendHeaders()           Internal function to send the headers.
void	Status(int value)           ASP-accessible function to set the status for this request.
void	Write(java.lang.String str)           ASP-accessible function to output text to the client.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

DBG

org.apache.log4j.Category DBG

Log4j debugging object

---

response

javax.servlet.http.HttpServletResponse response

JSDK servlet response object

---

stringBuf

java.lang.StringBuffer stringBuf

Buffer for when Buffer = TRUE. When buffering is enabled, stringBuf != null, and when buffering is disabled, stringBuf == null.

---

sentHeaders

boolean sentHeaders

Have the headers been sent?

---

Cookies

public Response.CookieJar Cookies

Cookie jar to hold cookies to be sent to the client.

---

cacheControl

public java.lang.String cacheControl

Cache-control setting

---

contentType

public java.lang.String contentType

Content type setting

---

charset

public java.lang.String charset

Charset setting

---

_expiryDate

AspDate _expiryDate

Current expiry string. Prepended with an underscore to keep it from being accessed within ASP.

---

_expiryMinutes

int _expiryMinutes

Current expiry time, in minutes.

Constructor Detail

Response

public Response(javax.servlet.http.HttpServletResponse response)

Constructor.

Method Detail

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

This unsupported ASP-accessible function obtains the HTTP response object that this Response object points to.

---

Write

public void Write(java.lang.String str)
           throws java.io.IOException,
                  AspException

ASP-accessible function to output text to the client.

---

Flush

public void Flush()
           throws java.io.IOException,
                  AspException

ASP-accessible function to output any buffered text to the client.

---

Redirect

public void Redirect(java.lang.String redir)
              throws java.io.IOException,
                     AspException

ASP-accessible function to redirect the user to a different URL.

---

Buffer

public void Buffer(boolean bBuffer)
            throws java.io.IOException,
                   AspException

This ASP-accessible function acts as the ASP field 'buffer', which enables or disables buffering.

---

Buffer

public boolean Buffer()

This ASP-accessible function obtains the buffer status

---

Clear

public void Clear()
           throws AspException

The ASP-accessible Clear function clears any buffered text.

---

End

public void End()
         throws AspException

The ASP-accessible End function ends the current ASP script immediately.

---

Expires

public void Expires(int minutes)
             throws AspException

This ASP-accessible function sets the expiry time to the specified number of minutes from the current date/time.

---

Expires

public int Expires()

This ASP-accessible function obtains the number of minutes the expiry time is set to.

---

ExpiresAbsolute

public void ExpiresAbsolute(AspDate date)
                     throws AspException

This ASP-accessible function sets the expiry time to the specified absolute date.

---

ExpiresAbsolute

public AspDate ExpiresAbsolute()

This ASP-accessible function obtains the number of minutes the expiry time is set to.

---

BinaryWrite

public void BinaryWrite(byte[] arr)
                 throws AspException,
                        java.io.IOException

This ASP-accessible BinaryWrite function writes binary data to the output stream. This function assumes it's being called with an array of Chars.

---

sendHeaders

void sendHeaders()
           throws AspException

Internal function to send the headers.

---

Status

public void Status(int value)

ASP-accessible function to set the status for this request.

---

AddHeader

public void AddHeader(java.lang.String name,
                      java.lang.String value)

ASP-accessible function to add a header to the response stream. This function will not overwrite a header, it will add a new one to the response stream.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> tripi >> [ asp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---