Oracle Web Cache Administration and Deployment Guide Release 1.0.2.3 Part Number A86722-03 |
Library | Service | Contents | Index

# C
Invalidation Document Type Declaration

This appendix describes the Document Type Declaration (DTD), or grammar, of invalidation requests and responses. It contains these topics:

- Invalidation Request DTD

- Invalidation Response DTD

## Invalidation Request DTD

Figure C-1 shows the DTD for the invalidation messages.

#### Figure C-1 Invalidation Request DTD

    <!ELEMENT     INVALIDATION  (URL+)>

    <!ELEMENT     URL           (VALIDITY, COOKIE*, HEADER*)>

    <!ATTLIST     URL
                  EXP           CDATA    #REQUIRED
                  PREFIX        (YES|NO) "NO"
    >

    <!ELEMENT     VALIDITY      EMPTY>
    <!ATTLIST     VALIDITY
                  LEVEL         (0|1|2|3|4|5|6|7|8|9)  "0"
                  REFRESHTIME   CDATA    #IMPLIED
    >

    <!ELEMENT     COOKIE        EMPTY>
    <!ATTLIST     COOKIE
                  NAME          CDATA    #REQUIRED
                  VALUE         CDATA    #IMPLIED
                  NONEXIST      (YES|NO) "NO"
    >

    <!ELEMENT     HEADER        EMPTY>
    <!ATTLIST     HEADER
                  NAME          CDATA    #REQUIRED
                  VALUE         CDATA    #IMPLIED
    >

Table C-1 Invalidation Request DTD Elements and Attributes

#####

Invalidation Element | Invalidation Attribute | Description
--- | --- | ---
`URL` | `` |
`` | `EXP` | URL of the document(s) that you requested to be invalidated. More than one URL element can be specified in the message.
`` | `PREFIX` | A value of `YES` invalidates documents that match a prefix-based regular expression. `YES` limits the URL expression (`EXP`) to a limited form of regular expression

, whereby the URL path (from first "/" to the last "/") matches the prefix of the URL. For example, if you have the URL expression set to `/cec/cstage\?ecaction=viewitem`, then `/cec/` is the common prefix of the URLs to invalidate. Therefore, URLs such as `/cec/cstage?ecaction=viewitem&zip=94405` and `/cec/cstage?ecaction=viewitem&zip=94305` match, but `/usa/cec/cstage?ecaction=viewitem&zip=94209` does not match. The path section cannot contain any reserved regular expression characters. Reserved regular expression characters include periods (`.`), question marks (`?`), asterisks (`*`), brackets (`[]`), curly braces (`{}`), carats (`^`), dollar signs (`$`), or backslashes (`\`). However, the part after the path, which is usually the file name, can include regular expression characters.

A value of `NO` (default) invalidates only documents contained within the URL. `NO` also means that the URL expression (`EXP`) is interpreted literally.

`VALIDITY`

``

``

`LEVEL`

Validity level of the documents. Validity determines how long Oracle Web Cache serves documents stale from the cache before removing them.The validity level ranges from 0 (for the least valid) to 9 (for the most valid).

The higher the validity level, the longer Oracle Web Cache serves documents stale from the cache before removing them. Oracle Web Cache serves documents with a low validity level for a short amount of time before removing them. After documents are removed, Oracle Web Cache retrieves new versions of the documents from the application Web servers.

A validity level of 0 means Oracle Web Cache will remove documents immediately. The default validity level is 0.

``

`REFRESHTIME`

Maximum time that documents can reside in the cache

`COOKIE`

``

``

`NAME`

Cookie name used by the documents contained within the URL. The name must match the cookie name of a multiple-version cacheability rule associated with this URL.

``

`VALUE`

Value of the cookie

``

`NONEXIST`

A value of `YES` invalidates documents without this cookie; a value of `NO` invalidates documents with this cookie. `NO` is the default.

`HEADER`

``

``

`NAME`

HTTP request header used by the documents contained within the URL

``

`VALUE`

Value of the request header. The name must match the header of a multiple-version cacheability rule associated with this URL.

## Invalidation Response DTD

Figure C-2 shows the DTD for the invalidation responses.

#### Figure C-2 Invalidation Response DTD

    <!ELEMENT INVALIDATIONRESULT (URL+)>
    <!ELEMENT URL   EMPTY>
    <!ATTLIST URL
              EXPR          CDATA   #REQUIRED
              ID            CDATA   #REQUIRED
              STATUS        CDATA   #REQUIRED
              NUMINV        CDATA   #REQUIRED
    >

Table C-2 Invalidation Response DTD Elements and Attributes

#####

Invalidation Element | Invalidation Attribute | Description
--- | --- | ---
`URL` | `` |
`` | `EXPR` | URLs of the documents that you requested to be invalidated
`` | `ID` | Sequence number of all the URLs sent in the invalidation response. If there are multiple URLs specified in the invalidation message, then the sequence number starts at 1 for the first URL and sequentially numbers for each additional URL.
`` | `STATUS` | Status of the invalidation. Status can be one of the following: `SUCCESS` for successful invalidations `URI NOT CACHEABLE` for documents not in the cache `URI NOT FOUND` for documents not found
`` | `NUMINV` | Number of documents invalidated

| Copyright © 1996-2001 Oracle Corporation. All Rights Reserved. |
Library | Service | Contents | Index