Sun Java System Web Proxy Server 4.0.1 Administration Guide |
Chapter 16
Managing Templates and ResourcesTemplates allow you to group URLs together so that you can configure how the proxy handles them. You can make the proxy behave differently depending on the URL the client tries to retrieve. For example, you might require the client to authenticate (type in a user name and password) when accessing URLs from a specific domain. Or, you might deny access to URLs that point to image files. You can configure different cache refresh settings based on the file type.
This chapter has the following sections:
About TemplatesA template is a collection of URLs, called resources. A resource might be a single URL, a group of URLs that have something in common, or an entire protocol. You name and create a template and then you assign URLs to that template by using regular expressions. This means that you can configure the proxy server to handle requests for various URLs differently. Any URL pattern you can create with regular expressions can be included in a template. Table # lists the default resources and provides some ideas for other templates.
Understanding Regular Expressions
Proxy Server allows you to use regular expressions to identify resources. Regular expressions specify a pattern of character strings. In the proxy server, regular expressions are used to find matching patterns in URLs.
Here is an example of a regular expression:
[a-z]*://[^:/]*\.abc\.com.*>
This regular expression would match any documents from the .abc.com domain. The documents could be of any protocol and could have any file extension.
Table 16-2 contains regular expressions and their corresponding meanings.
This example illustrates how you can use some of the regular expressions in Table #.
[a-z]*://([^.:/]*[:/]|.*\.local\.com).*"
- [a-z]* matches a document of any protocol.
- :// matches a (:) followed by (//).
- [^.:/]*[:/] matches any character string that does not include a (.),(:) or (/), and is followed by either a (:) or a (/). It therefore matches host names that are not fully qualified and hosts with port numbers.
- |.*\.local\.com does not match fully qualified domain name host names such as local.com but does match documents in the .local.com domain.
- .*" matches documents with any file extension.
Note
As noted in Table #, the backslash can be used to escape or remove the meaning of special characters. Characters such as the period and question mark have special meanings, and therefore, must be escaped if they are used to represent themselves. The period, in particular, is found in many URLs. So, to remove the special meaning of the period in your regular expression, you need to precede it with a backslash.
Understanding Wildcard Patterns
You can create lists of wildcard patterns that enable you to specify which URLs can be accessed from your site. Wildcards can be in the form of regular expressions or shell expressions, depending on usage. As a general rule:
- Use regular expressions for any pattern that matches destination URLs. This includes <Object ppath=...>, URL filters, and the NameTrans, PathCheck, and ObjectType functions.
- Use shell expressions for any pattern that matches incoming client or user IDs, including user names and groups for access control and the IP addresses or DNS names of incoming users (for example, <Client dns=...>).
You can specify several URLs by using regular expression wildcard patterns. Wildcards let you filter by domain name or by any URL with a given word in the URL. For example, you might want to block access to URLs that contain the string “careers.” To do this, you could specify http://.*careers.* as the regular expression for the template.
Creating New TemplatesYou can create a template using a regular expression wildcard pattern. You can then configure aspects that affect only the URLs specified in that template. For example, you might use one type of caching configuration for .GIF images and another for plain .HTML files.
To create a template
- Access the Server Manager, and click the Templates tab.
Click the Create Template link. The Create Template page displays.
- In the Template Name field, type a name for the template you are creating, and click OK.
The name should be something you can easily remember. The Server Manager prompts you to save and apply your changes. You can save the changes after you create a regular expression for the template, as described in the remaining steps.
Applying TemplatesTo apply a template
- Access the Server Manager, and click the Templates tab.
- Click the Apply Template link. The Apply Template page displays.
- Type a regular expression wildcard pattern that includes all of the URLs you want to include in your template in the URL Prefix Wildcard field.
- From the Template list, select the name of the new template you just added.
- Click OK.
- Click Restart Required. The Apply Changes page displays.
- Click the Restart Proxy Server button to apply the changes.
Removing TemplatesYou can remove existing templates. Removing a template deletes all of the associated configurations for the template. For example, if you have access control set up for all URLs in the template TEST, removing the TEST template also removes the access control to the URLs contained in then template.
To remove a template
Viewing TemplatesYou can view and edit the templates created in the Server Manager.
To edit a template
- Access the Server Manager, and click the Templates tab.
- Click the View Template link. The View Template page displays. The templates are shown in a table that lists the regular expression for the template and the template name.
- To edit an existing template, click the Edit Template Assignment link, which takes you to the Apply Template page.
Removing ResourcesYou can delete an entire regular expression object and its corresponding configurations with the Remove Resource page. For instance, you can remove the gopher resource so that all settings associated with that resource will be removed from the proxy server’s configuration files.
To remove a resource
- Access the Server Manager, and click the Templates tab.
- Click the Remove Resource link. The Remove Resource page displays.
- Select the resource you want to remove by choosing it from the Remove drop-down list.
- Click OK.
- Click Restart Required. The Apply Changes page displays.
- Click the Restart Proxy Server button to apply the changes.