org.opencms.loader
Class CmsResourceManager

java.lang.Object
  org.opencms.loader.CmsResourceManager

public class CmsResourceManager
extends Object

Collects all available resource loaders, resource types and resource collectors at startup and provides methods to access them during OpenCms runtime.

Since:

6.0.0

Version:

$Revision: 1.35 $

Author:

Alexander Kandzior

Field Summary

static String	MIMETYPE_HTML The mimetype "text/html".
static String	MIMETYPE_TEXT The mimetype "text/plain".

Constructor Summary

CmsResourceManager()
Creates a new instance for the resource manager, will be called by the vfs configuration manager.

Method Summary

I_CmsResourceCollector	addContentCollector(String className, String order) Adds a given content collector class to the type manager.
void	addLoader(I_CmsResourceLoader loader) Adds a new loader to the internal list of loaded loaders.
void	addResourceType(I_CmsResourceType resourceType) Adds a new resource type from the XML configuration to the internal list of loaded resource types.
I_CmsResourceCollector	getContentCollector(String collectorName) Returns the configured content collector with the given name, or null if no collector with this name is configured.
I_CmsResourceType	getDefaultTypeForName(String resourcename) Returns the default resource type for the given resource name, using the configured resource type file extensions.
Map	getExtensionMapping() Returns the file extensions (suffixes) mappings to resource types.
CmsResourceTranslator	getFileTranslator() Returns the file translator.
CmsResourceTranslator	getFolderTranslator() Returns the folder translator.
I_CmsResourceLoader	getLoader(CmsResource resource) Returns the loader class instance for a given resource.
I_CmsResourceLoader	getLoader(int id) Returns the loader class instance for the given loader id.
List	getLoaders() Returns the (unmodifyable array) list with all initialized resource loaders.
String	getMimeType(String filename, String encoding) Returns the mime type for a specified file name.
String	getMimeType(String filename, String encoding, String defaultMimeType) Returns the mime type for a specified file name.
List	getRegisteredContentCollectors() Returns an (unmodifiable) list of class names of all currently registered content collectors.
I_CmsResourceType	getResourceType(int typeId) Returns the initialized resource type instance for the given id.
I_CmsResourceType	getResourceType(String typeName) Returns the initialized resource type instance for the given resource type name.
List	getResourceTypes() Returns the (unmodifyable array) list with all initialized resource types.
CmsTemplateLoaderFacade	getTemplateLoaderFacade(CmsObject cms, CmsResource resource, String templateProperty) Returns a template loader facade for the given file.
void	initConfiguration()
void	initialize(CmsObject cms) Initializes all additional resource types stored in the modules.
void	loadResource(CmsObject cms, CmsResource resource, HttpServletRequest req, HttpServletResponse res) Loads the requested resource and writes the contents to the response stream.
String	resolveIncludeExtensions(String target, String element, boolean editable, Map paramMap, ServletRequest req, ServletResponse res) Extension method for handling special, loader depended actions during the include process.
void	setTranslators(CmsResourceTranslator folderTranslator, CmsResourceTranslator fileTranslator) Sets the folder and the file translator.
void	shutDown() Shuts down this resource manage instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIMETYPE_HTML

public static final String MIMETYPE_HTML

The mimetype "text/html".

See Also:

Constant Field Values

MIMETYPE_TEXT

public static final String MIMETYPE_TEXT

The mimetype "text/plain".

See Also:

Constant Field Values

Constructor Detail

CmsResourceManager

public CmsResourceManager()

Creates a new instance for the resource manager, will be called by the vfs configuration manager.

Method Detail

addContentCollector

public I_CmsResourceCollector addContentCollector(String className,
                                                  String order)
                                           throws CmsConfigurationException

Adds a given content collector class to the type manager.

Parameters:

className - the name of the class to add

order - the order number for this collector

Returns:

the created content collector instance

Throws:

CmsConfigurationException - in case the collector could not be properly initialized

addLoader

public void addLoader(I_CmsResourceLoader loader)
               throws CmsConfigurationException

Adds a new loader to the internal list of loaded loaders.

Parameters:

loader - the loader to add

Throws:

CmsConfigurationException - in case the resource manager configuration is already initialized

addResourceType

public void addResourceType(I_CmsResourceType resourceType)
                     throws CmsConfigurationException

Adds a new resource type from the XML configuration to the internal list of loaded resource types.

Resource types can also be added from a module.

Parameters:

resourceType - the resource type to add

Throws:

CmsConfigurationException - in case the resource manager configuration is already initialized

getContentCollector

public I_CmsResourceCollector getContentCollector(String collectorName)

Returns the configured content collector with the given name, or null if no collector with this name is configured.

Parameters:

collectorName - the name of the collector to get

Returns:

the configured content collector with the given name

getDefaultTypeForName

public I_CmsResourceType getDefaultTypeForName(String resourcename)
                                        throws CmsException

Returns the default resource type for the given resource name, using the configured resource type file extensions.

In case the given name does not map to a configured resource type, CmsResourceTypePlain is returned.

This is only required (and should not be used otherwise) when creating a new resource automatically during file upload or synchronization. Only in this case, the file type for the new resource is determined using this method. Otherwise the resource type is always stored as part of the resource, and is not related to the file name.

Parameters:

resourcename - the resource name to look up the resource type for

Returns:

the default resource type for the given resource name

Throws:

CmsException - if something goes wrong

getExtensionMapping

public Map getExtensionMapping()

Returns the file extensions (suffixes) mappings to resource types.

Returns:

a Map with all known file extensions as keys and their resource types as values.

getFileTranslator

public CmsResourceTranslator getFileTranslator()

Returns the file translator.

Returns:

the file translator

getFolderTranslator

public CmsResourceTranslator getFolderTranslator()

Returns the folder translator.

Returns:

the folder translator

getLoader

public I_CmsResourceLoader getLoader(CmsResource resource)
                              throws CmsLoaderException

Returns the loader class instance for a given resource.

Parameters:

resource - the resource

Returns:

the appropriate loader class instance

Throws:

CmsLoaderException - if something goes wrong

getLoader

public I_CmsResourceLoader getLoader(int id)

Returns the loader class instance for the given loader id.

Parameters:

id - the id of the loader to return

Returns:

the loader class instance for the given loader id

getLoaders

public List getLoaders()

Returns the (unmodifyable array) list with all initialized resource loaders.

Returns:

the (unmodifyable array) list with all initialized resource loaders

getMimeType

public String getMimeType(String filename,
                          String encoding)

Returns the mime type for a specified file name.

If an encoding parameter that is not null is provided, the returned mime type is extended with a ; charset={encoding} setting.

If no mime type for the given filename can be determined, the default MIMETYPE_HTML is used.

Parameters:

filename - the file name to check the mime type for

encoding - the default encoding (charset) in case of mime types is of type "text"

Returns:

the mime type for a specified file

getMimeType

public String getMimeType(String filename,
                          String encoding,
                          String defaultMimeType)

Returns the mime type for a specified file name.

If an encoding parameter that is not null is provided, the returned mime type is extended with a ; charset={encoding} setting.

If no mime type for the given filename can be determined, the privided default is used.

Parameters:

filename - the file name to check the mime type for

encoding - the default encoding (charset) in case of mime types is of type "text"

defaultMimeType - the default mime type to use if no matching type for the filename is found

Returns:

the mime type for a specified file

getRegisteredContentCollectors

public List getRegisteredContentCollectors()

Returns an (unmodifiable) list of class names of all currently registered content collectors.

Returns:

an (unmodifiable) list of class names of all currently registered content collectors

getResourceType

public I_CmsResourceType getResourceType(int typeId)
                                  throws CmsLoaderException

Returns the initialized resource type instance for the given id.

Parameters:

typeId - the id of the resource type to get

Returns:

the initialized resource type instance for the given id

Throws:

CmsLoaderException - if no resource type is available for the given id

getResourceType

public I_CmsResourceType getResourceType(String typeName)
                                  throws CmsLoaderException

Returns the initialized resource type instance for the given resource type name.

Parameters:

typeName - the name of the resource type to get

Returns:

the initialized resource type instance for the given name

Throws:

CmsLoaderException - if no resource type is available for the given name

getResourceTypes

public List getResourceTypes()

Returns the (unmodifyable array) list with all initialized resource types.

Returns:

the (unmodifyable array) list with all initialized resource types

getTemplateLoaderFacade

public CmsTemplateLoaderFacade getTemplateLoaderFacade(CmsObject cms,
                                                       CmsResource resource,
                                                       String templateProperty)
                                                throws CmsException

Returns a template loader facade for the given file.

Parameters:

cms - the current cms context

resource - the requested file

templateProperty - the property to read for the template

Returns:

a resource loader facade for the given file

Throws:

CmsException - if something goes wrong

initConfiguration

public void initConfiguration()

See Also:

I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cms)
                throws CmsRoleViolationException

Initializes all additional resource types stored in the modules.

Parameters:

cms - an initialized OpenCms user context with "module manager" role permissions

Throws:

CmsRoleViolationException - in case the provided OpenCms user context did not have "module manager" role permissions

loadResource

public void loadResource(CmsObject cms,
                         CmsResource resource,
                         HttpServletRequest req,
                         HttpServletResponse res)
                  throws ServletException,
                         IOException,
                         CmsException

Loads the requested resource and writes the contents to the response stream.

Parameters:

req - the current http request

res - the current http response

cms - the curren cms context

resource - the requested resource

Throws:

ServletException - if something goes wrong

IOException - if something goes wrong

CmsException - if something goes wrong

resolveIncludeExtensions

public String resolveIncludeExtensions(String target,
                                       String element,
                                       boolean editable,
                                       Map paramMap,
                                       ServletRequest req,
                                       ServletResponse res)
                                throws CmsException

Extension method for handling special, loader depended actions during the include process.

Note: If you have multiple loaders configured that require include extensions, all loaders are called in the order they are configured in.

Parameters:

target - the target for the include, might be null

element - the element to select form the target might be null

editable - the flag to indicate if the target is editable

paramMap - a map of parameters for the include, can be modified, might be null

req - the current request

res - the current response

Returns:

the modified target URI

Throws:

CmsException - in case something goes wrong

setTranslators

public void setTranslators(CmsResourceTranslator folderTranslator,
                           CmsResourceTranslator fileTranslator)

Sets the folder and the file translator.

Parameters:

folderTranslator - the folder translator to set

fileTranslator - the file translator to set

shutDown

public void shutDown()
              throws Exception

Shuts down this resource manage instance.

Throws:

Exception - in case of errors during shutdown