org.nuxeo.webengine.sites

Class Site

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.core.rest.DocumentObject

org.nuxeo.webengine.sites.AbstractSiteDocumentObject

org.nuxeo.webengine.sites.Site

All Implemented Interfaces:

Resource, org.nuxeo.runtime.model.Adaptable

public class Site
extends AbstractSiteDocumentObject

Web object implementation corresponding to Site. It is resolved from module root web object. It holds the site fragments back methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	url

Fields inherited from class org.nuxeo.webengine.sites.AbstractSiteDocumentObject

FLASH_WELCOME_MEDIA, IMAGE_WELCOME_MEDIA, NO_WELCOME_MEDIA

Fields inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doc

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
Site()

Method Summary

Modifier and Type	Method and Description
protected String	getDefaultSchemaFieldThemePageValue() Returns the default value of the theme page for the current web object.
protected String	getDefaultSchemaFieldThemeValue() Returns the default value of the theme for the current web object.
protected String	getDocumentDeletedErrorTemplateName() Returns the name of the template that will be used in case the DocumentModel is in "deleted" state
protected Map<String,Object>	getErrorArguments() Returns the map with the arguments that will be used to generate the error template page.
protected String	getErrorTemplateName() Returns the name of the template that will be used in case the DocumentModel for the current web object is null.
protected String	getSchemaFieldThemeName() Returns the schema name plus field name which together keep the theme for the current web object.
protected String	getSchemaFieldThemePageName() Returns the schema name plus field name which together keep the theme page for the current web object.
protected String	getSearchThemePage() Returns the search theme page.
protected DocumentModel	getSiteDocumentModelByUrl(String url)
void	initialize(Object... args)
Resource	traverse(String page) Must use the same method name as super.traverse() otherwise we introduce ambiguous sub-resources locators which will fail in jersey.

Methods inherited from class org.nuxeo.webengine.sites.AbstractSiteDocumentObject

_getSearchParameters, createWebPage, doDelete, doGet, getArguments, getHomePagePath, getLogo, getParentWebSite, getSearchParameters, getWebPageDocumentType, getWebSiteDocumentType, getWelcomeMedia, getWelcomeMediaHeight, getWelcomeMediaIsImage, getWelcomeMediaWidth, handleAnonymousRedirectToLogout, initAuthenticationService, remove, setDoGetParameters, setForceRedirectToLogout, setSearchParameters

Methods inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doHead, doPost, doPut, getAdapter, getCoreSession, getDelete, getDocument, getPut, getTitle, newDocument, newDocument, newDocument, search

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Detail

url

protected String url

Constructor Detail

Site

public Site()

Method Detail

initialize

public void initialize(Object... args)

Overrides:

initialize in class DocumentObject

traverse

public Resource traverse(String page)

Must use the same method name as super.traverse() otherwise we introduce ambiguous sub-resources locators which will fail in jersey.

Overrides:

traverse in class AbstractSiteDocumentObject

getSiteDocumentModelByUrl

protected DocumentModel getSiteDocumentModelByUrl(String url)

getSchemaFieldThemeName

protected String getSchemaFieldThemeName()

Description copied from class: AbstractSiteDocumentObject

Returns the schema name plus field name which together keep the theme for the current web object.

Specified by:

getSchemaFieldThemeName in class AbstractSiteDocumentObject

getDefaultSchemaFieldThemeValue

protected String getDefaultSchemaFieldThemeValue()

Description copied from class: AbstractSiteDocumentObject

Returns the default value of the theme for the current web object.

Specified by:

getDefaultSchemaFieldThemeValue in class AbstractSiteDocumentObject

getSchemaFieldThemePageName

protected String getSchemaFieldThemePageName()

Description copied from class: AbstractSiteDocumentObject

Returns the schema name plus field name which together keep the theme page for the current web object.

Specified by:

getSchemaFieldThemePageName in class AbstractSiteDocumentObject

getDefaultSchemaFieldThemePageValue

protected String getDefaultSchemaFieldThemePageValue()

Description copied from class: AbstractSiteDocumentObject

Returns the default value of the theme page for the current web object.

Specified by:

getDefaultSchemaFieldThemePageValue in class AbstractSiteDocumentObject

getErrorArguments

protected Map<String,Object> getErrorArguments()

Description copied from class: AbstractSiteDocumentObject

Returns the map with the arguments that will be used to generate the error template page.

Specified by:

getErrorArguments in class AbstractSiteDocumentObject

getErrorTemplateName

protected String getErrorTemplateName()

Description copied from class: AbstractSiteDocumentObject

Returns the name of the template that will be used in case the DocumentModel for the current web object is null.

Specified by:

getErrorTemplateName in class AbstractSiteDocumentObject

getDocumentDeletedErrorTemplateName

protected String getDocumentDeletedErrorTemplateName()

Description copied from class: AbstractSiteDocumentObject

Returns the name of the template that will be used in case the DocumentModel is in "deleted" state

Specified by:

getDocumentDeletedErrorTemplateName in class AbstractSiteDocumentObject

getSearchThemePage

protected String getSearchThemePage()

Description copied from class: AbstractSiteDocumentObject

Returns the search theme page.

Specified by:

getSearchThemePage in class AbstractSiteDocumentObject