com.realobjects.pdfreactor

Class Configuration.ConnectionRule

java.lang.Object

com.realobjects.pdfreactor.Configuration.ConnectionRule

Enclosing class:

Configuration

public static class Configuration.ConnectionRule
extends Object

A type containing security rule properties.

Method Summary

Modifier and Type	Method and Description
Configuration.ConnectionRule	setAction(Configuration.ConnectionRuleAction action) The action to perform when the rule matches a resource URL.
void	setCaseSensitivePath(Boolean caseSensitivePath) Whether the rule matching mechanism will compare the paths in a case sensitive manner.
Configuration.ConnectionRule	setEntry(String entry) Represents the entry of the URL to be accessed.
Configuration.ConnectionRule	setHost(String host) The host of a URL to a resource.
Configuration.ConnectionRule	setName(String name) The name of the rule.
Configuration.ConnectionRule	setPath(String path) The path of a URL to a resource.
Configuration.ConnectionRule	setPort(Integer port) The port of a URL to a resource.
Configuration.ConnectionRule	setPriority(Integer priority) The priority of the rule.
Configuration.ConnectionRule	setProtocol(String protocol) The protocol if a URL to a resource.
Configuration.ConnectionRule	setResourceType(ResourceType resourceType) The type of the resource.

Methods inherited from class java.lang.Object

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

Method Detail

setAction

public Configuration.ConnectionRule setAction(Configuration.ConnectionRuleAction action)

The action to perform when the rule matches a resource URL.

setPriority

public Configuration.ConnectionRule setPriority(Integer priority)

The priority of the rule. A higher number means higher priority. Can be negative. Default value is 0.

setName

public Configuration.ConnectionRule setName(String name)

The name of the rule. This is used to identify the rule in logs.

setProtocol

public Configuration.ConnectionRule setProtocol(String protocol)

The protocol if a URL to a resource. Either this, Configuration.ConnectionRule.setHost(String), Configuration.ConnectionRule.setPort(Integer), Configuration.ConnectionRule.setPath(String), or Configuration.ConnectionRule.setResourceType(ResourceType) must be defined, otherwise the rule is ignored.

setHost

public Configuration.ConnectionRule setHost(String host)

The host of a URL to a resource. Supports wildcard patterns. Note that hosts are not case sensitive. Either this, Configuration.ConnectionRule.setProtocol(String), Configuration.ConnectionRule.setPort(Integer), Configuration.ConnectionRule.setPath(String), or Configuration.ConnectionRule.setResourceType(ResourceType) must be defined, otherwise the rule is ignored.

setPort

public Configuration.ConnectionRule setPort(Integer port)

The port of a URL to a resource. Either this, Configuration.ConnectionRule.setProtocol(String), Configuration.ConnectionRule.setHost(String), Configuration.ConnectionRule.setPath(String), or Configuration.ConnectionRule.setResourceType(ResourceType) must be defined, otherwise the rule is ignored.

Use -1 if you specifically want to validate against no port in the URL.

setPath

public Configuration.ConnectionRule setPath(String path)

The path of a URL to a resource. Supports wildcard patterns. Note that paths always start with a slash and that invalid URI characters (according to RFC 2396) must be URL encoded. Either this, Configuration.ConnectionRule.setProtocol(String), Configuration.ConnectionRule.setHost(String), Configuration.ConnectionRule.setPort(Integer), or Configuration.ConnectionRule.setResourceType(ResourceType) must be defined, otherwise the rule is ignored.

setEntry

public Configuration.ConnectionRule setEntry(String entry)

Represents the entry of the URL to be accessed. Usually only applies to JAR URLs. If access to the JAR file is allowed, access to all entries is also allowed by default. Entries are paths and are treated as such, see Configuration.ConnectionRule.setPath(String).

setCaseSensitivePath

public void setCaseSensitivePath(Boolean caseSensitivePath)

Whether the rule matching mechanism will compare the paths in a case sensitive manner.

setResourceType

public Configuration.ConnectionRule setResourceType(ResourceType resourceType)

The type of the resource. Either this, Configuration.ConnectionRule.setProtocol(String), Configuration.ConnectionRule.setHost(String), Configuration.ConnectionRule.setPort(Integer), or Configuration.ConnectionRule.setPath(String) must be defined, otherwise the rule is ignored.