Skip navigation links

oracle.ocsg.api_firewall.nt.management
Interface ApiFirewallMBean

public interface ApiFirewallMBean

Field Summary

static String	apiConfigXml Creates a "white list" of trusted APIs.
static int	errorStatus Specifies the HTTP status code returned by this MBean when a message is rejected.
static int	maxChildElementDepth Specifies the maximum number of nested elements allowed in a message.
static int	maxItemValueLength Specifies the maximum size of a single message entity, such as an element, attribute, or comment.
static int	maxMessageSize Specifies the maximum message size of the request, excluding attachments.
static int	maxUnboundedItems Specifies the maximum number of unbound items that a message can contain.

Method Summary

String	getApiConfigXml()
int	getErrorStatus()
int	getMaxChildElementDepth()
int	getMaxItemValueLength()
int	getMaxMessageSize()
int	getMaxUnboundedItems()
void	setApiConfigXml(String value)
void	setErrorStatus(int value)
void	setMaxChildElementDepth(int value)
void	setMaxItemValueLength(int value)
void	setMaxMessageSize(int value)
void	setMaxUnboundedItems(int value)

Field Detail

apiConfigXml

public static final String apiConfigXml

Creates a "white list" of trusted APIs. If the incoming message includes an API on this list, the message is exempt from further firewall checks.

• Scope: Cluster
• Default value: String: Empty

See Also:

Constant Field Values

errorStatus

public static final int errorStatus

Specifies the HTTP status code returned by this MBean when a message is rejected. The default message is 400 Bad Request, but you can specify any of the status codes.

• Scope: Cluster
• Default value: Integer: 400

See Also:

Constant Field Values

maxChildElementDepth

public static final int maxChildElementDepth

Specifies the maximum number of nested elements allowed in a message. Messages that exceed this limit are rejected and the status message defined by the ErrorStatus attribute is returned.

• Scope: Cluster
• Default value: Integer: 102400 bytes

See Also:

Constant Field Values

maxItemValueLength

public static final int maxItemValueLength

Specifies the maximum size of a single message entity, such as an element, attribute, or comment. Messages that contain an oversized entity are rejected and the status message defined by the ErrorStatus attribute is returned.

• Scope: Cluster
• Default value: Integer: 102400 bytes

See Also:

Constant Field Values

maxMessageSize

public static final int maxMessageSize

Specifies the maximum message size of the request, excluding attachments. Messages that exceed this limit are rejected and the status message defined by the ErrorStatus attribute is returned.

• Scope: Cluster
• Default value: Integer: 1024000 bytes

See Also:

Constant Field Values

maxUnboundedItems

public static final int maxUnboundedItems

Specifies the maximum number of unbound items that a message can contain. This includes items such as elements and attributes that are listed in the API schema as unbounded. Messages that exceed this limit are rejected and the status message defined by the ErrorStatus attribute is returned.

• Scope: Cluster
• Default value: Integer: 1024 bytes

See Also:

Constant Field Values

Method Detail

getApiConfigXml

public String getApiConfigXml()
                       throws ConfigurationException

Throws:

ConfigurationException

getErrorStatus

public int getErrorStatus()
                   throws ConfigurationException

Throws:

ConfigurationException

getMaxChildElementDepth

public int getMaxChildElementDepth()
                            throws ConfigurationException

Throws:

ConfigurationException

getMaxItemValueLength

public int getMaxItemValueLength()
                          throws ConfigurationException

Throws:

ConfigurationException

getMaxMessageSize

public int getMaxMessageSize()
                      throws ConfigurationException

Throws:

ConfigurationException

getMaxUnboundedItems

public int getMaxUnboundedItems()
                         throws ConfigurationException

Throws:

ConfigurationException

setApiConfigXml

public void setApiConfigXml(String value)
                     throws ConfigurationException

Throws:

ConfigurationException

setErrorStatus

public void setErrorStatus(int value)
                    throws ConfigurationException

Throws:

ConfigurationException

setMaxChildElementDepth

public void setMaxChildElementDepth(int value)
                             throws ConfigurationException

Throws:

ConfigurationException

setMaxItemValueLength

public void setMaxItemValueLength(int value)
                           throws ConfigurationException

Throws:

ConfigurationException

setMaxMessageSize

public void setMaxMessageSize(int value)
                       throws ConfigurationException

Throws:

ConfigurationException

setMaxUnboundedItems

public void setMaxUnboundedItems(int value)
                          throws ConfigurationException

Throws:

ConfigurationException

Skip navigation links