de.mikromedia.webpages

Class WebpagePlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.thymeleaf.ThymeleafPlugin

de.mikromedia.webpages.WebpagePlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.event.ServiceRequestFilterListener, de.deepamehta.core.service.EventListener, WebpageService, org.osgi.framework.BundleActivator

public class WebpagePlugin
extends de.deepamehta.thymeleaf.ThymeleafPlugin
implements WebpageService

Collaborative, multi-site standard HTML web pages with DeepaMehta 4. ### FIXME: Usernames might not be compatible URIComponents.

Version:

0.4.5-SNAPSHOT - compatible with DeepaMehta 4.8.6+

Author:

Malte Reißig

Field Summary

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Fields inherited from interface de.mikromedia.webpages.WebpageService

REDIRECT_STATUS_CODE, REDIRECT_TARGET_URL, REDIRECT_WEB_ALIAS, STANDARD_STYLESHEET_URI, STANDARD_WEBSITE_PREFIX, STANDARD_WEBSITE_URI, WEBPAGE, WEBPAGE_CONTENT, WEBPAGE_TITLE, WEBPAGES_SHARING_MODE, WEBPAGES_WS_NAME, WEBPAGES_WS_URI, WEBSITE, WEBSITE_FOOTER, WEBSITE_NAME, WEBSITE_PREFIX, WEBSITE_STYLESHEET

Constructor Summary

Constructors

Constructor and Description
WebpagePlugin()

Method Summary

Modifier and Type	Method and Description
void	addTemplateResolverBundle(org.osgi.framework.Bundle bundle) IMPORTANT: If you register your own bundle as a resource for thymeleaf templates you must call reinitTemplateEngine afterwards.
String	doRedirectToWebsite(long websiteId)
List<MenuItem>	getActiveMenuItems(de.deepamehta.core.Topic website) Returns all topics of type de.mikromedia.menu.item related to the given `Website` topic.
com.sun.jersey.api.view.Viewable	getIndexWebpage() The method managing the root resource / frontpage.
List<Webpage>	getPublishedWebpages(String username) Lists all currently published webpages for the usernames website.
List<Webpage>	getPublishedWebpages(de.deepamehta.core.Topic websiteTopic) Lists and prepares all currently published webpages of the given website.
de.deepamehta.core.Topic	getStandardWebsite() Fetches the global standard website.
com.sun.jersey.api.view.Viewable	getWebpage(String webAlias) The methode serving anything on the first resource level at best this resolves to either a Webpage or a Webpage Redirect (301, 302) or 404.
List<Webpage>	getWebpagesSortedByTimestamp(List<Webpage> all, boolean lastModified)
de.deepamehta.core.Topic	getWebsite()
de.deepamehta.core.Topic	getWebsiteByPrefix(String value)
de.deepamehta.core.Topic	getWebsiteByUsername(String username) --------------------------------------------------------------------------------- REST API Resources -----
com.sun.jersey.api.view.Viewable	getWebsitePage(String sitePrefix, String webAlias) Serving a specific webpage assigned to the website related to its given prefix (currently "username").
void	init()
void	overrideFrontpageTemplate(String fileName)
void	reinitTemplateEngine()
void	removeTemplateResolverBundle(org.osgi.framework.Bundle bundle)
SearchResultList	searchWebsites(String query, String typeName)
void	setFrontpageAliases(HashMap aliases) TODO: Renanem to configureRootResources()
com.sun.jersey.api.view.Viewable	view(String fileName)
void	viewData(String key, Object value)

Methods inherited from class de.deepamehta.thymeleaf.ThymeleafPlugin

addTemplateResourceBundle, getTemplateEngine, initTemplateEngine, removeTemplateResourceBundle, serviceRequestFilter

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, preInstall, publishFileSystem, serviceArrived, serviceGone, setCoreService, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebpagePlugin

public WebpagePlugin()

Method Detail

init

public void init()

Specified by:

init in interface de.deepamehta.core.osgi.PluginContext

Overrides:

init in class de.deepamehta.core.osgi.PluginActivator

getIndexWebpage

public com.sun.jersey.api.view.Viewable getIndexWebpage()

The method managing the root resource / frontpage. Note: If overrideFrontpageTemplate() is used (frontpageTemplateName != null), the frontpage for the "standard" site is inaccessible.

Returns:

A processed Thymeleaf Template (Viewable).

getWebpage

public com.sun.jersey.api.view.Viewable getWebpage(String webAlias)

The methode serving anything on the first resource level at best this resolves to either a Webpage or a Webpage Redirect (301, 302) or 404.

Parameters:

webAlias - String URI compliant name of the resource without leading slash.

Returns:

A processed Thymeleaf Template (Viewable).

getWebsitePage

public com.sun.jersey.api.view.Viewable getWebsitePage(String sitePrefix,
                                                       String webAlias)

Serving a specific webpage assigned to the website related to its given prefix (currently "username").

Parameters:

sitePrefix -

webAlias -

Returns:

A processed Thymeleaf Template (Viewable).

getWebsiteByUsername

public de.deepamehta.core.Topic getWebsiteByUsername(String username)

--------------------------------------------------------------------------------- REST API Resources -----

Specified by:

getWebsiteByUsername in interface WebpageService

Returns:

The website for the given username.

searchWebsites

public SearchResultList searchWebsites(String query,
                                       String typeName)
                                throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

getWebsite

public de.deepamehta.core.Topic getWebsite()

doRedirectToWebsite

public String doRedirectToWebsite(long websiteId)
                           throws javax.ws.rs.WebApplicationException,
                                  URISyntaxException

Throws:

javax.ws.rs.WebApplicationException

URISyntaxException

getPublishedWebpages

public List<Webpage> getPublishedWebpages(String username)

Lists all currently published webpages for the usernames website.

Specified by:

getPublishedWebpages in interface WebpageService

Parameters:

username -

Returns:

All webpage topics associated with the website for the given username not marked as \"Drafts\".

getPublishedWebpages

public List<Webpage> getPublishedWebpages(de.deepamehta.core.Topic websiteTopic)

Lists and prepares all currently published webpages of the given website.

Specified by:

getPublishedWebpages in interface WebpageService

Parameters:

websiteTopic -

Returns:

All webpage topics associated with the website for the given username and not marked as \"Drafts\".

getActiveMenuItems

public List<MenuItem> getActiveMenuItems(de.deepamehta.core.Topic website)

Returns all topics of type de.mikromedia.menu.item related to the given `Website` topic.

Specified by:

getActiveMenuItems in interface WebpageService

Parameters:

website -

Returns:

All topics of type menu item associated with the given website.

getStandardWebsite

public de.deepamehta.core.Topic getStandardWebsite()

Fetches the global standard website.

Specified by:

getStandardWebsite in interface WebpageService

Returns:

A topic representing the global standard website which is unrelated to any username. Its pages are accessible under the root resource.

getWebsiteByPrefix

public de.deepamehta.core.Topic getWebsiteByPrefix(String value)

getWebpagesSortedByTimestamp

public List<Webpage> getWebpagesSortedByTimestamp(List<Webpage> all,
                                                  boolean lastModified)

Specified by:

getWebpagesSortedByTimestamp in interface WebpageService

overrideFrontpageTemplate

public void overrideFrontpageTemplate(String fileName)

Specified by:

overrideFrontpageTemplate in interface WebpageService

setFrontpageAliases

public void setFrontpageAliases(HashMap aliases)

TODO: Renanem to configureRootResources()

Specified by:

setFrontpageAliases in interface WebpageService

viewData

public void viewData(String key,
                     Object value)

Specified by:

viewData in interface WebpageService

Overrides:

viewData in class de.deepamehta.thymeleaf.ThymeleafPlugin

view

public com.sun.jersey.api.view.Viewable view(String fileName)

Specified by:

view in interface WebpageService

Overrides:

view in class de.deepamehta.thymeleaf.ThymeleafPlugin

reinitTemplateEngine

public void reinitTemplateEngine()

Specified by:

reinitTemplateEngine in interface WebpageService

addTemplateResolverBundle

public void addTemplateResolverBundle(org.osgi.framework.Bundle bundle)

Description copied from interface: WebpageService

IMPORTANT: If you register your own bundle as a resource for thymeleaf templates you must call reinitTemplateEngine afterwards.

Specified by:

addTemplateResolverBundle in interface WebpageService

removeTemplateResolverBundle

public void removeTemplateResolverBundle(org.osgi.framework.Bundle bundle)

Specified by:

removeTemplateResolverBundle in interface WebpageService