C
Invalidation Document Type Definition

This appendix describes the Document Type Definition (DTD), or grammar, of invalidation requests and responses. The DTD for requests and responses is defined within WCSinvalidation.dtd in the $ORACLE_HOME/webcache/invalidation directory on UNIX, and the ORACLE_HOME\webcache\invalidation directory on Windows.

This appendix contains these topics:

• Invalidation Request DTD

• Invalidation Response DTD

Invalidation Request DTD

Figure C-1 shows the DTD for invalidation messages.

Figure C-1 Invalidation Request DTD

<!-- root element for invalidation request -->
<!ELEMENT    INVALIDATION     (SYSTEM?,OBJECT+)>
    
<!-- VERSION is currently "WCS-1.0" without the quotes -->
<!ATTLIST    INVALIDATION
               VERSION          CDATA          #REQUIRED
>
        
<!ELEMENT    OBJECT           ((BASICSELECTOR|ADVANCEDSELECTOR), ACTION)>
    
<!ELEMENT    BASICSELECTOR    EMPTY>
<!ATTLIST    BASICSELECTOR
               URI              CDATA          #REQUIRED
>
    
<!ELEMENT    ADVANCEDSELECTOR (COOKIE|HEADER|OTHER)*>
<!ATTLIST    ADVANCEDSELECTOR
               URIPREFIX        CDATA          #REQUIRED
               URIEXP           CDATA          #IMPLIED
               METHOD           CDATA          #IMPLIED
               BODYEXP          CDATA          #IMPLIED
>
    
<!ELEMENT    COOKIE           EMPTY>
<!ATTLIST    COOKIE
               NAME             CDATA          #REQUIRED
               VALUE            CDATA          #IMPLIED
>
    
<!ELEMENT    HEADER           EMPTY>
<!ATTLIST    HEADER
               NAME             CDATA          #REQUIRED
               VALUE            CDATA          #IMPLIED
>
    
<!ELEMENT    ACTION           EMPTY>
<!ATTLIST    ACTION
               REMOVALTTL       CDATA          #IMPLIED
>

Table C-1 Invalidation Request DTD Elements and Attributes

Invalidation Element	Invalidation Attribute	Description
INVALIDATION
	VERSION	Version of the DTD
OBJECT
	BASICSELECTOR	Invalidation based on the URL
	ADVANCEDSELECTOR	Invalidation based on advanced invalidation selectors
	ACTION	Action to perform on document(s)
BASICSELECTOR
	URI	URL of the document(s) to be invalidated
ADVANCEDSELECTOR
	URIPREFIX	Prefix path (beginning and ending with "/") of the document(s) to be invalidated. The prefix is interpreted literally, including reserved regular expression characters.
	URIEXP	URL of the document(s) to be invalidated underneath the URIPREFIX
	METHOD	HTTP request method of the document(s) to be invalidated
	BODYEXP	HTTP POST body message of the document(s) to be invalidated
COOKIE
	NAME	Cookie name used by the documents contained within the URL
	VALUE	Value of the cookie If no value is present, then only documents with the named cookie but without value are invalidated.
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.
ACTION
	REMOVALTTL	Maximum time that documents can reside in the cache before they are invalidated. The default is 0 seconds.

Invalidation Response DTD

Figure C-2 shows the DTD for invalidation responses.

Figure C-2 Invalidation Response DTD

<!-- root element for invalidation result -->
<!ELEMENT    INVALIDATIONRESULT (SYSTEM?, OBJECTRESULT+)>
    
<!-- VERSION is currently "WCS-1.0" without the quotes -->
<!ATTLIST    INVALIDATIONRESULT
               VERSION          CDATA          #REQUIRED
>
    
<!ELEMENT    OBJECTRESULT     ((BASICSELECTOR|ADVANCEDSELECTOR), RESULT)>
    
<!ELEMENT    RESULT           EMPTY>
<!ATTLIST    RESULT
               ID               CDATA          #REQUIRED
               STATUS           CDATA          #REQUIRED
               NUMINV           CDATA          #REQUIRED
>

Table C-2 Invalidation Response DTD Elements and Attributes

Invalidation Element	Invalidation Attribute	Description
RESULT
	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 continues 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 that are not cacheable URI NOT FOUND for documents not found
	NUMINV	Number of documents invalidated