About Out-of-Band Invalidations About ESI Inline Invalidations

7-4 Oracle Fusion Middleware Administrators Guide for Oracle Web Cache

7.5.1 Invalidation Request Syntax

Use the following syntax to invalidate objects contained within an exact URL that includes the complete path and file name: ?xml version=1.0? DOCTYPE INVALIDATION SYSTEM internal:WCSinvalidation.dtd INVALIDATION VERSION=WCS-1.1 SYSTEM SYSTEMINFO NAME=name VALUE=value SYSTEM OBJECT BASICSELECTOR URI=URL ACTION REMOVALTTL=TTL INFO VALUE=value OBJECT INVALIDATION Use the following syntax to invalidate objects based on more advanced invalidation selectors: ?xml version=1.0? DOCTYPE INVALIDATION SYSTEM internal:WCSinvalidation.dtd INVALIDATION VERSION=WCS-1.1 SYSTEM SYSTEMINFO NAME=name VALUE=value SYSTEM OBJECT ADVANCEDSELECTOR URIPREFIX=prefix URIEXP=URL_expression HOST=host_name:port METHOD=HTTP_request_method BODYEXP=HTTP_body COOKIE NAME=cookie_name VALUE=value HEADER NAME=HTTP_request_header VALUE=value OTHER NAME=URI|BODY|QUERYSTRING_PARAMETER|SEARCHKEY TYPE=SUBSTRING|REGEX VALUE=value ADVANCEDSELECTOR ACTION REMOVALTTL=TTL INFO VALUE=value OBJECT INVALIDATION The body of a valid invalidation request must begin with the following: ?xml version=1.0? DOCTYPE INVALIDATION SYSTEM internal:WCSinvalidation.dtd The first line denotes version 1.0 of XML. The second line denotes that the request is an invalidation request using the WCSinvalidation.dtd file as the XML document type. WCSinvalidation.dtd is the Document Type Definition DTD that defines the grammar of invalidation requests and responses. Note the following: ■ No white space is allowed before ?xml. ■ If an application is sharing invalidation requests with a third-party XML parser, replace internal:WCSinvalidation.dtd with the following path: http:www.oracle.comwebcache90400WCSinvalidation.dtd Invalidating Content 7-5 The root element INVALIDATION contains one or more of the attributes and elements described in Table 7–1 . Table 7–1 INVALIDATION Elements and Attributes Invalidation ElementAttribute Description VERSION attribute Required attribute in the INVALIDATION element Denote the version of the WCSinvalidation.dtd file to use as the XML document type. For versions 9.0.x and later, always use VERSION=WCS-1.1, unless you require previous existing applications to remain unchanged. For these applications, you can use VERSION=WCS-1.0, but the new invalidation functionality is not available. SYSTEM element Optional element in the INVALIDATION element. The SYSTEM element requires the SYSTEMINFO element. SYSTEMINFO element Required element in the SYSTEM element The possible NAMEVALUE pairs are: ■ NAME=WCS_PROPAGATE VALUE=TRUE|FALSE This pair specifies whether invalidation requests are propagated to cache cluster members. If WCS_PROPAGATE is TRUE, it overrides the setting for invalidation propagation in the configuration. If WCS_PROPAGATE is FALSE, it uses the setting specified in the configuration. The default is FALSE. ■ NAME=WCS_DISCONNECTED_MODE_OK VALUE=TRUE|FALSE This pair specifies how soon invalidation takes place. If WCS_DISCONNECTED_ MODE_OK is TRUE, invalidation is not immediately performed. The invalidation response is sent as soon as the invalidation request is received. Set this element to TRUE, if you do not want to wait for the invalidation result. If WCS_ DISCONNECTED_MODE_OK is FALSE, invalidation is completed immediately and the invalidation result is sent. The default is FALSE. OBJECT element Required element in the invalidation request. You can specify multiple OBJECT elements in the request. BASICSELECTOR element URI attribute: Required attribute of the BASICSELECTOR element. Specify the URL of the objects to be invalidated. Use these formats: ■ http:host_name:portpathfilename ■ https:host_name:portpathfilename host_name :port is not required if the administrator account is sending the request. ADVANCEDSELECTOR element URIPREFIX attribute: Required attribute of the ADVANCEDSELECTOR element. Specify the path prefix of the objects to be invalidated. The path prefix must begin with http|https:host_name:portpathfilename or and end with . host_name :port is required if the HOST attribute is not specified and the invalidator account is sending the request. The prefix is interpreted literally, including reserved regular expression characters. These characters include periods ., question marks ?, asterisks , brackets [], curly braces {}, carets , dollar signs , and backslashes \.