< prev index next >
src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpExchange.java
Print this page
*** 114,126 ****
* @return the HttpContext
*/
public abstract HttpContext getHttpContext ();
/**
! * Ends this exchange by doing the following in sequence:<p><ol>
! * <li>close the request InputStream, if not already closed<p></li>
! * <li>close the response OutputStream, if not already closed. </li>
* </ol>
*/
public abstract void close () ;
/**
--- 114,126 ----
* @return the HttpContext
*/
public abstract HttpContext getHttpContext ();
/**
! * Ends this exchange by doing the following in sequence:<ol>
! * <li>close the request InputStream, if not already closed;</li>
! * <li>close the response OutputStream, if not already closed.</li>
* </ol>
*/
public abstract void close () ;
/**
*** 161,173 ****
/**
* Starts sending the response back to the client using the current set of response headers
* and the numeric response code as specified in this method. The response body length is also specified
* as follows. If the response length parameter is greater than zero, this specifies an exact
* number of bytes to send and the application must send that exact amount of data.
! * If the response length parameter is <code>zero</code>, then chunked transfer encoding is
* used and an arbitrary amount of data may be sent. The application terminates the
! * response body by closing the OutputStream. If response length has the value <code>-1</code>
* then no response body is being sent.
* <p>
* If the content-length response header has not already been set then
* this is set to the appropriate value depending on the response length parameter.
* <p>
--- 161,173 ----
/**
* Starts sending the response back to the client using the current set of response headers
* and the numeric response code as specified in this method. The response body length is also specified
* as follows. If the response length parameter is greater than zero, this specifies an exact
* number of bytes to send and the application must send that exact amount of data.
! * If the response length parameter is {@code zero}, then chunked transfer encoding is
* used and an arbitrary amount of data may be sent. The application terminates the
! * response body by closing the OutputStream. If response length has the value {@code -1}
* then no response body is being sent.
* <p>
* If the content-length response header has not already been set then
* this is set to the appropriate value depending on the response length parameter.
* <p>
*** 190,200 ****
*/
public abstract InetSocketAddress getRemoteAddress ();
/**
* Returns the response code, if it has already been set
! * @return the response code, if available. <code>-1</code> if not available yet.
*/
public abstract int getResponseCode ();
/**
* Returns the local address on which the request was received
--- 190,200 ----
*/
public abstract InetSocketAddress getRemoteAddress ();
/**
* Returns the response code, if it has already been set
! * @return the response code, if available. {@code -1} if not available yet.
*/
public abstract int getResponseCode ();
/**
* Returns the local address on which the request was received
*** 217,227 ****
* <p>
* Each Filter class will document the attributes which they make
* available.
* @param name the name of the attribute to retrieve
* @return the attribute object, or null if it does not exist
! * @throws NullPointerException if name is <code>null</code>
*/
public abstract Object getAttribute (String name) ;
/**
* Filter modules may store arbitrary objects with HttpExchange
--- 217,227 ----
* <p>
* Each Filter class will document the attributes which they make
* available.
* @param name the name of the attribute to retrieve
* @return the attribute object, or null if it does not exist
! * @throws NullPointerException if name is {@code null}
*/
public abstract Object getAttribute (String name) ;
/**
* Filter modules may store arbitrary objects with HttpExchange
*** 229,241 ****
* or the exchange handler may then access these objects.
* <p>
* Each Filter class will document the attributes which they make
* available.
* @param name the name to associate with the attribute value
! * @param value the object to store as the attribute value. <code>null</code>
* value is permitted.
! * @throws NullPointerException if name is <code>null</code>
*/
public abstract void setAttribute (String name, Object value) ;
/**
* Used by Filters to wrap either (or both) of this exchange's InputStream
--- 229,241 ----
* or the exchange handler may then access these objects.
* <p>
* Each Filter class will document the attributes which they make
* available.
* @param name the name to associate with the attribute value
! * @param value the object to store as the attribute value. {@code null}
* value is permitted.
! * @throws NullPointerException if name is {@code null}
*/
public abstract void setAttribute (String name, Object value) ;
/**
* Used by Filters to wrap either (or both) of this exchange's InputStream
*** 246,265 ****
* {@link java.io.OutputStream}. The streams provided to this
* call must wrap the original streams, and may be (but are not
* required to be) sub-classes of {@link java.io.FilterInputStream}
* and {@link java.io.FilterOutputStream}.
* @param i the filtered input stream to set as this object's inputstream,
! * or <code>null</code> if no change.
* @param o the filtered output stream to set as this object's outputstream,
! * or <code>null</code> if no change.
*/
public abstract void setStreams (InputStream i, OutputStream o);
/**
* If an authenticator is set on the HttpContext that owns this exchange,
* then this method will return the {@link HttpPrincipal} that represents
* the authenticated user for this HttpExchange.
! * @return the HttpPrincipal, or <code>null</code> if no authenticator is set.
*/
public abstract HttpPrincipal getPrincipal ();
}
--- 246,265 ----
* {@link java.io.OutputStream}. The streams provided to this
* call must wrap the original streams, and may be (but are not
* required to be) sub-classes of {@link java.io.FilterInputStream}
* and {@link java.io.FilterOutputStream}.
* @param i the filtered input stream to set as this object's inputstream,
! * or {@code null} if no change.
* @param o the filtered output stream to set as this object's outputstream,
! * or {@code null} if no change.
*/
public abstract void setStreams (InputStream i, OutputStream o);
/**
* If an authenticator is set on the HttpContext that owns this exchange,
* then this method will return the {@link HttpPrincipal} that represents
* the authenticated user for this HttpExchange.
! * @return the HttpPrincipal, or {@code null} if no authenticator is set.
*/
public abstract HttpPrincipal getPrincipal ();
}
< prev index next >