Advanced

Advanced topics

Servlet: Default

com.pageseeder.Default

Description

This servlet accepts GET, HEAD or OPTIONS requests for a file (document) stored on PageSeeder, checks access permission and fetches the file.

It must be accessed via one of the following URL paths:

  • /ps/uri/[ps-uriid][ext] (e.g. /ps/uri/123 or /ps/uri/123.gif)
  • /ps/docid/[ps-docid] (e.g. /ps/docid/myid123)
  • [ps-docPath] (e.g. /ps/acme/specs/mydoc.psml)

If publication=true and publicationid is not specified then the publications for this document (that the current member can access) are ordered alphabetically by display title (then by ID) and the first publication is used.

The HTTP cache headers returned depend on the publication (if any) and whether there is any content transcluded from other documents as follows:

no publicationpublication root accessible to ps-grouppublication root NOT accessible to ps-group
transcluded content
Cache-Control:
 no-cache
Cache-Control:
 no-cache
Cache-Control:
 no-cache
NO transcluded content
Cache-Control:
 must-revalidate
ETag:
 [document etag]
Last-Modified:
 [document
  modified date]
Cache-Control:
 must-revalidate
ETag:
 [publication etag]
Last-Modified:
 [publication
  modified date]
Cache-Control:
 private,
 must-revalidate
ETag:
 [publication etag]
Last-Modified:
 [publication
  modified date]

 

HTTP Parameters

NameDescriptionRequiredTypeDefault value
ps-uriidThe URI ID of the document (required if no ps-docPath or ps-docid and overrides them)maybelong[from path info]
ps-docidThe document ID of the document (required if no ps-docPath or ps-docid and overrides ps-docPath)maybestring[from path info]
ps-docPathThe path for the document (required if no ps-uriid or ps-docid)maybepath[from path info]
ps-groupThe group for the document edits (different groups can have different edits)nostring[the first user's group with access]
ps-versionidThe version ID of the document/metadata to returnnolong
ps-versionThe version of the document/metadata to return (overrides ps-versionid)nostring[current version]
ps-compareidThe version ID to compare the selected version withnolong
ps-compareThe version to compare the selected version with (overrides ps-comparid)nostring
ps-compare-diffxWhether to include diffx markup for comparison (if no ps-compare compare with current)nobooleanfalse
ps-transcludeWhether to transclude content for transclude XRefsnobooleanfalse
ps-reloadWhether to refresh the document cache contentsnobooleanfalse
psmlWhether to return PSML metadata for non-PSML filesnobooleanfalse
positionThe position (instance number) of this document in the publication (requires publication=true)nointeger[first embedded position of URI]
publicationWhether to make publication adjustments (e.g. numbering) in content (requires ps-transclude=true)nobooleanfalse
publicationidThe ID of the publication context for this document to return numbering (requires publication=true, ps-transclude=true).nopublicationid[first publication found for URI]
behaviorIf set to 'download' add filename attachment headers to trigger download by browser.nostring

Created on , last edited on