Package org.atmosphere.util

Class XSSHtmlFilter

java.lang.Object

org.atmosphere.util.XSSHtmlFilter

All Implemented Interfaces:

BroadcastFilter

public class XSSHtmlFilter
extends java.lang.Object
implements BroadcastFilter

Simple BroadcastFilter which automatically filter HTML/HTTP character into proper value, like \n replace by <br>. Using this BroadcastFilter prevent XSS attack.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcastFilter

BroadcastFilter.BroadcastAction

Field Summary

Fields inherited from interface org.atmosphere.cpr.BroadcastFilter

VOID_ATMOSPHERE_RESOURCE_UUID

Constructor Summary

Constructors

Constructor	Description
XSSHtmlFilter()

Method Summary

Modifier and Type	Method	Description
BroadcastFilter.BroadcastAction	filter(java.lang.String broadcasterId, java.lang.Object originalMessage, java.lang.Object o)	Transform a message into a well formed HTML message.

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSHtmlFilter

public XSSHtmlFilter()

Method Detail

filter

public BroadcastFilter.BroadcastAction filter(java.lang.String broadcasterId,
                                              java.lang.Object originalMessage,
                                              java.lang.Object o)

Transform a message into a well formed HTML message.

Specified by:

filter in interface BroadcastFilter

Parameters:

o - The object to introspect.

broadcasterId - the Broadcaster.getID() calling this object

originalMessage - The original message which was Broadcaster.broadcast(Object);

Returns:

a well formed