com.manydesigns.portofino.dispatcher

Class DispatcherLogic

java.lang.Object

com.manydesigns.portofino.dispatcher.DispatcherLogic

public class DispatcherLogic
extends Object

A collection of methods that operate on Dispatch instances and related objects.

Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DispatcherLogic.ConfigurationCacheEntry
protected static class	DispatcherLogic.FileCacheEntry<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_CACHE_CHECK_FREQUENCY
static String	CONFIGURATION_CACHE_SIZE
protected static com.google.common.cache.LoadingCache<File,DispatcherLogic.ConfigurationCacheEntry>	configurationCache
static String	copyright
static String	INVALID_PAGE_INSTANCE
static org.slf4j.Logger	logger
static String	PAGE_CACHE_CHECK_FREQUENCY
static String	PAGE_CACHE_SIZE
protected static com.google.common.cache.LoadingCache<File,DispatcherLogic.FileCacheEntry<Page>>	pageCache
protected static JAXBContext	pagesJaxbContext

Constructor Summary

Constructors

Constructor and Description
DispatcherLogic()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	appendChildrenToPagesSelectionProvider(File baseDir, File parentDir, String breadcrumb, DefaultSelectionProvider selectionProvider, boolean includeDetailChildren, File... excludes)
static void	clearConfigurationCache()
static void	clearConfigurationCache(Class configurationClass) Clears the cache from entries whose class matches exactly with the one passed as a parameter.
static void	configurePageAction(PageAction pageAction, PageInstance pageInstance)
static SelectionProvider	createPagesSelectionProvider(File baseDir, boolean includeRoot, boolean includeDetailChildren, File... excludes)
static SelectionProvider	createPagesSelectionProvider(File baseDir, File... excludes)
static PageAction	ensureActionBean(PageInstance page) Deprecated.
static Class<? extends PageAction>	getActionClass(Configuration configuration, File directory)
static Class<? extends PageAction>	getActionClass(Configuration configuration, File directory, boolean fallback)
static <T> T	getConfiguration(File configurationFile, Class<? extends T> configurationClass)
static Page	getPage(File directory)
protected static File	getPageFile(File directory)
static PageAction	getSubpage(Configuration configuration, PageInstance parentPageInstance, String pathFragment)
static void	init(Configuration portofinoConfiguration)
static void	initConfigurationCache(int maxSize, int refreshCheckFrequency)
static void	initPageCache(int maxSize, int refreshCheckFrequency)
static boolean	isValidActionClass(Class<?> actionClass)
static <T> T	loadConfiguration(File configurationFile, Class<? extends T> configurationClass)
static <T> T	loadConfiguration(InputStream inputStream, Class<? extends T> configurationClass)
static Page	loadPage(File key)
static Page	loadPage(InputStream inputStream)
static File	saveConfiguration(File directory, Object configuration)
static File	savePage(File directory, Page page) Persists a page to the file system.
static File	savePage(PageInstance pageInstance) Persists a page to the file system.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

logger

public static final org.slf4j.Logger logger

INVALID_PAGE_INSTANCE

public static final String INVALID_PAGE_INSTANCE

See Also:

Constant Field Values

pagesJaxbContext

protected static final JAXBContext pagesJaxbContext

PAGE_CACHE_SIZE

public static final String PAGE_CACHE_SIZE

See Also:

Constant Field Values

PAGE_CACHE_CHECK_FREQUENCY

public static final String PAGE_CACHE_CHECK_FREQUENCY

See Also:

Constant Field Values

CONFIGURATION_CACHE_SIZE

public static final String CONFIGURATION_CACHE_SIZE

See Also:

Constant Field Values

CONFIGURATION_CACHE_CHECK_FREQUENCY

public static final String CONFIGURATION_CACHE_CHECK_FREQUENCY

See Also:

Constant Field Values

pageCache

protected static com.google.common.cache.LoadingCache<File,DispatcherLogic.FileCacheEntry<Page>> pageCache

configurationCache

protected static com.google.common.cache.LoadingCache<File,DispatcherLogic.ConfigurationCacheEntry> configurationCache

Constructor Detail

DispatcherLogic

public DispatcherLogic()

Method Detail

createPagesSelectionProvider

public static SelectionProvider createPagesSelectionProvider(File baseDir,
                                             File... excludes)

createPagesSelectionProvider

public static SelectionProvider createPagesSelectionProvider(File baseDir,
                                             boolean includeRoot,
                                             boolean includeDetailChildren,
                                             File... excludes)

appendChildrenToPagesSelectionProvider

protected static void appendChildrenToPagesSelectionProvider(File baseDir,
                                          File parentDir,
                                          String breadcrumb,
                                          DefaultSelectionProvider selectionProvider,
                                          boolean includeDetailChildren,
                                          File... excludes)

savePage

public static File savePage(PageInstance pageInstance)
                     throws Exception

Persists a page to the file system.

Parameters:

pageInstance - the live PageInstance containing the Page to save.

Returns:

the file where the page was saved.

Throws:

Exception - in case the save fails.

savePage

public static File savePage(File directory,
            Page page)
                     throws Exception

Persists a page to the file system.

Parameters:

directory - the directory where to save the page.xml file.

page - the page to save.

Returns:

the file where the page was saved.

Throws:

Exception - in case the save fails.

init

public static void init(Configuration portofinoConfiguration)

initPageCache

public static void initPageCache(int maxSize,
                 int refreshCheckFrequency)

initConfigurationCache

public static void initConfigurationCache(int maxSize,
                          int refreshCheckFrequency)

clearConfigurationCache

public static void clearConfigurationCache()

clearConfigurationCache

public static void clearConfigurationCache(Class configurationClass)

Clears the cache from entries whose class matches exactly with the one passed as a parameter.

Parameters:

configurationClass - the class of the entries to remove.

getPageFile

protected static File getPageFile(File directory)

loadPage

public static Page loadPage(File key)
                     throws Exception

Throws:

Exception

loadPage

public static Page loadPage(InputStream inputStream)
                     throws JAXBException

Throws:

JAXBException

getPage

public static Page getPage(File directory)
                    throws PageNotActiveException

Throws:

PageNotActiveException

saveConfiguration

public static File saveConfiguration(File directory,
                     Object configuration)
                              throws Exception

Throws:

Exception

getConfiguration

public static <T> T getConfiguration(File configurationFile,
                     Class<? extends T> configurationClass)
                          throws Exception

Throws:

Exception

loadConfiguration

public static <T> T loadConfiguration(File configurationFile,
                      Class<? extends T> configurationClass)
                           throws Exception

Throws:

Exception

loadConfiguration

public static <T> T loadConfiguration(InputStream inputStream,
                      Class<? extends T> configurationClass)
                           throws Exception

Throws:

Exception

getActionClass

public static Class<? extends PageAction> getActionClass(Configuration configuration,
                                         File directory)

getActionClass

public static Class<? extends PageAction> getActionClass(Configuration configuration,
                                         File directory,
                                         boolean fallback)

isValidActionClass

public static boolean isValidActionClass(Class<?> actionClass)

ensureActionBean

@Deprecated
public static PageAction ensureActionBean(PageInstance page)
                                   throws IllegalAccessException,
                                          InstantiationException

Deprecated.

Throws:

IllegalAccessException

InstantiationException

configurePageAction

public static void configurePageAction(PageAction pageAction,
                       PageInstance pageInstance)
                                throws JAXBException,
                                       IOException

Throws:

JAXBException

IOException

getSubpage

public static PageAction getSubpage(Configuration configuration,
                    PageInstance parentPageInstance,
                    String pathFragment)
                             throws PageNotActiveException

Throws:

PageNotActiveException