org.bonitasoft.engine.page.impl

Class PageServiceImpl

java.lang.Object

org.bonitasoft.engine.page.impl.PageServiceImpl

All Implemented Interfaces:

org.bonitasoft.engine.commons.LifecycleService, org.bonitasoft.engine.commons.TenantLifecycleService, PageService

public class PageServiceImpl
extends Object
implements PageService

Author:

Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_GROOVY
static String	INDEX_HTML
static String	PAGE_CONTENT_DOES_NOT_CONTAINS_A_INDEX_GROOVY_OR_INDEX_HTML_FILE
static String	PAGE_TOKEN_PREFIX
static String	RESOURCES_INDEX_HTML

Fields inherited from interface org.bonitasoft.engine.page.PageService

PAGE, PROPERTIES_CONTENT_TYPE, PROPERTIES_DESCRIPTION, PROPERTIES_DISPLAY_NAME, PROPERTIES_FILE_NAME, PROPERTIES_NAME

Constructor Summary

Constructors

Constructor and Description
PageServiceImpl(ReadPersistenceService persistenceService, Recorder recorder, EventService eventService, TechnicalLoggerService logger, QueriableLoggerService queriableLoggerService, ProfileService profileService)

Method Summary

Modifier and Type	Method and Description
SPage	addPage(byte[] content, String contentName, long userId) add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip
SPage	addPage(SPage page, byte[] content) add a page using the zip in parameters and the given properties
protected void	checkPageDuplicate(SPage sPage, EntityUpdateDescriptor entityUpdateDescriptor, SPageLogBuilder logBuilder, String logMethodName)
void	deletePage(long pageId)
long	getNumberOfPages(QueryOptions options)
SPage	getPage(long pageId)
SPage	getPageByName(String pageName)
SPage	getPageByNameAndProcessDefinitionId(String name, long processDefinitionId) get a page attached to a process
List<SPage>	getPageByProcessDefinitionId(long processDefinitionId, int fromIndex, int numberOfResults) get a list of page attached to a process
byte[]	getPageContent(long pageId)
List<PageServiceListener>	getPageServiceListeners()
List<String>	getProvidedPages()
void	pause()
Properties	readPageZip(byte[] content) Read the content of a page in a zip
void	resume()
List<SPage>	searchPages(QueryOptions options)
void	setPageServiceListeners(List<PageServiceListener> pageServiceListeners)
void	setProvidedPages(List<String> providedPages)
void	start()
void	stop()
SPage	updatePage(long pageId, EntityUpdateDescriptor entityUpdateDescriptor)
void	updatePageContent(long pageId, byte[] content, String contentName)
protected void	updatePageNameInProfileEntry(EntityUpdateDescriptor entityUpdateDescriptor, String oldPageName)

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_CONTENT_DOES_NOT_CONTAINS_A_INDEX_GROOVY_OR_INDEX_HTML_FILE

public static final String PAGE_CONTENT_DOES_NOT_CONTAINS_A_INDEX_GROOVY_OR_INDEX_HTML_FILE

See Also:

Constant Field Values

PAGE_TOKEN_PREFIX

public static final String PAGE_TOKEN_PREFIX

See Also:

Constant Field Values

INDEX_GROOVY

public static final String INDEX_GROOVY

See Also:

Constant Field Values

INDEX_HTML

public static final String INDEX_HTML

See Also:

Constant Field Values

RESOURCES_INDEX_HTML

public static final String RESOURCES_INDEX_HTML

See Also:

Constant Field Values

Constructor Detail

PageServiceImpl

public PageServiceImpl(ReadPersistenceService persistenceService,
                       Recorder recorder,
                       EventService eventService,
                       TechnicalLoggerService logger,
                       QueriableLoggerService queriableLoggerService,
                       ProfileService profileService)

Method Detail

addPage

public SPage addPage(SPage page,
                     byte[] content)
              throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                     org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
                     SInvalidPageZipException,
                     SInvalidPageTokenException

Description copied from interface: PageService

add a page using the zip in parameters and the given properties

Specified by:

addPage in interface PageService

Returns:

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

addPage

public SPage addPage(byte[] content,
                     String contentName,
                     long userId)
              throws org.bonitasoft.engine.commons.exceptions.SObjectCreationException,
                     org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
                     SInvalidPageZipException,
                     SInvalidPageTokenException

Description copied from interface: PageService

add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip

Specified by:

addPage in interface PageService

Returns:

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectCreationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

getPageByNameAndProcessDefinitionId

public SPage getPageByNameAndProcessDefinitionId(String name,
                                                 long processDefinitionId)
                                          throws SBonitaReadException

Description copied from interface: PageService

get a page attached to a process

Specified by:

getPageByNameAndProcessDefinitionId in interface PageService

Returns:

Throws:

SBonitaReadException

getPageByProcessDefinitionId

public List<SPage> getPageByProcessDefinitionId(long processDefinitionId,
                                                int fromIndex,
                                                int numberOfResults)
                                         throws SBonitaReadException

Description copied from interface: PageService

get a list of page attached to a process

Specified by:

getPageByProcessDefinitionId in interface PageService

Returns:

Throws:

SBonitaReadException

readPageZip

public Properties readPageZip(byte[] content)
                       throws SInvalidPageZipMissingIndexException,
                              SInvalidPageZipMissingAPropertyException,
                              SInvalidPageZipInconsistentException,
                              SInvalidPageZipMissingPropertiesException,
                              SInvalidPageTokenException

Description copied from interface: PageService

Read the content of a page in a zip

Specified by:

readPageZip in interface PageService

Parameters:

content - the page content

Returns:

the properties of the page stored in the page.properties

Throws:

SInvalidPageZipMissingIndexException - if the page is missing an index.html or Index.groovy

SInvalidPageZipMissingAPropertyException - if the page is missing mandatory field in the page.properties

SInvalidPageZipInconsistentException - if the zip is not a valid zip file or unreadable

SInvalidPageZipMissingPropertiesException

SInvalidPageTokenException

getPage

public SPage getPage(long pageId)
              throws SBonitaReadException,
                     org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

getPage in interface PageService

Throws:

SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getPageByName

public SPage getPageByName(String pageName)
                    throws SBonitaReadException

Specified by:

getPageByName in interface PageService

Throws:

SBonitaReadException

getNumberOfPages

public long getNumberOfPages(QueryOptions options)
                      throws SBonitaReadException

Specified by:

getNumberOfPages in interface PageService

Throws:

SBonitaReadException

searchPages

public List<SPage> searchPages(QueryOptions options)
                        throws SBonitaReadException

Specified by:

searchPages in interface PageService

Throws:

SBonitaReadException

deletePage

public void deletePage(long pageId)
                throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                       org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

deletePage in interface PageService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

getPageContent

public byte[] getPageContent(long pageId)
                      throws SBonitaReadException,
                             org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

Specified by:

getPageContent in interface PageService

Throws:

SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectNotFoundException

updatePage

public SPage updatePage(long pageId,
                        EntityUpdateDescriptor entityUpdateDescriptor)
                 throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                        org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException,
                        SInvalidPageTokenException

Specified by:

updatePage in interface PageService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

SInvalidPageTokenException

updatePageNameInProfileEntry

protected void updatePageNameInProfileEntry(EntityUpdateDescriptor entityUpdateDescriptor,
                                            String oldPageName)
                                     throws SInvalidPageTokenException,
                                            SBonitaReadException,
                                            SProfileEntryUpdateException

Throws:

SInvalidPageTokenException

SBonitaReadException

SProfileEntryUpdateException

checkPageDuplicate

protected void checkPageDuplicate(SPage sPage,
                                  EntityUpdateDescriptor entityUpdateDescriptor,
                                  SPageLogBuilder logBuilder,
                                  String logMethodName)
                           throws SBonitaReadException,
                                  org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

Throws:

SBonitaReadException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

updatePageContent

public void updatePageContent(long pageId,
                              byte[] content,
                              String contentName)
                       throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException,
                              SInvalidPageZipException,
                              SInvalidPageTokenException,
                              org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

Specified by:

updatePageContent in interface PageService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException

SInvalidPageZipException

SInvalidPageTokenException

org.bonitasoft.engine.commons.exceptions.SObjectAlreadyExistsException

start

public void start()
           throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

start in interface org.bonitasoft.engine.commons.LifecycleService

Specified by:

start in interface PageService

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

stop

public void stop()

Specified by:

stop in interface org.bonitasoft.engine.commons.LifecycleService

pause

public void pause()

Specified by:

pause in interface org.bonitasoft.engine.commons.LifecycleService

resume

public void resume()

Specified by:

resume in interface org.bonitasoft.engine.commons.LifecycleService

getPageServiceListeners

public List<PageServiceListener> getPageServiceListeners()

setPageServiceListeners

public void setPageServiceListeners(List<PageServiceListener> pageServiceListeners)

getProvidedPages

public List<String> getProvidedPages()

setProvidedPages

public void setProvidedPages(List<String> providedPages)