org.apache.sling.xss.impl

Class XSSFilterImpl

java.lang.Object

org.apache.sling.xss.impl.XSSFilterImpl

All Implemented Interfaces:

XSSFilter, org.osgi.service.event.EventHandler

@Service(value={org.osgi.service.event.EventHandler.class,XSSFilter.class})
@Property(name="event.topics",
          value="org/apache/sling/api/resource/Resource/*")
public class XSSFilterImpl
extends Object
implements XSSFilter, org.osgi.service.event.EventHandler

This class implements the XSSFilter using the Antisamy XSS protection library found at http://code.google.com/p/owaspantisamy/.

Field Summary

Fields inherited from interface org.apache.sling.xss.XSSFilter

DEFAULT_CONTEXT

Constructor Summary

Constructors

Constructor and Description
XSSFilterImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate()
boolean	check(ProtectionContext context, String src) Indicates whether or not a given source string contains XSS policy violations.
boolean	check(ProtectionContext context, String src, String policy)
String	filter(ProtectionContext context, String src) Protects the given source string from containing XSS stuff.
String	filter(ProtectionContext context, String src, String policy)
String	filter(String src) Prevents the given source string from containing XSS stuff.
void	handleEvent(org.osgi.service.event.Event event)
boolean	hasPolicy(String policyName)
void	loadPolicy(String policyName, InputStream policyStream)
void	resetDefaultPolicy()
void	setDefaultPolicy(InputStream policyStream)
void	unloadPolicy(String policyName)

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFilterImpl

public XSSFilterImpl()

Method Detail

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

check

public boolean check(ProtectionContext context,
            String src)

Description copied from interface: XSSFilter

Indicates whether or not a given source string contains XSS policy violations.

Specified by:

check in interface XSSFilter

Parameters:

context - context to use for checking

src - source string

Returns:

true if the source is violation-free

filter

public String filter(String src)

Description copied from interface: XSSFilter

Prevents the given source string from containing XSS stuff.

The default protection context is used for checking.

Specified by:

filter in interface XSSFilter

Parameters:

src - source string

Returns:

string that does not contain XSS stuff

filter

public String filter(ProtectionContext context,
            String src)

Description copied from interface: XSSFilter

Protects the given source string from containing XSS stuff.

Specified by:

filter in interface XSSFilter

Parameters:

context - context to use for checking

src - source string

Returns:

string that does not contain XSS stuff

activate

@Activate
protected void activate()

check

public boolean check(ProtectionContext context,
            String src,
            String policy)

filter

public String filter(ProtectionContext context,
            String src,
            String policy)

setDefaultPolicy

public void setDefaultPolicy(InputStream policyStream)
                      throws Exception

Throws:

Exception

resetDefaultPolicy

public void resetDefaultPolicy()

loadPolicy

public void loadPolicy(String policyName,
              InputStream policyStream)
                throws Exception

Throws:

Exception

unloadPolicy

public void unloadPolicy(String policyName)

hasPolicy

public boolean hasPolicy(String policyName)