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 webpages with DeepaMehta 4. ### FIXME: Usernames might not be compatible URIComponents.

Version:

0.4 - compatible with DeepaMehta 4.8

Author:

Malte Reißig (Mail)

Field Summary

Fields

Modifier and Type	Field and Description
static de.deepamehta.core.service.accesscontrol.SharingMode	WEBPAGES_SHARING_MODE
static String	WEBPAGES_WS_NAME
static String	WEBPAGES_WS_URI

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

bundle, dm4, mf

Constructor Summary

Constructors

Constructor and Description
WebpagePlugin()

Method Summary

Methods

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<MenuItemViewModel>	getActiveMenuItems(de.deepamehta.core.Topic site) Returns all topics of type de.mikromedia.menu.item related to the given `Website` topic.
com.sun.jersey.api.view.Viewable	getFrontpageView() The method managing the root resource / frontpage.
com.sun.jersey.api.view.Viewable	getPageView(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.
com.sun.jersey.api.view.Viewable	getPageView(String prefix, String webAlias) Serving a specific webpage assigned to the website related to its given prefix (currently "username").
List<WebpageViewModel>	getPublishedWebpages(String username) Lists all currently published webpages for the usernames website.
List<WebpageViewModel>	getPublishedWebpages(de.deepamehta.core.Topic website) Lists and prepares all currently published webpages of the given website.
de.deepamehta.core.Topic	getStandardWebsite() Bring it back the old "Standard Site", give "admin" back her personal one!
de.deepamehta.core.Topic	getWebsite()
de.deepamehta.core.Topic	getWebsiteByUsername(String username) --------------------------------------------------------------------------------- REST API Resources -----
com.sun.jersey.api.view.Viewable	getWebsiteFrontpage(String username)
void	init()
void	overrideFrontpageTemplate(String fileName)
void	reinitTemplateEngine()
void	removeTemplateResolverBundle(org.osgi.framework.Bundle bundle)
void	setFrontpageAliases(HashMap aliases)
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

Field Detail

WEBPAGES_WS_URI

public static final String WEBPAGES_WS_URI

See Also:

Constant Field Values

WEBPAGES_WS_NAME

public static final String WEBPAGES_WS_NAME

See Also:

Constant Field Values

WEBPAGES_SHARING_MODE

public static final de.deepamehta.core.service.accesscontrol.SharingMode WEBPAGES_SHARING_MODE

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

getFrontpageView

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

The method managing the root resource / frontpage.

Returns:

A processed Thymeleaf Template (Viewable).

getPageView

public com.sun.jersey.api.view.Viewable getPageView(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).

getPageView

public com.sun.jersey.api.view.Viewable getPageView(String prefix,
                                           String webAlias)

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

Parameters:

prefix -

webAlias -

Returns:

A processed Thymeleaf Template (Viewable).

overrideFrontpageTemplate

public void overrideFrontpageTemplate(String fileName)

Specified by:

overrideFrontpageTemplate in interface WebpageService

setFrontpageAliases

public void setFrontpageAliases(HashMap aliases)

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

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.

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<WebpageViewModel> 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<WebpageViewModel> getPublishedWebpages(de.deepamehta.core.Topic website)

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

Specified by:

getPublishedWebpages in interface WebpageService

Parameters:

website -

Returns:

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

getWebsiteFrontpage

public com.sun.jersey.api.view.Viewable getWebsiteFrontpage(String username)

getActiveMenuItems

public List<MenuItemViewModel> getActiveMenuItems(de.deepamehta.core.Topic site)

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

Specified by:

getActiveMenuItems in interface WebpageService

Parameters:

site -

Returns:

getStandardWebsite

public de.deepamehta.core.Topic getStandardWebsite()

Bring it back the old "Standard Site", give "admin" back her personal one!

Specified by:

getStandardWebsite in interface WebpageService

Returns:

A topic representing the global website.