org.apache.jetspeed.portalsite
Interface PortalSiteContentTypeMapper


public interface PortalSiteContentTypeMapper

This interface defines the content type mapper component for use with the portal-site component.

Version:
$Id:$
Author:
Randy Watler

Field Summary
static java.lang.String FOLDER_SYSTEM_TYPE
           
static java.lang.String PAGE_SYSTEM_TYPE
           
static java.lang.String TEMPLATE_SYSTEM_TYPE
           
 
Method Summary
 boolean isContentTypeFallbackEnabled()
          isContentTypeFallbackEnabled - enable content type fallback for missing system type page, folder, etc.
 java.lang.String mapContentRequestPath(java.lang.String serverName, java.lang.String contentType, java.lang.String requestPath)
          mapContentRequestPath - map content request path given previously mapped content type to external content path; implementation should return null to indicate no mapping is available.
 java.lang.String mapContentType(java.lang.String requestPath)
          mapContentType - map request to content type used to select dynamic pages; implementation should return null to handle request as page and folder lookup.
 java.lang.String mapDynamicRequestPath(java.lang.String serverName, java.lang.String contentType, java.lang.String requestPath)
          mapDynamicRequestPath - map content request path given previously mapped content type to dynamic page; implementation should return null to indicate no mapping is available.
 java.lang.String mapSystemRequestPath(java.lang.String serverName, java.lang.String contentType, java.lang.String requestPath)
          mapSystemRequestPath - map content request path given previously mapped content type to existing system page or folder; implementation should return null to indicate no mapping is available.
 java.lang.String mapSystemType(java.lang.String requestPath)
          mapSystemType - map request to system type; implementation should return null if type is not known.
 

Field Detail

PAGE_SYSTEM_TYPE

static final java.lang.String PAGE_SYSTEM_TYPE
See Also:
Constant Field Values

TEMPLATE_SYSTEM_TYPE

static final java.lang.String TEMPLATE_SYSTEM_TYPE
See Also:
Constant Field Values

FOLDER_SYSTEM_TYPE

static final java.lang.String FOLDER_SYSTEM_TYPE
See Also:
Constant Field Values
Method Detail

mapSystemType

java.lang.String mapSystemType(java.lang.String requestPath)
mapSystemType - map request to system type; implementation should return null if type is not known.

Parameters:
requestPath - raw portal request path
Returns:
mapped system type string or null

isContentTypeFallbackEnabled

boolean isContentTypeFallbackEnabled()
isContentTypeFallbackEnabled - enable content type fallback for missing system type page, folder, etc. requests

Returns:
content type fallback enabled flag

mapContentType

java.lang.String mapContentType(java.lang.String requestPath)
mapContentType - map request to content type used to select dynamic pages; implementation should return null to handle request as page and folder lookup.

Parameters:
requestPath - raw portal request path
Returns:
mapped content type string or null

mapSystemRequestPath

java.lang.String mapSystemRequestPath(java.lang.String serverName,
                                      java.lang.String contentType,
                                      java.lang.String requestPath)
mapSystemRequestPath - map content request path given previously mapped content type to existing system page or folder; implementation should return null to indicate no mapping is available.

Parameters:
serverName - request server name
contentType - mapped content type
requestPath - raw portal request path
Returns:
mapped system page or folder path or null

mapDynamicRequestPath

java.lang.String mapDynamicRequestPath(java.lang.String serverName,
                                       java.lang.String contentType,
                                       java.lang.String requestPath)
mapDynamicRequestPath - map content request path given previously mapped content type to dynamic page; implementation should return null to indicate no mapping is available.

Parameters:
serverName - request server name
contentType - mapped content type
requestPath - raw portal request path
Returns:
mapped dynamic page path or null

mapContentRequestPath

java.lang.String mapContentRequestPath(java.lang.String serverName,
                                       java.lang.String contentType,
                                       java.lang.String requestPath)
mapContentRequestPath - map content request path given previously mapped content type to external content path; implementation should return null to indicate no mapping is available.

Parameters:
serverName - request server name
contentType - mapped content type
requestPath - raw portal request path
Returns:
mapped dynamic page path or null


Copyright © 1999-2011 The Apache Software Foundation. All Rights Reserved.