The name of a WebUserDataPermission (also referred to as the target name) identifies a Web resource by its context path relative URL pattern.
Permission
| Modifier and Type | Field and Description |
|---|---|
| private static final transient String | |
| private static final transient String | |
| private transient int | |
| private transient HttpMethodSpec | |
| private static final ObjectStreamField[] | serialPersistentFields
The serialized fields of this permission are defined below. |
| private static final long | |
| private static Map | |
| private static String[] | |
| private transient int | |
| private static int | |
| private static int | |
| private transient URLPatternSpec |
| Access | Constructor and Description |
|---|---|
| public | WebUserDataPermission(String
the URLPatternSpec that identifies the application specific web resources to which the permission
pertains. All URLPatterns in the URLPatternSpec are relative to the context path of the deployed web application
module, and the same URLPattern must not occur more than once in a URLPatternSpec. A null URLPatternSpec is
translated to the default URLPattern, "/", by the permission constructor. All colons occuring within the URLPattern
elements of the URLPatternSpec must be represented in escaped encoding as defined in RFC 2396. name, String identifies the HTTP methods and transport type to which the permission pertains. If the value passed
through this parameter is null or the empty string, then the permission is constructed with actions corresponding to
all the possible HTTP methods and transportType "NONE". actions)Creates a new WebUserDataPermission with the specified name and actions. |
| public | WebUserDataPermission(String
the URLPatternSpec that identifies the application specific web resources to which the
permission pertains. All URLPatterns in the URLPatternSpec are relative to the context path of the deployed web
application module, and the same URLPattern must not occur more than once in a URLPatternSpec. A null URLPatternSpec
is translated to the default URLPattern, "/", by the permission constructor. All colons occurring within the
URLPattern elements of the URLPatternSpec must be represented in escaped encoding as defined in RFC 2396. urlPatternSpec, String[] an array of strings each element of which contains the value of an HTTP method. If the value
passed through this parameter is null or is an array with no elements, then the permission is constructed with
actions corresponding to all the possible HTTP methods. HTTPMethods, String a String whose value is a transportType. If the value passed through this parameter is null,
then the permission is constructed with actions corresponding to transportType "NONE". transportType)Creates a new WebUserDataPermission with name corresponding to the URLPatternSpec, and actions composed from the array of HTTP methods and the transport type. |
| public | WebUserDataPermission(HttpServletRequest
the HttpServletRequest object corresponding to the Jakarta Servlet operation to which the permission pertains.
The permission name is the substring of the requestURI (HttpServletRequest.getRequestURI()) that begins after the
contextPath (HttpServletRequest.getContextPath()). When the substring operation yields the string "/", the permission
is constructed with the empty string as its name. The constructor must transform all colon characters occurring in the
name to escaped encoding as defined in RFC 2396. The HTTP method component of the permission's actions is as obtained
from HttpServletRequest.getMethod(). The TransportType component of the permission's actions is determined by calling
HttpServletRequest.isSecure(). request)Creates a new WebUserDataPermission from the HttpServletRequest object. |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: true if the argument WebUserDataPermission object is equivalent to this WebUserDataPermission.the WebUserDataPermission object being tested for equality with this WebUserDataPermission. o)Implements abstract java. |
| public String | Returns: a String containing the canonicalized actions of this WebUserDataPermission (or the null value).Implements abstract java. |
| private static String | getUriMinusContextPath(HttpServletRequest request)
Chops the ContextPath off the front of the requestURI to yield the servletPath + PathInfo. |
| public int | Returns: the integer hash code value for this object.Implements abstract java. |
| public boolean | Returns: true if the specified permission is implied by this object, false if not."this" WebUserDataPermission is checked to see if it implies the argument permission. permission)Implements abstract java. |
| private void | |
| private void | readObject(ObjectInputStream
The stream from which the fields are read inputStream)readObject reads the serialized fields from the input stream and uses them to restore the permission. |
| private synchronized void | writeObject(ObjectOutputStream
The stream to which the serialized fields are written outputStream)writeObject is used to establish the values of the serialized fields before they are written to the output stream and need not be implemented if the values of the serialized fields are always available and up to date. |
| EMPTY_STRING | back to summary |
|---|---|
| private static final transient String EMPTY_STRING | |
| ESCAPED_COLON | back to summary |
|---|---|
| private static final transient String ESCAPED_COLON | |
| hashCodeValue | back to summary |
|---|---|
| private transient int hashCodeValue | |
| methodSpec | back to summary |
|---|---|
| private transient HttpMethodSpec methodSpec | |
| serialPersistentFields | back to summary |
|---|---|
| private static final ObjectStreamField[] serialPersistentFields The serialized fields of this permission are defined below. Whether or not the serialized fields correspond to actual (private) fields is an implementation decision.
| |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| transportHash | back to summary |
|---|---|
| private static Map<String, Integer> transportHash | |
| transportKeys | back to summary |
|---|---|
| private static String[] transportKeys | |
| transportType | back to summary |
|---|---|
| private transient int transportType | |
| TT_CONFIDENTIAL | back to summary |
|---|---|
| private static int TT_CONFIDENTIAL | |
| TT_NONE | back to summary |
|---|---|
| private static int TT_NONE | |
| urlPatternSpec | back to summary |
|---|---|
| private transient URLPatternSpec urlPatternSpec | |
| WebUserDataPermission | back to summary |
|---|---|
| public WebUserDataPermission(String name, String actions) Creates a new WebUserDataPermission with the specified name and actions. The name contains a URLPatternSpec that identifies the web resources to which the permissions applies. The syntax of a URLPatternSpec is as follows:
URLPatternList ::= URLPattern | URLPatternList colon URLPattern
URLPatternSpec ::= null | URLPattern | URLPattern colon URLPatternList
A null URLPatternSpec is translated to the default URLPattern, "/", by the permission constructor. The empty string is an exact URLPattern, and may occur anywhere in a URLPatternSpec that an exact URLPattern may occur. The first URLPattern in a URLPatternSpec may be any of the pattern types, exact, path-prefix, extension, or default as defined in the Jakarta Servlet Specification). When a URLPatternSpec includes a URLPatternList, the patterns of the URLPatternList identify the resources to which the permission does NOT apply and depend on the pattern type and value of the first pattern as follows:
The actions parameter contains a comma separated list of HTTP methods that may be followed by a transportType separated from the HTTP method by a colon.
ExtensionMethod ::= any token as defined by RFC 2616
(that is, 1*[any CHAR except CTLs or separators])
HTTPMethod ::= "Get" | "POST" | "PUT" | "DELETE" | "HEAD" |
"OPTIONS" | "TRACE" | ExtensionMethod
HTTPMethodList ::= HTTPMethod | HTTPMethodList comma HTTPMethod
HTTPMethodExceptionList ::= exclaimationPoint HTTPMethodList
HTTPMethodSpec ::= emptyString | HTTPMethodExceptionList |
HTTPMethodList
transportType ::= "INTEGRAL" | "CONFIDENTIAL" | "NONE"
actions ::= null | HTTPMethodSpec |
HTTPMethodSpec colon transportType
If duplicates occur in the HTTPMethodSpec they must be eliminated by the permission constructor. An empty string HTTPMethodSpec is a shorthand for a List containing all the possible HTTP methods. If the HTTPMethodSpec contains an HTTPMethodExceptionList (i.e., it begins with an exclaimationPoint), the permission pertains to all methods except those occuring in the exception list. An actions string without a transportType is a shorthand for a actions string with the value "NONE" as its TransportType. A granted permission representing a transportType of "NONE", indicates that the associated resources may be accessed using any connection type.
| |
| WebUserDataPermission | back to summary |
|---|---|
| public WebUserDataPermission(String urlPatternSpec, String[] HTTPMethods, String transportType) Creates a new WebUserDataPermission with name corresponding to the URLPatternSpec, and actions composed from the array of HTTP methods and the transport type.
| |
| WebUserDataPermission | back to summary |
|---|---|
| public WebUserDataPermission(HttpServletRequest request) Creates a new WebUserDataPermission from the HttpServletRequest object.
| |
| equals | back to summary |
|---|---|
| public boolean equals(Object o) Implements abstract java. Checks two WebUserDataPermission objects for equality. WebUserDataPermission objects are equivalent if their URLPatternSpec and (canonicalized) actions values are equivalent. The URLPatternSpec of a reference permission is equivalent to that of an argument permission if their first patterns are equivalent, and the patterns of the URLPatternList of the reference permission collectively match exactly the same set of patterns as are matched by the patterns of the URLPatternList of the argument permission. Two Permission objects, P1 and P2, are equivalent if and only if P1.implies(P2) AND P2.implies(P1). | |
| getActions | back to summary |
|---|---|
| public String getActions() Implements abstract java. Returns a canonical String representation of the actions of this WebUserDataPermission. The canonical form of the actions of a WebUserDataPermission is described by the following syntax description.
ExtensionMethod ::= any token as defined by RFC 2616
(that is, 1*[any CHAR except CTLs or separators])
HTTPMethod ::= "GET" | "POST" | "PUT" | "DELETE" | "HEAD" |
"OPTIONS" | "TRACE" | ExtensionMethod
HTTPMethodList ::= HTTPMethod | HTTPMethodList comma HTTPMethod
HTTPMethodExceptionList ::= exclaimationPoint HTTPMethodList
HTTPMethodSpec ::= emptyString | HTTPMethodExceptionList |
HTTPMethodList
transportType ::= "INTEGRAL" | "CONFIDENTIAL" | "NONE"
actions ::= null | HTTPMethodList |
HTTPMethodSpec colon transportType
If the permission's HTTP methods correspond to the entire HTTP method set and the permission's transport type is "INTEGRAL" or "CONFIDENTIAL", the HTTP methods shall be represented in the canonical form by an emptyString HTTPMethodSpec. If the permission's HTTP methods correspond to the entire HTTP method set, and the permission's transport type is not "INTEGRAL"or "CONFIDENTIAL", the canonical actions value shall be the null value. If the permission's methods do not correspond to the entire HTTP method set, duplicates must be eliminated and the remaining elements must be ordered such that the predefined methods preceed the extension methods, and such that within each method classification the corresponding methods occur in ascending lexical order. The resulting (non-emptyString) HTTPMethodSpec must be included in the canonical form, and if the permission's transport type is not "INTEGRAL" or "CONFIDENTIAL", the canonical actions value must be exactly the resulting HTTPMethodSpec. | |
| getUriMinusContextPath | back to summary |
|---|---|
| private static String getUriMinusContextPath(HttpServletRequest request) Chops the ContextPath off the front of the requestURI to yield the servletPath + PathInfo. For the special case where the servletPath + PathInfo is the pattern, "/", this routine returns the empty string. | |
| hashCode | back to summary |
|---|---|
| public int hashCode() Implements abstract java. Returns the hash code value for this WebUserDataPermission. The properties of the returned hash code must be as follows:
| |
| implies | back to summary |
|---|---|
| public boolean implies(Permission permission) Implements abstract java. Determines if the argument Permission is "implied by" this WebUserDataPermission. For this to be the case all of the following must be true:
URLPattern matching is performed using the Jakarta Servlet matching rules where two URL patterns match if they are related as follows:
All of the comparisons described above are case sensitive.
| |
| parseActions | back to summary |
|---|---|
| private void parseActions(String actions) | |
| readObject | back to summary |
|---|---|
| private void readObject(ObjectInputStream inputStream) throws IOException, ClassNotFoundException readObject reads the serialized fields from the input stream and uses them to restore the permission. This method need not be implemented if establishing the values of the serialized fields (as is done by defaultReadObject) is sufficient to initialize the permission.
| |
| writeObject | back to summary |
|---|---|
| private synchronized void writeObject(ObjectOutputStream outputStream) throws IOException writeObject is used to establish the values of the serialized fields before they are written to the output stream and need not be implemented if the values of the serialized fields are always available and up to date. The serialized fields are written to the output stream in the same form as they would be written by defaultWriteObject.
| |