Package org.atmosphere.cpr

Class AtmosphereInterceptorWriter

java.lang.Object

org.atmosphere.cpr.AsyncIOWriterAdapter

org.atmosphere.cpr.AtmosphereInterceptorWriter

All Implemented Interfaces:

AsyncIOWriter

Direct Known Subclasses:

WebSocket

public class AtmosphereInterceptorWriter
extends AsyncIOWriterAdapter

An AsyncIOWriter that delegates the write operation to its AsyncIOInterceptor. If no AsyncIOInterceptor is specified, this class does nothing and the responses will never get written.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.LinkedList<AsyncIOInterceptor>	filters
protected java.util.LinkedList<AsyncIOInterceptor>	reversedFilters

Constructor Summary

Constructors

Constructor	Description
AtmosphereInterceptorWriter()

Method Summary

Modifier and Type	Method	Description
void	close(AtmosphereResponse response)	Close the underlying connection.
java.util.LinkedList<AsyncIOInterceptor>	filters()
AsyncIOWriter	flush(AtmosphereResponse response)	Flush the buffered content.
AtmosphereInterceptorWriter	interceptor(AsyncIOInterceptor filter)	Add an AsyncIOInterceptor that will be invoked in the order it was added.
AtmosphereInterceptorWriter	interceptor(AsyncIOInterceptor filter, int index)	Add an AsyncIOInterceptor that will be invoked at the specified index position.
protected void	invokeInterceptor(AtmosphereResponse response, byte[] data, int offset, int length)
AsyncIOWriter	redirect(AtmosphereResponse response, java.lang.String location)	Redirect a WebSocket request to another location.
AsyncIOWriter	write(AtmosphereResponse response, byte[] data)	Write a WebSocket message.
AsyncIOWriter	write(AtmosphereResponse response, byte[] data, int offset, int length)	Write a WebSocket message.
AsyncIOWriter	write(AtmosphereResponse response, java.lang.String data)	Write a WebSocket message.
AsyncIOWriter	writeError(AtmosphereResponse response, int errorCode, java.lang.String message)	Write an error code.
protected void	writeReady(AtmosphereResponse response, byte[] responseDraft)

Methods inherited from class java.lang.Object

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

Field Detail

filters

protected final java.util.LinkedList<AsyncIOInterceptor> filters

reversedFilters

protected final java.util.LinkedList<AsyncIOInterceptor> reversedFilters

Constructor Detail

AtmosphereInterceptorWriter

public AtmosphereInterceptorWriter()

Method Detail

redirect

public AsyncIOWriter redirect(AtmosphereResponse response,
                              java.lang.String location)
                       throws java.io.IOException

Description copied from interface: AsyncIOWriter

Redirect a WebSocket request to another location.

Specified by:

redirect in interface AsyncIOWriter

Overrides:

redirect in class AsyncIOWriterAdapter

Throws:

java.io.IOException

writeError

public AsyncIOWriter writeError(AtmosphereResponse response,
                                int errorCode,
                                java.lang.String message)
                         throws java.io.IOException

Description copied from interface: AsyncIOWriter

Write an error code.

Specified by:

writeError in interface AsyncIOWriter

Overrides:

writeError in class AsyncIOWriterAdapter

errorCode - the error code

Throws:

java.io.IOException

write

public AsyncIOWriter write(AtmosphereResponse response,
                           java.lang.String data)
                    throws java.io.IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AsyncIOWriterAdapter

data - the WebSocket message

Throws:

java.io.IOException

write

public AsyncIOWriter write(AtmosphereResponse response,
                           byte[] data)
                    throws java.io.IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AsyncIOWriterAdapter

data - the WebSocket message

Throws:

java.io.IOException

write

public AsyncIOWriter write(AtmosphereResponse response,
                           byte[] data,
                           int offset,
                           int length)
                    throws java.io.IOException

Description copied from interface: AsyncIOWriter

Write a WebSocket message.

Specified by:

write in interface AsyncIOWriter

Overrides:

write in class AsyncIOWriterAdapter

data - the WebSocket message

offset - offset of the message

length - length of the message

Throws:

java.io.IOException

invokeInterceptor

protected void invokeInterceptor(AtmosphereResponse response,
                                 byte[] data,
                                 int offset,
                                 int length)
                          throws java.io.IOException

Throws:

java.io.IOException

writeReady

protected void writeReady(AtmosphereResponse response,
                          byte[] responseDraft)

close

public void close(AtmosphereResponse response)
           throws java.io.IOException

Description copied from interface: AsyncIOWriter

Close the underlying connection.

Specified by:

close in interface AsyncIOWriter

Overrides:

close in class AsyncIOWriterAdapter

Throws:

java.io.IOException

flush

public AsyncIOWriter flush(AtmosphereResponse response)
                    throws java.io.IOException

Description copied from interface: AsyncIOWriter

Flush the buffered content.

Specified by:

flush in interface AsyncIOWriter

Overrides:

flush in class AsyncIOWriterAdapter

Throws:

java.io.IOException

interceptor

public AtmosphereInterceptorWriter interceptor(AsyncIOInterceptor filter)

Add an AsyncIOInterceptor that will be invoked in the order it was added.

Parameters:

filter - AsyncIOInterceptor

Returns:

this

interceptor

public AtmosphereInterceptorWriter interceptor(AsyncIOInterceptor filter,
                                               int index)

Add an AsyncIOInterceptor that will be invoked at the specified index position.

Parameters:

filter - AsyncIOInterceptor

index -

Returns:

this

filters

public java.util.LinkedList<AsyncIOInterceptor> filters()