06 response-headers

© 2010 Marty Hall

Generating the Server gResponse: HTTP

Response HeadersResponse HeadersOriginals of Slides and Source Code for Examples:

http://courses.coreservlets.com/Course-Materials/csajsp2.html

Customized Java EE Training: http://courses.coreservlets.com/Servlets, JSP, JSF 2.0, Struts, Ajax, GWT 2.0, Spring, Hibernate, SOAP & RESTful Web Services, Java 6.

Developed and taught by well-known author and developer. At public venues or onsite at your location.2

p j p

© 2010 Marty Hall

For live Java EE training, please see training courses at http://courses.coreservlets.com/. at http://courses.coreservlets.com/.

Servlets, JSP, Struts, JSF 1.x, JSF 2.0, Ajax (with jQuery, Dojo, Prototype, Ext-JS, Google Closure, etc.), GWT 2.0 (with GXT),

Java 5, Java 6, SOAP-based and RESTful Web Services, Spring, gHibernate/JPA, and customized combinations of topics.

Taught by the author of Core Servlets and JSP, More Servlets and JSP and this tutorial Available at public


Developed and taught by well-known author and developer. At public venues or onsite at your location.

Servlets and JSP, and this tutorial. Available at public venues, or customized versions can be held on-site at your

organization. Contact [email protected] for details.

Agenda

• Format of the HTTP response• Setting response headers• Understanding what response

headers are good for• Building Excel spread sheets• Generating JPEG images dynamically• Sending incremental updates

to the browser

4

HTTP Request/Responseq p

• Request • Response

GET /servlet/SomeName HTTP/1.1Host: ...

HTTP/1.1 200 OKContent-Type: text/html

Header2: ......HeaderN:

Content Type: text/htmlHeader2: ......HeaderN:HeaderN:

(Blank Line)HeaderN: ...(Blank Line)

<!DOCTYPE ...><HTML><HEAD>...</HEAD><BODY>...</BODY></HTML>

5

Setting Arbitrary Response HeadersHeaders

• response.setHeader(String headerName, S i h d V l )String headerValue)

– Sets an arbitrary header• response setDateHeader(String name• response.setDateHeader(String name,

long millisecs) – Converts milliseconds since 1970 to a date string g

in GMT format• response.setIntHeader(String name,

i t h d V l )int headerValue) – Prevents need to convert int to String before calling

setHeadersetHeader• addHeader, addDateHeader, addIntHeader

– Adds new occurrence of header instead of replacing 6

Setting Common Response HeadersHeaders

• setContentType S t th C t t T h d– Sets the Content-Type header.

– Servlets almost always use this. – See table of common MIME types.yp

• setContentLength – Sets the Content-Length header.

Used for persistent HTTP connections– Used for persistent HTTP connections. – See Connection request header.

• addCookie– Adds a value to the Set-Cookie header. – See separate section on cookies.

• sendRedirect• sendRedirect – Sets the Location header (plus changes status code).

7

Common MIME Types

Type Meaningapplication/msword Microsoft Word documentapplication/octet stream Unrecognized or binary dataapplication/octet-stream Unrecognized or binary dataapplication/pdf Acrobat (.pdf) fileapplication/postscript PostScript fileapplication/vnd.ms-excel Excel spreadsheetapplication/vnd.ms-powerpoint Powerpoint presentation

li i / i i hiapplication/x-gzip Gzip archiveapplication/x-java-archive JAR fileapplication/x-java-vm Java bytecode (.class) fileapplication/zip Zip archiveaudio/basic Sound file in .au or .snd formataudio/x-aiff AIFF sound fileaudio/x-wav Microsoft Windows sound fileaudio/midi MIDI sound filetext/css HTML cascading style sheettext/html HTML documenttext/html HTML documenttext/plain Plain texttext/xml XML documentimage/gif GIF imageimage/jpeg JPEG imageimage/png PNG image

8

image/png PNG imageimage/tiff TIFF imagevideo/mpeg MPEG video clipvideo/quicktime QuickTime video clip

Building Excel Spreadsheets

public class ApplesAndOranges extends HttpServlet {public void doGet(HttpServletRequest requestpublic void doGet(HttpServletRequest request,

HttpServletResponse response)throws ServletException, IOException {response setContentTyperesponse.setContentType

("application/vnd.ms-excel");PrintWriter out = response.getWriter();

t i tl ("\tQ1\tQ2\tQ3\tQ4\tT t l")out.println("\tQ1\tQ2\tQ3\tQ4\tTotal");out.println

("Apples\t78\t87\t92\t29\t=SUM(B2:E2)");out.println

("Oranges\t77\t86\t93\t30\t=SUM(B3:E3)");}

}

9

Building Excel Spreadsheets

10

Common HTTP 1.1 Response HeadersHeaders

• Cache-Control (1.1) and Pragma (1.0) A h l b f hi– A no-cache value prevents browsers from caching page.

• Content-Disposition– Lets you request that the browser ask the user to save the response y q p

to disk in a file of the given nameContent-Disposition: attachment; filename=file-name

• Content-Encoding• Content-Encoding – The way document is encoded. See earlier compression example

• Content-Length– The number of bytes in the response. – See setContentLength on previous slide. – Use ByteArrayOutputStream to buffer document before sending it, y y p g ,

so that you can determine size. See discussion of the Connection request header

11

Common HTTP 1.1 Response Headers (Continued)Headers (Continued)

• Content-Type– The MIME type of the document being returned.– Use setContentType to set this header.

Expires• Expires– The time at which document should be considered out-of-

date and thus should no longer be cached.g– Use setDateHeader to set this header.

• Last-Modified– The time document was last changed. – Don’t set this header explicitly; provide a

getLastModified method instead See lottery numbergetLastModified method instead. See lottery number example in book (Chapter 3).

12

Common HTTP 1.1 Response Headers (Continued)Headers (Continued)

• Location– The URL to which browser should reconnect. – Use sendRedirect instead of setting this directly.

Refresh• Refresh– The number of seconds until browser should reload page.

Can also include URL to connect to. C USee following example.

• Set-Cookie– The cookies that browser should remember. Don’t set this

header directly; use addCookie instead. See next section.

• WWW-Authenticate• WWW-Authenticate– The authorization type and realm needed in Authorization

header. See security chapters in More Servlets & JSP.13

Requirements for Handling Long-Running ServletsLong-Running Servlets

• A way to store data between requests. F d h i ifi li i i fi ld– For data that is not specific to any one client, store it in a field (instance variable) of the servlet.

– For data that is specific to a user, store it in the HttpSession object S• See upcoming lecture on session tracking

– For data that needs to be available to other servlets or JSP pages (regardless of user), store it in the ServletContext

• A way to keep computations running after the response is sent to the user. – This task is simple: start a Thread. The only subtlety: set the threadThis task is simple: start a Thread. The only subtlety: set the thread

priority to a low value so that you do not slow down the server.

• A way to get the updated results to the browser when they are readywhen they are ready. – Use Refresh header to tell browser to ask for updates

14

Persistent Servlet State and Auto-Reloading Pages: ExampleAuto-Reloading Pages: Example

• Idea: generate list of large (e.g., 150-digit) i bprime numbers

– Show partial results until completedLet new clients make use of results from others– Let new clients make use of results from others

• Demonstrates use of the Refresh header.• Shows how easy it is for servlets to• Shows how easy it is for servlets to

maintain state between requests.– Very difficult in traditional CGI. y

• Also illustrates that servlets can handle multiple simultaneous connections– Each request is in a separate thread.

15

Finding Prime Numbers for Use with Public Key Cryptographywith Public Key Cryptography

public class PrimeNumberServlet extends HttpServlet {private List<PrimeList> primeListCollection =private List<PrimeList> primeListCollection new ArrayList<PrimeList>();

private int maxPrimeLists = 30;

public void doGet(HttpServletRequest request,HttpServletResponse response)

throws ServletException, IOException {int numPrimes =int numPrimes =ServletUtilities.getIntParameter(request,

"numPrimes", 50);int numDigits =ServletUtilities.getIntParameter(request,

"numDigits", 120);PrimeList primeList =fi dP i Li t( i Li tC ll tifindPrimeList(primeListCollection,

numPrimes, numDigits);

16


if (primeList == null) {primeList = new PrimeList(numPrimes, numDigits, true);primeList new PrimeList(numPrimes, numDigits, true);synchronized(primeListCollection) {if (primeListCollection.size() >= maxPrimeLists)primeListCollection.remove(0);p

primeListCollection.add(primeList);}

}List<BigInteger> currentPrimes = primeList.getPrimes();

int numCurrentPrimes = currentPrimes.size();i t P i R i i ( P i C tP i )int numPrimesRemaining = (numPrimes - numCurrentPrimes);boolean isLastResult = (numPrimesRemaining == 0);if (!isLastResult) {response setIntHeader("Refresh" 5);response.setIntHeader( Refresh , 5);

}…

17


18


19

Using Servlets to Generate JPEG ImagesGenerate JPEG Images

1. Create a BufferedImage2. Draw into the BufferedImage3. Set the Content-Type response header

/response.setContentType("image/jpeg");

4. Get an output streamOutputStream out = response.getOutputStreamOutputStream out response.getOutputStream

5. Send the BufferedImage in JPEG format to the output streamp

try {ImageIO.write(image, "jpg", out);

} catch(IOException ioe) {System.err.println("Error writing JPEG file: "

+ ioe);}20


21


22

Summary

• Many servlet tasks can only be accomplished th h f HTTP h dthrough use of HTTP response headers

• Setting response headers:– In general, set with response.setHeader– In special cases, set with response.setContentType,

response.setContentLength, response.addCookie, and response.sendRedirect

M t i t t h d t di tl• Most important response headers you set directly:– Cache-Control and Pragma– Content-Disposition

C E di– Content-Encoding– Content-Length– Expires

R f h– Refresh– WWW-Authenticate

23

© 2010 Marty Hall

Questions?


Developed and taught by well-known author and developer. At public venues or onsite at your location.24

06 response-headers

Technology

location header

persistent http connections

contenttype header

contentlength header

training courses

public venues

connection request header

t h d v