org.ws4d.java.communication.protocol.mime

Class DefaultMIMEHandler

java.lang.Object

org.ws4d.java.communication.protocol.mime.DefaultMIMEHandler

All Implemented Interfaces:

HTTPResponseHandler, HTTPRequestHandler

public class DefaultMIMEHandler
extends java.lang.Object
implements HTTPRequestHandler, HTTPResponseHandler

Default implementation of a HTTP handler which handles HTTP bodies containing MIME content.

This implementation allows the registration of MIME part handlers ( MIMEHandler ) which handle the incoming content within the MIME part.

The registration of such a MIME part handler can be done for one MIME part, a sequence of MIME parts or all MIME parts with, or without a content type.

Registration

• All MIME parts.
  • register(MIMEHandler)
  • Allows the registration of a MIME part handler for every incoming MIME part.
• Single MIME part.
  • register(int, MIMEHandler)
  • Allows the registration of a MIME part handler for an explicit incoming MIME part.
• All MIME parts with content type.
  • register(ContentType, MIMEHandler)
  • Allows the registration of a MIME part handler for every incoming MIME part with a given content type.
• Sequence of MIME parts.
  • register(int, int, MIMEHandler)
  • Allows the registration of a MIME part handler for a sequence of incoming MIME parts with given content type.
• Single MIME part with content type.
  • register(ContentType, int, MIMEHandler)
  • Allows the registration of a MIME part handler for an explicit incoming MIME part with given content type.
• Sequence of MIME parts with content type.
  • register(ContentType, int, int, MIMEHandler)
  • Allows the registration of a MIME part handler for a sequence of incoming MIME parts with given content type.

Handling MIME parts

If a MIME part handler matches the part (and the content type if given by registration) a new thread ( DefaultMIMEHandler.StreamConsumerThread ) will be started and the thread will handle the MIME exchange.
The thread in which the DefaultMIMEHandler acts will wait until the DefaultMIMEHandler.StreamConsumerThread has read the whole MIME part or ends correctly.
If the DefaultMIMEHandler.StreamConsumerThread ends without reading the complete MIME part, the omitted bytes will be consumed to wake up the DefaultMIMEHandler.

If the DefaultMIMEHandler is woken up, it will check for another MIME part. If another MIME part exists, the handling procedure will start again.
If no other MIME part exists, the HTTP response is generated by the DefaultMIMEHandler.

Generating HTTP response

Every MIMEHandler which handles a MIME part can add a MIMEEntityOutput into the MIME exchange for the response. If all MIME parts have been read, the generating process will begin.
To generate the HTTP response the DefaultMIMEHandler looks at the queued MIME entities.

• No MIME entities
  • A HTTP 204 (No Content) response will be sent.
• One MIME entity
  • A HTTP 200 (OK) response will be sent.
• More MIME entities
  • A HTTP 200 (OK) response with MIME content will be sent.

Constructor Summary

Constructors

Constructor and Description
DefaultMIMEHandler() Creates a default MIME handler.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createMimeBoundary()
HTTPResponse	handle(HTTPRequestHeader header, HTTPInputStream body, ConnectionInfo connectionInfo, MonitoringContext context) Handles a HTTP request.
void	handle(HTTPResponseHeader header, HTTPInputStream body, HTTPRequest request, ConnectionInfo connectionInfo, MonitoringContext context) Handles incoming HTTP response.
void	register(ContentType type, int partMin, int partMax, MIMEHandler handler) Allows the registration of a MIME part handler with content type for the MIME parts from a given start until a given end.
void	register(ContentType type, int partMax, MIMEHandler handler) Allows the registration of a MIME part handler with content type for the MIME parts from a given start until a given end.
void	register(ContentType type, MIMEHandler handler) Allows the registration of a MIME part handler with content type for every MIME part.
void	register(int partMin, int partMax, MIMEHandler handler) Allows the registration of a MIME part handler without content type for the MIME parts from given start until the given end.
void	register(int partMax, MIMEHandler handler) Allows the registration of a MIME part handler without content type from the first MIME part until the given part.
void	register(MIMEHandler handler) Allows the registration of a MIME part handler without content type for every MIME part.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMIMEHandler

public DefaultMIMEHandler()

Creates a default MIME handler.

Method Detail

createMimeBoundary

public static java.lang.String createMimeBoundary()

register

public void register(MIMEHandler handler)

Allows the registration of a MIME part handler without content type for every MIME part.

Parameters:

handler - the handler which handles the request.

register

public void register(ContentType type,
                     MIMEHandler handler)

Allows the registration of a MIME part handler with content type for every MIME part.

Parameters:

handler - the handler which handles the request.

register

public void register(int partMax,
                     MIMEHandler handler)

Allows the registration of a MIME part handler without content type from the first MIME part until the given part.

Parameters:

handler - the handler which handles the request.

register

public void register(int partMin,
                     int partMax,
                     MIMEHandler handler)

Allows the registration of a MIME part handler without content type for the MIME parts from given start until the given end.

Parameters:

handler - the handler which handles the request.

register

public void register(ContentType type,
                     int partMax,
                     MIMEHandler handler)

Allows the registration of a MIME part handler with content type for the MIME parts from a given start until a given end.

Parameters:

handler - the handler which handles the request.

register

public void register(ContentType type,
                     int partMin,
                     int partMax,
                     MIMEHandler handler)

Allows the registration of a MIME part handler with content type for the MIME parts from a given start until a given end.

Parameters:

handler - the handler which handles the request.

handle

public HTTPResponse handle(HTTPRequestHeader header,
                           HTTPInputStream body,
                           ConnectionInfo connectionInfo,
                           MonitoringContext context)
                    throws java.io.IOException

Description copied from interface: HTTPRequestHandler

Handles a HTTP request.

Specified by:

handle in interface HTTPRequestHandler

Parameters:

header - the http request header

body - the http request body

connectionInfo - transport/addressing related information attached to the request

Returns:

a http response for the request

Throws:

java.io.IOException

handle

public void handle(HTTPResponseHeader header,
                   HTTPInputStream body,
                   HTTPRequest request,
                   ConnectionInfo connectionInfo,
                   MonitoringContext context)
            throws java.io.IOException

Description copied from interface: HTTPResponseHandler

Handles incoming HTTP response.

Specified by:

handle in interface HTTPResponseHandler

Parameters:

header - the HTTP response header.

body - the HTTP response body.

connectionInfo - transport/addressing information attached to the response

Throws:

java.io.IOException