org.nuxeo.webengine.sites

Class AbstractSiteDocumentObject

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

All Implemented Interfaces:

Resource, org.nuxeo.runtime.model.Adaptable

Direct Known Subclasses:

Page, Site

public abstract class AbstractSiteDocumentObject
extends DocumentObject

The basic web object implementation. It holds the web object back methods.

Author:

rux

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLASH_WELCOME_MEDIA
static int	IMAGE_WELCOME_MEDIA
static int	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
AbstractSiteDocumentObject()

Method Summary

Modifier and Type	Method and Description
Object	_getSearchParameters() JAX-RS specs doesn't allow multiple REST designator on a single method so we need to use another method to do a POST.
Object	createWebPage() Creates a new web page object.
javax.ws.rs.core.Response	doDelete()
Object	doGet() Executes the GET requests on the current web object
protected Map<String,Object>	getArguments() Returns the map with the arguments that will be used to generate the default template page for the current web object.
protected abstract String	getDefaultSchemaFieldThemePageValue() Returns the default value of the theme page for the current web object.
protected abstract String	getDefaultSchemaFieldThemeValue() Returns the default value of the theme for the current web object.
protected abstract String	getDocumentDeletedErrorTemplateName() Returns the name of the template that will be used in case the DocumentModel is in "deleted" state
protected abstract Map<String,Object>	getErrorArguments() Returns the map with the arguments that will be used to generate the error template page.
protected abstract String	getErrorTemplateName() Returns the name of the template that will be used in case the DocumentModel for the current web object is null.
Object	getHomePagePath() Method used to retrieve the path to the current web container.
javax.ws.rs.core.Response	getLogo() Retrieves the logo of the current web object.
protected DocumentModel	getParentWebSite(CoreSession session) Returns the parent web site of the current web object.
protected abstract String	getSchemaFieldThemeName() Returns the schema name plus field name which together keep the theme for the current web object.
protected abstract String	getSchemaFieldThemePageName() Returns the schema name plus field name which together keep the theme page for the current web object.
Object	getSearchParameters() Method called before a search operation is made for the context of the current web object.
protected abstract String	getSearchThemePage() Returns the search theme page.
protected String	getWebPageDocumentType() Returns the document type of the entry.
protected String	getWebSiteDocumentType() Returns the document type of the container.
javax.ws.rs.core.Response	getWelcomeMedia() Returns the welcome media of the current web object.
int	getWelcomeMediaHeight()
int	getWelcomeMediaIsImage()
int	getWelcomeMediaWidth()
protected javax.ws.rs.core.Response	handleAnonymousRedirectToLogout(javax.servlet.http.HttpServletRequest request)
protected org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService	initAuthenticationService()
javax.ws.rs.core.Response	remove() Method used to delete pages in the current container
protected void	setDoGetParameters() Sets the parameters that will be needed in order to execute the GET requests on the current web object.
protected void	setForceRedirectToLogout(boolean redirectToLogout)
protected void	setSearchParameters() Sets the parameters needed to perform a search.
Resource	traverse(String path)

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

doHead, doPost, doPut, getAdapter, getCoreSession, getDelete, getDocument, getPut, getTitle, initialize, 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

NO_WELCOME_MEDIA

public static final int NO_WELCOME_MEDIA

See Also:

Constant Field Values

IMAGE_WELCOME_MEDIA

public static final int IMAGE_WELCOME_MEDIA

See Also:

Constant Field Values

FLASH_WELCOME_MEDIA

public static final int FLASH_WELCOME_MEDIA

See Also:

Constant Field Values

Constructor Detail

AbstractSiteDocumentObject

public AbstractSiteDocumentObject()

Method Detail

doGet

public Object doGet()

Executes the GET requests on the current web object

Overrides:

doGet in class DocumentObject

getLogo

public javax.ws.rs.core.Response getLogo()

Retrieves the logo of the current web object.

getWelcomeMedia

public javax.ws.rs.core.Response getWelcomeMedia()

Returns the welcome media of the current web object.

getWelcomeMediaWidth

public int getWelcomeMediaWidth()

getWelcomeMediaHeight

public int getWelcomeMediaHeight()

getWelcomeMediaIsImage

public int getWelcomeMediaIsImage()
                           throws Exception

Throws:

Exception

getSearchParameters

public Object getSearchParameters()

Method called before a search operation is made for the context of the current web object.

_getSearchParameters

public Object _getSearchParameters()

JAX-RS specs doesn't allow multiple REST designator on a single method so we need to use another method to do a POST.

traverse

public Resource traverse(String path)

Overrides:

traverse in class DocumentObject

createWebPage

public Object createWebPage()

Creates a new web page object.

getHomePagePath

public Object getHomePagePath()

Method used to retrieve the path to the current web container.

Returns:

the path to the current web container

remove

public javax.ws.rs.core.Response remove()

Method used to delete pages in the current container

Returns:

the path to the current web container

doDelete

public javax.ws.rs.core.Response doDelete()

Overrides:

doDelete in class DocumentObject

getWebSiteDocumentType

protected String getWebSiteDocumentType()

Returns the document type of the container.

getWebPageDocumentType

protected String getWebPageDocumentType()

Returns the document type of the entry.

setSearchParameters

protected void setSearchParameters()

Sets the parameters needed to perform a search.

getArguments

protected Map<String,Object> getArguments()
                                   throws Exception

Returns the map with the arguments that will be used to generate the default template page for the current web object.

Throws:

Exception

setDoGetParameters

protected void setDoGetParameters()

Sets the parameters that will be needed in order to execute the GET requests on the current web object.

getParentWebSite

protected DocumentModel getParentWebSite(CoreSession session)
                                  throws Exception

Returns the parent web site of the current web object.

Parameters:

session - the nuxeo core session

Returns:

the parent web site of the current web object

Throws:

Exception

getSearchThemePage

protected abstract String getSearchThemePage()

Returns the search theme page.

getSchemaFieldThemeName

protected abstract String getSchemaFieldThemeName()

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

getSchemaFieldThemePageName

protected abstract String getSchemaFieldThemePageName()

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

getDefaultSchemaFieldThemeValue

protected abstract String getDefaultSchemaFieldThemeValue()

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

getDefaultSchemaFieldThemePageValue

protected abstract String getDefaultSchemaFieldThemePageValue()

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

getErrorTemplateName

protected abstract String getErrorTemplateName()

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

getDocumentDeletedErrorTemplateName

protected abstract String getDocumentDeletedErrorTemplateName()

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

getErrorArguments

protected abstract Map<String,Object> getErrorArguments()

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

handleAnonymousRedirectToLogout

protected javax.ws.rs.core.Response handleAnonymousRedirectToLogout(javax.servlet.http.HttpServletRequest request)

setForceRedirectToLogout

protected void setForceRedirectToLogout(boolean redirectToLogout)

initAuthenticationService

protected org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService initAuthenticationService()
                                                                                                       throws ClientException

Throws:

ClientException