com.fredhopper.server

Class DocumentationContextHandlerFactory

java.lang.Object

com.fredhopper.server.DocumentationContextHandlerFactory

All Implemented Interfaces:

ContextHandlerFactory

public class DocumentationContextHandlerFactory
extends Object
implements ContextHandlerFactory

A ContextHandlerFactory that creates a context located at /docs if the necessary elements are available in the provided environment.

Constructor Summary

Constructors

Constructor and Description
DocumentationContextHandlerFactory()

Method Summary

Modifier and Type	Method and Description
protected boolean	containsDocumentation(Path docsRoot) Checks if the documentation root path contains actual documentation.
org.eclipse.jetty.server.handler.ContextHandler	createContextHandler(com.fredhopper.environment.Environment environment) Creates an instance of ContextHandler using the provided Environment.
protected org.eclipse.jetty.server.handler.ContextHandler	createDocumentationContext(Path docsRoot) Creates a ContextHandler with ResourceHandler using the root of documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationContextHandlerFactory

public DocumentationContextHandlerFactory()

Method Detail

createContextHandler

public org.eclipse.jetty.server.handler.ContextHandler createContextHandler(com.fredhopper.environment.Environment environment)

Description copied from interface: ContextHandlerFactory

Creates an instance of ContextHandler using the provided Environment.

Specified by:

createContextHandler in interface ContextHandlerFactory

Parameters:

environment - the environment of the embedded server

Returns:

an instance of ContextHandler or null of no context can be created.

createDocumentationContext

protected org.eclipse.jetty.server.handler.ContextHandler createDocumentationContext(Path docsRoot)

Creates a ContextHandler with ResourceHandler using the root of documentation.

Parameters:

docsRoot - the path to the documentation root

Returns:

an instance ContextHandler

containsDocumentation

protected boolean containsDocumentation(Path docsRoot)

Checks if the documentation root path contains actual documentation.

Parameters:

docsRoot - the documentation root path

Returns:

true if the documentation default index.html is readable in the documentation root path; otherwise false