Package org.owasp.html

Interface ElementPolicy

All Known Subinterfaces:

ElementPolicy.JoinableElementPolicy

public interface ElementPolicy

A policy that can be applied to an element to decide whether or not to allow it in the output, possibly after transforming attributes.

Element policies are applied after attribute policies so they can be used to add extra attributes.

Author:

Mike Samuel ([email protected])

See Also:

HtmlPolicyBuilder.allowElements(ElementPolicy, String...)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ElementPolicy.JoinableElementPolicy
static class	ElementPolicy.Util	Utilities for working with element policies.

Field Summary

Fields

Modifier and Type	Field	Description
static ElementPolicy	IDENTITY_ELEMENT_POLICY	An element policy that returns the element unchanged.
static ElementPolicy	REJECT_ALL_ELEMENT_POLICY	An element policy that rejects all elements.

Method Summary

Modifier and Type	Method	Description
java.lang.String	apply(java.lang.String elementName, java.util.List<java.lang.String> attrs)

Field Detail

IDENTITY_ELEMENT_POLICY

static final ElementPolicy IDENTITY_ELEMENT_POLICY

An element policy that returns the element unchanged.

REJECT_ALL_ELEMENT_POLICY

static final ElementPolicy REJECT_ALL_ELEMENT_POLICY

An element policy that rejects all elements.

Method Detail

apply

@Nullable
java.lang.String apply(java.lang.String elementName,
                       java.util.List<java.lang.String> attrs)

Parameters:

elementName - the lower-case element name.

attrs - a list of alternating attribute names and values. The list may be added to or removed from. When removing, be careful to remove both the name and its associated value.

Returns:

null to disallow the element, or the adjusted element name.