org.mule.module.xml.api

Enum EntityExpansion

java.lang.Object

java.lang.Enum<EntityExpansion>

org.mule.module.xml.api.EntityExpansion

All Implemented Interfaces:

Serializable, Comparable<EntityExpansion>

public enum EntityExpansion
extends Enum<EntityExpansion>

Security property which defines how to treat entities expansion.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Accept XML documents with references to external files and expand internal entity references in the XML body.
INTERNAL Never accept XML documents with references to external files but do expand internal entity references in the XML body.
NEVER Never accept XML documents with references to external files nor expand internal entity references in the XML body.

Method Summary

Modifier and Type	Method and Description
boolean	isAcceptExternalEntities()
boolean	isExpandInternalEntities()
static EntityExpansion	valueOf(String name) Returns the enum constant of this type with the specified name.
static EntityExpansion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final EntityExpansion NEVER

Never accept XML documents with references to external files nor expand internal entity references in the XML body. This prevents XXE and Billion Laughs (DoS) attacks

INTERNAL

public static final EntityExpansion INTERNAL

Never accept XML documents with references to external files but do expand internal entity references in the XML body. This prevents XXE but remains vulnerable to Billion Laughs (DoS) attacks. Use under your own risk with trusted documents only

ALL

public static final EntityExpansion ALL

Accept XML documents with references to external files and expand internal entity references in the XML body. This is vulnerable to XXE and Billion Laughs (DoS) attacks. Use under your own risk with trusted documents only

Method Detail

values

public static EntityExpansion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EntityExpansion c : EntityExpansion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EntityExpansion valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isAcceptExternalEntities

public boolean isAcceptExternalEntities()

isExpandInternalEntities

public boolean isExpandInternalEntities()