org.apache.jetspeed.page.document

Interface DocumentHandlerFactory

public interface DocumentHandlerFactory

DocumentHandlerFactory

Factory for generating DocumentHandlers for specific document types

Version:

$Id: DocumentHandlerFactory.java 721971 2008-12-01 05:44:52Z rwatler $

Author:

Scott T. Weaver

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getConstraintsEnabled() getConstraintsEnabled
DocumentHandler	getDocumentHandler(String documentType) getDocumentHandler
DocumentHandler	getDocumentHandlerForPath(String documentPath) getDocumentHandlerForPath
boolean	getPermissionsEnabled() getPermissionsEnabled
void	registerDocumentHandler(DocumentHandler documentHandler) addDocumentHandler
void	setConstraintsEnabled(boolean enabled) setConstraintsEnabled
void	setPermissionsEnabled(boolean enabled) setPermissionsEnabled
void	shutdown() shutdown - gracefully shutdown handlers and disconnect from other singleton components, (e.g.

Method Detail

getDocumentHandler

DocumentHandler getDocumentHandler(String documentType)
                                   throws UnsupportedDocumentTypeException

getDocumentHandler

Parameters:

documentType - document type to retreive a handler for. Examples: .psml, .link

Returns:

DocumentHanlder for the documentType indicated. Never returns null.

Throws:

UnsupportedDocumentTypeException - If no handler has been registered for the documentType argument.

getDocumentHandlerForPath

DocumentHandler getDocumentHandlerForPath(String documentPath)
                                          throws UnsupportedDocumentTypeException

getDocumentHandlerForPath

Parameters:

documentPath -

Returns:

Throws:

UnsupportedDocumentTypeException

registerDocumentHandler

void registerDocumentHandler(DocumentHandler documentHandler)
                             throws DocumentTypeAlreadyRegisteredException

addDocumentHandler

Parameters:

documentHandler -

Throws:

DocumentTypeAlreadyRegisteredException

getConstraintsEnabled

boolean getConstraintsEnabled()

getConstraintsEnabled

Returns:

enabled indicator

setConstraintsEnabled

void setConstraintsEnabled(boolean enabled)

setConstraintsEnabled

Parameters:

enabled - indicator

getPermissionsEnabled

boolean getPermissionsEnabled()

getPermissionsEnabled

Returns:

enabled indicator

setPermissionsEnabled

void setPermissionsEnabled(boolean enabled)

setPermissionsEnabled

Parameters:

enabled - indicator

shutdown

void shutdown()

shutdown - gracefully shutdown handlers and disconnect from other singleton components, (e.g. shared caches)