Contents

Title and Copyright Information

Send Us Your Comments

Preface

Intended Audience

Documentation Accessibility

Organization

Related Documentation

Conventions

What's New in OracleAS Web Cache?

New Features in 10g (9.0.4)

New Features in Release 2 (9.0.2 and 9.0.3)

Part I Getting Started with OracleAS Web Cache

1 Introduction to OracleAS Web Cache

What Is the Big Picture for Caching?

Oracle's Solution to Web Site Performance Issues

How Reverse Proxy Web Caching Works

Benefits of Web Caching

Features of OracleAS Web Cache

Whole-Page Caching for Static and Dynamic Content Caching

Cache Invalidation and Expiration

Performance Assurance

Virtual Hosting

Virtual Host Sites

ESI Provider Sites

Site Definitions and Site-to-Server Mappings

How OracleAS Web Cache Locates Application Web Severs or Proxy Servers

Cache Clustering

Cache Hierarchies

Origin Server Surge Protection, Load Balancing, Failover, and Session Binding

Surge Protection

Stateless Load Balancing

Backend Failover

Session Binding (Stateful Load Balancing)

Security

Compression

Auto-Restart

Compatibility with Oracle Application Server Components

2 Caching Concepts

Cache Population

How OracleAS Web Cache Processes Requests with a Range Request-Header Field

Cache Consistency and Performance Assurance

Invalidation

Invalidation in Hierarchies

Invalidation in Cache Clusters

Expiration

HTTP Cache Validation

Performance Assurance Heuristics

Caching Dynamically Generated Content

Multiple Versions of the Same Document

Personalized Attributes

Controlling How Personalized Attribute Requests Are Served by the Cache

Session Information

Excluding the Value of Embedded URL or POST Body Parameters

Substituting Session Information in Session-Encoded URLs

Controlling How Session Requests Are Served by the Cache

Content Assembly and Partial Page Caching

Page Assembly Components

Fragmentation with the Inline and Include Tags

Using Inline for Non-Fetchable Fragmentation

Using Inline for Fetchable Fragmentation

Using Include for Fragmentation

Referer Request-Header Field

Cookie Management for Template Pages and Fragments

ESI Features

ESI for Java (JESI)

Request and Response-Header Fields

Oracle-ECID Request-Header Field

Surrogate-Capability Request-Header Field

Server Response-Header Field

Surrogate-Control Response-Header Field

Surrogate-Key Response-Header Field

3 Cache Clustering

Overview of Cache Clusters

Benefits of Cache Clusters

How Cache Clusters Work

How Cache Content Is Distributed

Failure Detection and Failover

4 OracleAS Web Cache Security

About OracleAS Web Cache Security

OracleAS Web Cache Security Model

Restricted Administration

Secure Sockets Layer (SSL)

SSL Acceleration

Classes of Users and Their Privileges

Resources Protected

Authorization and Access Enforcement

Leveraging Oracle Identity Management Infrastructure

Oracle Application Server Single Sign-On Servers

Oracle Application Server Single Sign-On Partner Applications (mod_osso)

Configuring OracleAS Web Cache Security

5 OracleAS Web Cache Topologies

Common OracleAS Web Cache Configuration

Specialized Topologies

Deploying a Distributed Cache Hierarchy

Deploying OracleAS Web Cache for High Availability Without a Hardware Load
Balancer

Deploying OracleAS Web Cache with a Layer 7 Switch

Security Topologies

Deploying OracleAS Web Cache with Firewalls

Deploying OracleAS Web Cache with SSL Acceleration Hardware

Routing HTTPS Requests to a Dedicated Cache

Routing HTTPS Requests Around OracleAS Web Cache

Routing Single Sign-On Server Requests

6 Configuration and Administration Tools Overview

OracleAS Web Cache Manager for Configuration and Management

Starting OracleAS Web Cache Manager

Navigating OracleAS Web Cache

Apply Changes and Cancel Changes Buttons

Status Messages

Navigator Frame

Right Frame

The Cache Operations Page

Applying Static and Dynamic Configuration Changes

Oracle Enterprise Manager for Metrics

OPMN for Process Administration

Script for Setting File Permissions on UNIX

Configuration and Administration Tasks at a Glance

Part II Configuration and Administration of OracleAS Web Cache

7 Basic Setup and Configuration

Using the Default Configuration

Tasks for Setting Up OracleAS Web Cache

Task 1: Start OracleAS Web Cache and OracleAS Web Cache Manager

Task 2: Modify Security Settings

Task 3: Configure Auto-Restart Settings

Task 4: Configure Network Time Outs

Task 5: Set Resource Limits

Cache Memory

Connection Limit

Cached Object Size Limit

Task 6: Configure OracleAS Web Cache with Listening Ports for Incoming Browser
Requests

Task 7: Provide Directives to Oracle HTTP Server

Task 8: Configure OracleAS Web Cache with Operations Ports

Task 9: Configure Origin Server, Load Balancing, and Failover Settings

Task 10: Configure Web Site Settings

Create Site Definitions

Map Sites to Origin Servers

Configure Error Pages

Bind a Session to an Origin Server

Default Site Settings

Virtual Host Site Example Settings

ESI Provider Site Example Settings

Task 11: Specify Caching Rules

Task 12: Apply Changes and Restart OracleAS Web Cache

8 Specialized Configurations

Configuring OracleAS Web Cache for HTTPS Requests

Task 1: Create Wallets

Task 2: Configure HTTPS Listening Ports and Wallet Location for the Cache

Task 3: Configure HTTPS Operations Ports for the Cache

Task 4: Create a Site for HTTPS Requests

Task 5: Configure HTTPS Port and Wallet Location for the Origin Server

Task 6: Create the Site-to-Server Mapping

Task 7: (Optional) Require Client-Side Certificates

Task 8: (Optional) Permit Only HTTPS Requests for a URL or Set of URLs

Task 9: Restart OracleAS Web Cache

Configuring a Hierarchy of Caches

Configuring a Distributed Cache Hierarchy

Configuring an ESI Cache Hierarchy

Additional Hierarchy Configuration for a Cache Cluster

Configuring a Cache Cluster

Task 1: Configure Cache Cluster Settings

Task 2: Add Caches to the Cluster

Task 3: Enable Tracking of Session Binding

Task 4: Propagate the Configuration to Cluster Members

Removing Caches from a Cluster

Configuring Administration and Invalidation-Only Clusters

Ensuring That ClientIP Headers Are Valid

Enabling End-User Performance Monitoring

Selecting URLs to Monitor

Configuring for High Availability Without a Hardware Load Balancer

Configuring Microsoft Network Load Balancing

Configuring HTTP Request Header Limits

Running webcached with Root Privilege

9 Creating Caching Rules

Caching Rules Overview

Rule Creation

Selectors

File Extension Expression Type

Path Prefix Expression Type

Regular Expression

Caching Policy

Cache-Key Policy

Priority

Default Caching Rules

Configuring Caching Rules and Rule Association

Task 1: Create Caching Rules

Task 2: Prioritize Rules

Task 3: (Optional) Associate Multiple Rules with Caching Policy Features

Additional Configuration for Cache Policy Features

Configuring Expiration Policies

Configuring Cookie Definitions for Multiple-Version Documents Containing
Cookies

Recognizing Similar Browser Types for Multiple-Version Documents Containing
HTTP Request Headers

Configuring Session or Personalized Attribute Caching Policies

Configuring Support for Session-Encoded URLs

Configuring Support for Personalized Attributes

Example: Personalized Page Configuration

Configuring Session Definitions to Exclude the Value of Embedded URL or POST
Parameters

Configuring Rules for Popular Pages with Session Establishment

Using the Surrogate-Control Response Header as an Alternative to Caching Rules

Configuring Rules for Content Assembly and Partial Page Caching

Enabling Partial Page Caching

Using ESI for Simple Personalization

Examples of ESI Usage

Example of a Portal Site Implementation

Example of Simple Personalization with Variable Expressions

10 Administering OracleAS Web Cache

Starting and Stopping OracleAS Web Cache

Propagating Configuration Changes to Cache Cluster Members

Listing Popular Requests and Cache Contents

Listing Popular Requests

Listing All Contents

Rolling Over Event and Access Logs

11 Sending Invalidation Requests

Invalidation from External Sources

Using Telnet to Send Invalidation Requests

Invalidation Request Syntax

Invalidation Response Syntax

Invalidation Preview Request Syntax

Invalidation Preview Response Syntax

Using OracleAS Web Cache Manager to Send Invalidation Requests

Submitting Basic Invalidation Requests

Submitting Advanced Invalidation Requests

Using Applications for Automated Invalidation Requests

Using Database Triggers for Automated Invalidation Requests

Using Scripts for Automated Invalidations

Invalidation Examples

Example: Invalidating One Document

Example: Invalidating Multiple Objects

Example: Invalidating a Subtree of Documents

Example: Invalidating All Documents for a Web Site

Example: Invalidating Documents Using Prefix Matching

Example: Invalidating Documents Using Substring and Query String Matching

Example: Invalidating Documents Using Search Key Matching

Example: Propagating Invalidation Requests Throughout a Cache Cluster

Example: Previewing Invalidation

Inline Invalidation in HTTP Response

Example: Using Inline Invalidation

Reducing Invalidation Overhead

Send Basic Invalidation Requests for Invalidating One Object

Use Substring Matching for Invalidating Multiple Objects in Advanced
Invalidations

Enhance Query String Invalidations

Using Search Keys in Surrogate-Key Response Header and Invalidation Requests

12 Logging Events, Diagnostics, and Access Information

Evaluating Event Logs

Format of the Event Log File

Configuring Event Logs

Event Log Examples

Displaying Diagnostic Information and Event Log Information in the HTML Body or
Server-Response Header Field

Evaluating Access Logs

Format of the Access Log Files

cs(header_name) and sc(header_name) Access Log Fields

Configuring Access Logs

Analyzing an Access Log File

Access Log Examples

13 Monitoring Performance

Monitoring OracleAS Web Cache Health

Gathering OracleAS Web Cache Performance Statistics

Gathering End-User Performance Data

Gathering Origin Server Performance Statistics

14 Troubleshooting OracleAS Web Cache Configuration

Startup Failures

Port Conflicts

Privileged Ports

Greater Than One Thousand Maximum Connections

Wallet Cannot Be Opened

Caching Rules

Common Edge Side Includes (ESI) Syntax Errors

Template Syntax Error Example

Fragment Syntax Error Example

Fragment Syntax Error with Exception Handling Example

Load on OracleAS Web Cache Computer

Invalidation Timeouts

Application Web Server Capacity

Content-Length Request-Header Field

HTTP 500 Response Status Codes

Browser-Specific Issues

Part III Reference

15 Edge Side Includes (ESI) Language Tags

Overview of ESI

Supported ESI Language Elements

Syntax Rules

Nesting Elements

Variable Expressions

Variable Usage

Variable Default Values

HTTP Request Variables

Exceptions and Errors

ESI Tag Descriptions

ESI choose | when | otherwise Tags

ESI comment Tag

ESI environment Tag

ESI include Tag

ESI inline Tag

ESI invalidate Tag

ESI remove Tag

ESI try | attempt | except Tags

ESI vars Tag

ESI <!--esi-->Tag

16 Event Log Messages

Message Format

Messages

A OracleAS Web Cache Directory Structure

B Invalidation and Statistics Document Type Definitions

Invalidation DTD

Invalidation Request and Response DTD

Invalidation Preview Request and Response DTD

Statistics DTD

Statistics Request and Response DTD

Groups of Statistics

Cache Information Groups

Runtime Statistics Groups

Site Information Groups

Origin Server Statistics Group

URL Statistics Group

Cache Reasons Group

Query Methods

Statistics Examples

Complete Statistics Template

C OracleAS Web Cache as a Standalone Product

Differences When OracleAS Web Cache Installed Standalone

OracleAS Web Cache Processes

webcachectl Utility Overview

webcachectl Utility Commands

webcachectl Parameter

Enabling Wallets to Open on Windows

D Caching with Third-Party Application Web Servers

Overview of Third-Party Application Servers

Web Site Configuration

Caching Rules and Expiration Rules

BEA WebLogic Server 6.0

WebLogic SnoopServlet

WebLogic SessionServlet

IBM WebSphere Application Server, Version 4.0

WebSphere Snoop Servlet

WebSphere SessionSample

Apache Tomcat, Version 4.1

Apache Tomcat Snoop JSP

Apache Tomcat Session Servlet

Microsoft IIS 5.0

ServerVariables_Jscript ASP

Cookie_Jscript ASP

Glossary

Index