The url
The url string has the following expected structure.
scheme : // authority [ / path ] [ ignored-query-or-fragment ]scheme will typically be http or https, but is not restricted by this class. authority is specified as:
authority = [ userinfo @ ] hostrange [ : portrange ] portrange = portnumber | -portnumber | portnumber-[portnumber] | * hostrange = ([*.] dnsname) | IPv4address | IPv6addressdnsname is a standard DNS host or domain name, i.e. one or more labels separated by ".". IPv4address is a standard literal IPv4 address and IPv6address is as defined in RFC 2732. Literal IPv6 addresses must however, be enclosed in '[]' characters. The dnsname specification can be preceded by "*." which means the name will match any hostname whose right-most domain labels are the same as this name. For example, "*.example.com" matches "foo.bar.example.com"
portrange is used to specify a port number, or a bounded or unbounded range of ports
that this permission applies to. If portrange is absent or invalid, then a default
port number is assumed if the scheme is http
(default 80) or https
(default 443). No default is assumed for other schemes. A wildcard may be specified
which means all ports.
userinfo is optional. A userinfo component if present, is ignored when creating a URLPermission, and has no effect on any other methods defined by this class.
The path component comprises a sequence of path segments,
separated by '/' characters. path may also be empty. The path is specified
in a similar way to the path in java.
. There are
three different ways as the following examples show:
Example url | Description |
---|---|
http://www.example.com/a/b/c.html | A url which identifies a specific (single) resource |
http://www.example.com/a/b/* | The '*' character refers to all resources in the same "directory" - in other words all resources with the same number of path components, and which only differ in the final path component, represented by the '*'. |
http://www.example.com/a/b/- | The '-' character refers to all resources recursively below the preceding path (e.g. http://www.example.com/a/b/c/d/e.html matches this example). |
The '*' and '-' may only be specified in the final segment of a path and must be the only character in that segment. Any query or fragment components of the url are ignored when constructing URLPermissions.
As a special case, urls of the form, "scheme:*" are accepted to mean any url of the given scheme.
The scheme and authority components of the url string are handled
without regard to case. This means equals(Object)
,
hashCode()
and implies(Permission)
are case insensitive with respect
to these components. If the authority contains a literal IP address,
then the address is normalized for comparison. The path component is case sensitive.
ignored-query-or-fragment refers to any query or fragment which appears after the path component, and which is ignored by the constructors of this class. It is defined as:
ignored-query-or-fragment = [ ? query ] [ # fragment ]where query and fragment are as defined in RFC2396.
getName()
therefore returns
only the scheme, authority and path components of the url string that
the permission was created with.
The actions string
The actions string of a URLPermission is a concatenation of the method list and the request headers list. These are lists of the permitted request methods and permitted request headers of the permission (respectively). The two lists are separated by a colon ':' character and elements of each list are comma separated. Some examples are:
The first example specifies the methods: POST, GET and DELETE, but no request headers. The second example specifies one request method and two headers. The third example specifies two request methods, and two headers.
The colon separator need not be present if the request headers list is empty. No white-space is permitted in the actions string. The action strings supplied to the URLPermission constructors are case-insensitive and are normalized by converting method names to upper-case and header names to the form defines in RFC2616 (lower case with initial letter of each word capitalized). Either list can contain a wild-card '*' character which signifies all request methods or headers respectively.
API Note
This permission cannot be used for controlling access to resources as the Security Manager is no longer supported.
Modifier and Type | Class and Description |
---|---|
pack-priv static class |
Modifier and Type | Field and Description |
---|---|
private String | actions
The actions string |
private transient URLPermission. | |
private transient List | |
private transient String | |
private transient List | |
private transient String | |
private static final long | |
private transient String |
Access | Constructor and Description |
---|---|
public | URLPermission(String
the url string url, String the actions string actions)Creates a new URLPermission from a url string and which permits the given request methods and user-settable request headers. |
public | URLPermission(String
the url string url)Creates a URLPermission with the given url string and unrestricted methods and request headers by invoking the two argument constructor as follows: URLPermission(url, "*:*") |
Modifier and Type | Method and Description |
---|---|
private String | |
public boolean | equals(Object
the object we are testing for equality with this object. p)Implements abstract java. Returns true if, this.getActions().equals(p.getActions()) and p's url equals this's url. |
public String | getActions()
Implements abstract java. Returns the normalized method list and request header list, in the form: "method-names : header-names" |
public int | hashCode()
Implements abstract java. Returns a hashcode calculated from the hashcode of the actions String and the url string. |
public boolean | implies(Permission
the permission to check against. p)Implements abstract java. Checks if this URLPermission implies the given permission. |
private void | |
private static String | |
private List | |
private List | |
private void | |
private void | readObject(ObjectInputStream
the s)ObjectInputStream from which data is readRestores the state of this object from stream. |
actions | back to summary |
---|---|
private String actions The actions string |
authority | back to summary |
---|---|
private transient URLPermission. |
methods | back to summary |
---|---|
private transient List<String> methods |
path | back to summary |
---|---|
private transient String path |
requestHeaders | back to summary |
---|---|
private transient List<String> requestHeaders |
scheme | back to summary |
---|---|
private transient String scheme |
serialVersionUID | back to summary |
---|---|
private static final long serialVersionUID Hides java. |
ssp | back to summary |
---|---|
private transient String ssp |
URLPermission | back to summary |
---|---|
public URLPermission(String url, String actions) Creates a new URLPermission from a url string and which permits the given request methods and user-settable request headers. The name of the permission is the url string it was created with. Only the scheme, authority and path components of the url are used internally. Any fragment or query components are ignored. The permissions action string is as specified above.
|
URLPermission | back to summary |
---|---|
public URLPermission(String url) Creates a URLPermission with the given url string and unrestricted methods and request headers by invoking the two argument constructor as follows: URLPermission(url, "*:*")
|
actions | back to summary |
---|---|
private String actions() |
equals | back to summary |
---|---|
public boolean equals(Object p) Implements abstract java. Returns true if, this.getActions().equals(p.getActions()) and p's url equals this's url. Returns false otherwise.
|
getActions | back to summary |
---|---|
public String getActions() Implements abstract java. Returns the normalized method list and request header list, in the form: "method-names : header-names" where method-names is the list of methods separated by commas and header-names is the list of permitted headers separated by commas. There is no white space in the returned String. If header-names is empty then the colon separator may not be present.
|
hashCode | back to summary |
---|---|
public int hashCode() Implements abstract java. Returns a hashcode calculated from the hashcode of the actions String and the url string.
|
implies | back to summary | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
public boolean implies(Permission p) Implements abstract java. Checks if this URLPermission implies the given permission. Specifically, the following checks are done as if in the following sequence:
Some examples of how paths are matched are shown below:
|
init | back to summary |
---|---|
private void init(String actions) |
normalize | back to summary |
---|---|
private static String normalize(String url) Remove any query or fragment from url string |
normalizeHeaders | back to summary |
---|---|
private List |
normalizeMethods | back to summary |
---|---|
private List |
parseURI | back to summary |
---|---|
private void parseURI(String url) |
readObject | back to summary |
---|---|
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Restores the state of this object from stream.
|
Modifier and Type | Field and Description |
---|---|
pack-priv HostPortrange |
Access | Constructor and Description |
---|---|
pack-priv |
Modifier and Type | Method and Description |
---|---|
pack-priv boolean | |
public int | |
pack-priv boolean | |
private boolean | |
private boolean |
p | back to summary |
---|---|
pack-priv HostPortrange p |
Authority | back to summary |
---|---|
pack-priv Authority(String scheme, String authority) |
equals | back to summary |
---|---|
pack-priv boolean equals(URLPermission. |
hashCode | back to summary |
---|---|
public int hashCode() Overrides java. Doc from java. Returns a hash code value for this object. This method is
supported for the benefit of hash tables such as those provided by
The general contract of
|
implies | back to summary |
---|---|
pack-priv boolean implies(URLPermission. |
impliesHostrange | back to summary |
---|---|
private boolean impliesHostrange(URLPermission. |
impliesPortrange | back to summary |
---|---|
private boolean impliesPortrange(URLPermission. |