org.bonitasoft.engine.page.impl

Class PageServiceImpl

java.lang.Object

org.bonitasoft.engine.page.impl.PageServiceImpl

All Implemented Interfaces:

LifecycleService, TenantLifecycleService, PageService

public class PageServiceImpl
extends java.lang.Object
implements PageService

Author:

Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEX_GROOVY
static java.lang.String	INDEX_HTML
static java.lang.String	PAGE_TOKEN_PREFIX
static java.lang.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, TechnicalLoggerService logger, QueriableLoggerService queriableLoggerService, ProfileService profileService)

Method Summary

Modifier and Type	Method and Description
SPage	addPage(byte[] content, java.lang.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, java.lang.String logMethodName)
protected void	createPage(ImportPageDescriptor pageDescriptor, byte[] providedPageContent, java.util.Properties pageProperties)
void	deletePage(long pageId)
long	getNumberOfPages(QueryOptions options)
SPage	getPage(long pageId)
SPage	getPageByName(java.lang.String pageName)
SPage	getPageByNameAndProcessDefinitionId(java.lang.String name, long processDefinitionId) get a page attached to a process
java.util.List<SPage>	getPageByProcessDefinitionId(long processDefinitionId, int fromIndex, int numberOfResults) get a list of page attached to a process
byte[]	getPageContent(long pageId)
java.util.List<PageServiceListener>	getPageServiceListeners()
java.util.List<ImportPageDescriptor>	getProvidedPages()
void	pause() Temporary halt the execution of this service.
java.util.Properties	readPageZip(byte[] content) Read the content of a page in a zip
void	resume() resume the execution the service
java.util.List<SPage>	searchPages(QueryOptions options)
void	setPageServiceListeners(java.util.List<PageServiceListener> pageServiceListeners)
void	setProvidedPages(java.util.List<ImportPageDescriptor> providedPages)
void	start() Start the service
void	stop()
SPage	updatePage(long pageId, EntityUpdateDescriptor entityUpdateDescriptor)
void	updatePageContent(long pageId, byte[] content, java.lang.String contentName)
protected void	updatePageNameInProfileEntry(EntityUpdateDescriptor entityUpdateDescriptor, java.lang.String oldPageName)

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_TOKEN_PREFIX

public static final java.lang.String PAGE_TOKEN_PREFIX

See Also:

Constant Field Values

INDEX_GROOVY

public static final java.lang.String INDEX_GROOVY

See Also:

Constant Field Values

INDEX_HTML

public static final java.lang.String INDEX_HTML

See Also:

Constant Field Values

RESOURCES_INDEX_HTML

public static final java.lang.String RESOURCES_INDEX_HTML

See Also:

Constant Field Values

Constructor Detail

PageServiceImpl

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

Method Detail

addPage

public SPage addPage(SPage page,
                     byte[] content)
              throws SObjectCreationException,
                     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:

SObjectCreationException

SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

addPage

public SPage addPage(byte[] content,
                     java.lang.String contentName,
                     long userId)
              throws SObjectCreationException,
                     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:

SObjectCreationException

SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

getPageByNameAndProcessDefinitionId

public SPage getPageByNameAndProcessDefinitionId(java.lang.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 java.util.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 java.util.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,
                     SObjectNotFoundException

Specified by:

getPage in interface PageService

Throws:

SBonitaReadException

SObjectNotFoundException

getPageByName

public SPage getPageByName(java.lang.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 java.util.List<SPage> searchPages(QueryOptions options)
                                  throws SBonitaReadException

Specified by:

searchPages in interface PageService

Throws:

SBonitaReadException

deletePage

public void deletePage(long pageId)
                throws SObjectModificationException,
                       SObjectNotFoundException

Specified by:

deletePage in interface PageService

Throws:

SObjectModificationException

SObjectNotFoundException

getPageContent

public byte[] getPageContent(long pageId)
                      throws SBonitaReadException,
                             SObjectNotFoundException

Specified by:

getPageContent in interface PageService

Throws:

SBonitaReadException

SObjectNotFoundException

updatePage

public SPage updatePage(long pageId,
                        EntityUpdateDescriptor entityUpdateDescriptor)
                 throws SObjectModificationException,
                        SObjectAlreadyExistsException,
                        SInvalidPageTokenException

Specified by:

updatePage in interface PageService

Throws:

SObjectModificationException

SObjectAlreadyExistsException

SInvalidPageTokenException

updatePageNameInProfileEntry

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

Throws:

SInvalidPageTokenException

SBonitaReadException

SProfileEntryUpdateException

checkPageDuplicate

protected void checkPageDuplicate(SPage sPage,
                                  EntityUpdateDescriptor entityUpdateDescriptor,
                                  SPageLogBuilder logBuilder,
                                  java.lang.String logMethodName)
                           throws SBonitaReadException,
                                  SObjectAlreadyExistsException

Throws:

SBonitaReadException

SObjectAlreadyExistsException

updatePageContent

public void updatePageContent(long pageId,
                              byte[] content,
                              java.lang.String contentName)
                       throws SObjectModificationException,
                              SInvalidPageZipException,
                              SInvalidPageTokenException,
                              SObjectAlreadyExistsException

Specified by:

updatePageContent in interface PageService

Throws:

SObjectModificationException

SInvalidPageZipException

SInvalidPageTokenException

SObjectAlreadyExistsException

start

public void start()
           throws SBonitaException

Description copied from interface: LifecycleService

Start the service

Specified by:

start in interface LifecycleService

Specified by:

start in interface PageService

Throws:

SBonitaException

createPage

protected void createPage(ImportPageDescriptor pageDescriptor,
                          byte[] providedPageContent,
                          java.util.Properties pageProperties)
                   throws SObjectAlreadyExistsException,
                          SObjectCreationException

Throws:

SObjectAlreadyExistsException

SObjectCreationException

stop

public void stop()

Specified by:

stop in interface LifecycleService

pause

public void pause()

Description copied from interface: LifecycleService

Temporary halt the execution of this service.

Specified by:

pause in interface LifecycleService

resume

public void resume()

Description copied from interface: LifecycleService

resume the execution the service

Specified by:

resume in interface LifecycleService

getPageServiceListeners

public java.util.List<PageServiceListener> getPageServiceListeners()

setPageServiceListeners

public void setPageServiceListeners(java.util.List<PageServiceListener> pageServiceListeners)

getProvidedPages

public java.util.List<ImportPageDescriptor> getProvidedPages()

setProvidedPages

public void setProvidedPages(java.util.List<ImportPageDescriptor> providedPages)