Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Class SemanticCMS

java.lang.Object

com.semanticcms.core.servlet.SemanticCMS

public class SemanticCMS
extends Object

The SemanticCMS application context.

TODO: Consider custom EL resolver for this variable. http://stackoverflow.com/questions/5016965/how-to-add-a-custom-variableresolver-in-pure-jsp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SemanticCMS.Initializer	Exposes the application context as an application-scope SemanticCMS instance named "APPLICATION_ATTRIBUTE_NAME".
static interface	SemanticCMS.LinkCssClassResolver<E extends Element>	Resolves the link CSS class for the given types of elements.
static interface	SemanticCMS.ListItemCssClassResolver<N extends Node>	Resolves the list item CSS class for the given types of nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopeEE.Application.Attribute<SemanticCMS>	APPLICATION_ATTRIBUTE
static final ScopeEE.Application.Attribute<SemanticCMS>	APPLICATION_ATTRIBUTE_OLD
static final String	DEFAULT_THEME_NAME	The default theme is used when no other theme is registered.
static final String	DEFAULT_VIEW_NAME	The default view is the content view and will have the empty view name.
static final String	VIEW_PARAM	The parameter name used for views.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SemanticCMS(ServletContext servletContext)

Method Summary

Modifier and Type	Method	Description
void	addComponent(Component component)	Registers a new component.
void	addCssLink(String cssLink)	Deprecated, for removal: This API element is subject to removal in a future version. Please use RegistryEE directly.
void	addHeadInclude(String headInclude)	Registers a new head include.
<E extends Element> void	addLinkCssClass(Class<E> elementType, String cssLinkClass)	Registers a new CSS class to use in link to the given type of element.
<E extends Element> void	addLinkCssClassResolver(Class<E> elementType, SemanticCMS.LinkCssClassResolver<? super E> cssLinkClassResolver)	Registers a new CSS resolver to use in link to the given type of element.
<N extends Node> void	addListItemCssClass(Class<N> nodeType, String listItemCssClass)	Registers a new CSS class to use in list items to the given type of node.
<N extends Node> void	addListItemCssClassResolver(Class<N> nodeType, SemanticCMS.ListItemCssClassResolver<? super N> listItemCssClassResolver)	Registers a new CSS resolver to use in list items to the given type of node.
void	addPrintCssLink(String printCssLink)	Deprecated, for removal: This API element is subject to removal in a future version. Please use RegistryEE directly.
void	addScript(String name, String src)	Registers a new script.
void	addTheme(Theme theme)	Registers a new theme.
void	addView(View view)	Registers a new view.
protected void	destroy()	Called when the context is shutting down.
Book	getBook(String servletPath)	Gets the book for the provided context-relative servlet path or null if no book configured at that path.
Book	getBook(HttpServletRequest request)	Gets the book for the provided request or null if no book configured at the current request path.
Map<String,Book>	getBooks()
List<Component>	getComponents()	Gets all components in an undefined, but consistent (within a single run) ordering.
Set<String>	getCssLinks()	Deprecated, for removal: This API element is subject to removal in a future version. Please use RegistryEE directly.
boolean	getDemoMode()	When true, a cursory attempt will be made to hide sensitive information for demo mode.
Executors	getExecutors()	A shared executor available to all components.
Set<String>	getHeadIncludes()	Gets the head includes, in the order added.
static SemanticCMS	getInstance(ServletContext servletContext)	Gets the SemanticCMS instance, creating it if necessary.
<E extends Element> String	getLinkCssClass(E element)	Gets the CSS class to use in links to the given element.
<N extends Node> String	getListItemCssClass(N node)	Gets the CSS class to use in list items to the given node.
Set<String>	getMissingBooks()
Set<String>	getPrintCssLinks()	Deprecated, for removal: This API element is subject to removal in a future version. Please use RegistryEE directly.
Book	getRootBook()	Gets the root book as configured in /WEB-INF/books.properties
Map<String,String>	getScripts()	Gets the scripts, in the order added.
Map<String,Theme>	getThemes()	Gets the themes, in the order added.
Set<View.Group>	getViewGroups()	Gets all view groups.
SortedSet<View>	getViews()	Gets the views, ordered by view group then display.
Map<String,View>	getViewsByName()	Gets the views in order added.

Methods inherited from class java.lang.Object

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

Field Details

APPLICATION_ATTRIBUTE

public static final ScopeEE.Application.Attribute<SemanticCMS> APPLICATION_ATTRIBUTE

APPLICATION_ATTRIBUTE_OLD

public static final ScopeEE.Application.Attribute<SemanticCMS> APPLICATION_ATTRIBUTE_OLD

VIEW_PARAM

public static final String VIEW_PARAM

The parameter name used for views.

See Also:

• Constant Field Values

DEFAULT_VIEW_NAME

public static final String DEFAULT_VIEW_NAME

The default view is the content view and will have the empty view name.

See Also:

• Constant Field Values

DEFAULT_THEME_NAME

public static final String DEFAULT_THEME_NAME

The default theme is used when no other theme is registered.

See Also:

• Constant Field Values

Constructor Details

SemanticCMS

protected SemanticCMS(ServletContext servletContext)
               throws IOException,
SAXException,
ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

Method Details

getInstance

public static SemanticCMS getInstance(ServletContext servletContext)

Gets the SemanticCMS instance, creating it if necessary.

destroy

protected void destroy()

Called when the context is shutting down.

getDemoMode

public boolean getDemoMode()

When true, a cursory attempt will be made to hide sensitive information for demo mode.

getBooks

public Map<String,Book> getBooks()

getMissingBooks

public Set<String> getMissingBooks()

getRootBook

public Book getRootBook()

Gets the root book as configured in /WEB-INF/books.properties

getBook

public Book getBook(String servletPath)

Gets the book for the provided context-relative servlet path or null if no book configured at that path. The book with the longest prefix match is used. The servlet path must begin with a slash (/).

getBook

public Book getBook(HttpServletRequest request)

Gets the book for the provided request or null if no book configured at the current request path.

getViewGroups

public Set<View.Group> getViewGroups()

Gets all view groups.

getViewsByName

public Map<String,View> getViewsByName()

Gets the views in order added.

getViews

public SortedSet<View> getViews()

Gets the views, ordered by view group then display.

See Also:

• View.compareTo(com.semanticcms.core.servlet.View)

addView

public void addView(View view)
             throws IllegalStateException

Registers a new view.

Throws:

IllegalStateException - if a view is already registered with the name.

getComponents

public List<Component> getComponents()

Gets all components in an undefined, but consistent (within a single run) ordering.

addComponent

public void addComponent(Component component)

Registers a new component.

getThemes

public Map<String,Theme> getThemes()

Gets the themes, in the order added.

addTheme

public void addTheme(Theme theme)
              throws IllegalStateException

Registers a new theme.

Throws:

IllegalStateException - if a theme is already registered with the name.

getCssLinks

@Deprecated(forRemoval=true)
public Set<String> getCssLinks()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use RegistryEE directly.

Gets the CSS links, in the order added.

addCssLink

@Deprecated(forRemoval=true)
public void addCssLink(String cssLink)
                throws IllegalStateException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use RegistryEE directly.

Registers a new CSS link.

Throws:

IllegalStateException - if the link is already registered.

getPrintCssLinks

@Deprecated(forRemoval=true)
public Set<String> getPrintCssLinks()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use RegistryEE directly.

Gets the print CSS links, in the order added.

addPrintCssLink

@Deprecated(forRemoval=true)
public void addPrintCssLink(String printCssLink)
                     throws IllegalStateException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use RegistryEE directly.

Registers a new print CSS link.

Throws:

IllegalStateException - if the link is already registered.

getScripts

public Map<String,String> getScripts()

Gets the scripts, in the order added.

addScript

public void addScript(String name,
 String src)
               throws IllegalStateException

Registers a new script. When a script is added multiple times, the src must be consistent between adds. Also, a src may not be added under different names.

Parameters:

name - the name of the script, independent of version and src

src - the src of the script.

Throws:

IllegalStateException - if the script already registered but with a different src.

getHeadIncludes

public Set<String> getHeadIncludes()

Gets the head includes, in the order added.

addHeadInclude

public void addHeadInclude(String headInclude)
                    throws IllegalStateException

Registers a new head include.

Throws:

IllegalStateException - if the link is already registered.

getLinkCssClass

public <E extends Element> String getLinkCssClass(E element)

Gets the CSS class to use in links to the given element. Also looks for match on parent classes up to and including Element itself.

Returns:

The CSS class or null when element is null or no class registered for it or any super class.

See Also:

• SemanticCMS.LinkCssClassResolver.getCssLinkClass(com.semanticcms.core.model.Element)

addLinkCssClassResolver

public <E extends Element> void addLinkCssClassResolver(Class<E> elementType,
 SemanticCMS.LinkCssClassResolver<? super E> cssLinkClassResolver)
                                                 throws IllegalStateException

Registers a new CSS resolver to use in link to the given type of element.

Throws:

IllegalStateException - if the element type is already registered.

addLinkCssClass

public <E extends Element> void addLinkCssClass(Class<E> elementType,
 String cssLinkClass)
                                         throws IllegalStateException

Registers a new CSS class to use in link to the given type of element.

Throws:

IllegalStateException - if the element type is already registered.

getListItemCssClass

public <N extends Node> String getListItemCssClass(N node)

Gets the CSS class to use in list items to the given node. Also looks for match on parent classes up to and including Node itself.

Returns:

The CSS class or null when node is null or no class registered for it or any super class.

See Also:

• SemanticCMS.ListItemCssClassResolver.getListItemCssClass(com.semanticcms.core.model.Node)

addListItemCssClassResolver

public <N extends Node> void addListItemCssClassResolver(Class<N> nodeType,
 SemanticCMS.ListItemCssClassResolver<? super N> listItemCssClassResolver)
                                                  throws IllegalStateException

Registers a new CSS resolver to use in list items to the given type of node.

Throws:

IllegalStateException - if the node type is already registered.

addListItemCssClass

public <N extends Node> void addListItemCssClass(Class<N> nodeType,
 String listItemCssClass)
                                          throws IllegalStateException

Registers a new CSS class to use in list items to the given type of node.

Throws:

IllegalStateException - if the node type is already registered.

getExecutors

public Executors getExecutors()

A shared executor available to all components.

Consider selecting concurrent or sequential implementations based on overall system load. See ConcurrencyCoordinator.isConcurrentProcessingRecommended(javax.servlet.ServletRequest).

See Also:

• ConcurrencyCoordinator.isConcurrentProcessingRecommended(javax.servlet.ServletRequest)