com.ptc.windchill.index.indexloader
Class IndexLoaderResponse

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          com.ptc.windchill.index.indexloader.IndexLoaderResponse

All Implemented Interfaces:

Cloneable, Map, Serializable

public class IndexLoaderResponse

extends Hashtable

This class is a carrier of response information back to the IndexLoader program. The object contains fields to store response header information, an output stream reference, and a target class and method.

Note that the headers must be set on the response prior to getting the response outputstream.

  Note: Three response headers are set by default:
        Protocol is set to HTTP/1.0;
        Status is set to 200 (OK); and
        Content-Type is set to text/plain.

        If you need to set other headers or change these defaults,
        you must do so in your response processing PRIOR to calling
        getOutputStream.
 

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.util.Hashtable

Field Summary

private boolean	headers_frozen
private boolean	headers_written
private OutputStream	out
private boolean	parent_is_servlet
private Object	servletRes
(package private) static boolean	VERBOSE
private static String	versionID

Fields inherited from class java.util.Hashtable

Constructor Summary

IndexLoaderResponse(javax.servlet.http.HttpServletResponse res)
Public constructor used by servlet

IndexLoaderResponse(OutputStream Out)
Public constructor used by CGI

Method Summary

boolean	containsHeader(String s) Checks if the response header is present.
OutputStream	getOutputStream() Called to get the output stream to write the data to.
void	setDateHeader(String s1, long date) Sets a date type response header.
void	setHeader(String s1, String s2) Sets a string type response header.
void	setIntHeader(String s1, int v1) Sets a int type response header.
void	setStatus(int v1) Sets a simple Status response header.
void	setStatus(int v1, String s1) Sets a Status response header.
void	writeHeaders(javax.servlet.http.HttpServletResponse ServletWriter) Causes all response headers presently set to be writen as appropriate using the servlet's header methods.
void	writeHeaders(OutputStream outputStream) Causes all response headers presently set to be writen as appropriate to the output stream of the CGI.

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

versionID

private static final String versionID

See Also:

Constant Field Values

parent_is_servlet

private boolean parent_is_servlet

headers_frozen

private boolean headers_frozen

headers_written

private boolean headers_written

servletRes

private Object servletRes

out

private OutputStream out

VERBOSE

static boolean VERBOSE

Constructor Detail

IndexLoaderResponse

public IndexLoaderResponse(javax.servlet.http.HttpServletResponse res)

Public constructor used by servlet

IndexLoaderResponse

public IndexLoaderResponse(OutputStream Out)

Public constructor used by CGI

Method Detail

getOutputStream

public OutputStream getOutputStream()

Called to get the output stream to write the data to. It also causes the response headers to be written out.

Returns:

OutputStream to which we write.

containsHeader

public boolean containsHeader(String s)

Checks if the response header is present.

Parameters:

s - String the header to search for.

Returns:

A boolean if the header is set.

setHeader

public void setHeader(String s1,
                      String s2)

Sets a string type response header.

Parameters:

s1 - String name of the header

s2 - String value to which header is set

setDateHeader

public void setDateHeader(String s1,
                          long date)

Sets a date type response header.

Parameters:

s1 - String name of the header

date - long value to which header is set value is milliseconds since the epoch.

setIntHeader

public void setIntHeader(String s1,
                         int v1)

Sets a int type response header.

Parameters:

s1 - String name of the header

v1 - int value to which header is set

setStatus

public void setStatus(int v1)

Sets a simple Status response header.

Parameters:

v1 - Integer Status code

setStatus

public void setStatus(int v1,
                      String s1)

Sets a Status response header.

Parameters:

v1 - Integer Status code

s1 - String Status reason code

writeHeaders

public void writeHeaders(javax.servlet.http.HttpServletResponse ServletWriter)

Causes all response headers presently set to be writen as appropriate using the servlet's header methods.

writeHeaders

public void writeHeaders(OutputStream outputStream)

Causes all response headers presently set to be writen as appropriate to the output stream of the CGI.