Package org.rogatio.circlead.control.synchronizer.atlassian

Class AtlassianSynchronizer

java.lang.Object

org.rogatio.circlead.control.synchronizer.DefaultSynchronizer

org.rogatio.circlead.control.synchronizer.atlassian.AtlassianSynchronizer

All Implemented Interfaces:

ISynchronizer

public class AtlassianSynchronizer
extends DefaultSynchronizer

The Class AtlassianSynchronizer synchronizes Circlead with Atlassian Confluence Server. Could be used for CLoud- and Dedicated-Server.

Author:

Matthias Wegner

Constructor Summary

Constructors

Constructor	Description
AtlassianSynchronizer(java.lang.String spaceKey)	Instantiates a new atlassian synchronizer.

Method Summary

Modifier and Type	Method	Description
SynchronizerResult	add(IWorkitem workitem)	Adds workitem to synchronized system.
SynchronizerResult	add(IReport report)	Adds the report to synchronized system.
SynchronizerResult	delete(int pageId)	Delete.
java.lang.String	delete(IWorkitem workitem)	Delete workitem in system which is connected through synchronizer.
SynchronizerResult	deleteVersion(java.lang.Integer pageId, java.lang.Integer version)	Delete version of a page.
boolean	deleteVersions(java.lang.Integer pageId)	Delete all versions of a page by given id.
void	deleteVersions(WorkitemType type)	Delete old page versions of an workitem.
IWorkitem	get(java.lang.String indexId)	Gets the workitem of named id.
java.lang.String	getAcestorId(java.lang.String type)	Loads the acestor page-id for the page as workitem-representation.
java.lang.String	getIdPattern()	Gets the pattern for valid id as regular expression which is allowed for synchronized system.
ISynchronizerRendererEngine	getRenderer()	Gets the renderer which is used to render workitems and reports for target system.
java.lang.String	getSpaceKey()	Gets the set key of circlead-space .
java.util.List<java.lang.Integer>	getVersions(java.lang.Integer pageId)	Gets the versions of a page with given id.
java.util.List<java.lang.String>	loadIndex(WorkitemType workitemType)	Load index for all workitems which where found by synchronizer of named workitem-type.
void	saveImageAttachmentOfPage(int pageId, java.lang.String filename)	Save image attachment of page.
void	saveImageAttachmentOfPage(java.lang.String pageId, java.lang.String filename)	Save image attachment of page.
SynchronizerResult	update(IWorkitem workitem)	Update workitem on synchronized system.
SynchronizerResult	update(IReport report)	Update report on synchronized system.

Methods inherited from class org.rogatio.circlead.control.synchronizer.DefaultSynchronizer

equals, hashCode, toString, writeIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AtlassianSynchronizer

public AtlassianSynchronizer(java.lang.String spaceKey)

Instantiates a new atlassian synchronizer.

Parameters:

spaceKey - the key of the circlead space

Method Detail

getSpaceKey

public java.lang.String getSpaceKey()

Gets the set key of circlead-space .

Returns:

the space key

add

public SynchronizerResult add(IReport report)
                       throws SynchronizerException

Description copied from interface: ISynchronizer

Adds the report to synchronized system.

Specified by:

add in interface ISynchronizer

Overrides:

add in class DefaultSynchronizer

Parameters:

report - the report to add

Returns:

the synchronizer result

Throws:

SynchronizerException - the synchronizer exception

add

public SynchronizerResult add(IWorkitem workitem)
                       throws SynchronizerException

Description copied from interface: ISynchronizer

Adds workitem to synchronized system.

Specified by:

add in interface ISynchronizer

Overrides:

add in class DefaultSynchronizer

Parameters:

workitem - the workitem to add

Returns:

the synchronizer result of adding item

Throws:

SynchronizerException - the synchronizer exception

update

public SynchronizerResult update(IWorkitem workitem)

Description copied from interface: ISynchronizer

Update workitem on synchronized system.

Specified by:

update in interface ISynchronizer

Overrides:

update in class DefaultSynchronizer

Parameters:

workitem - the workitem to update

Returns:

the synchronizer result

update

public SynchronizerResult update(IReport report)

Description copied from interface: ISynchronizer

Update report on synchronized system.

Specified by:

update in interface ISynchronizer

Overrides:

update in class DefaultSynchronizer

Parameters:

report - the report to update

Returns:

the synchronizer result for update

getIdPattern

public java.lang.String getIdPattern()

Description copied from interface: ISynchronizer

Gets the pattern for valid id as regular expression which is allowed for synchronized system.

Specified by:

getIdPattern in interface ISynchronizer

Overrides:

getIdPattern in class DefaultSynchronizer

Returns:

the id pattern

deleteVersions

public void deleteVersions(WorkitemType type)

Delete old page versions of an workitem.

Parameters:

type - the type of the workitem

deleteVersions

public boolean deleteVersions(java.lang.Integer pageId)

Delete all versions of a page by given id.

Parameters:

pageId - the page id

Returns:

true, if successful

deleteVersion

public SynchronizerResult deleteVersion(java.lang.Integer pageId,
                                        java.lang.Integer version)

Delete version of a page.

Parameters:

pageId - the page id

version - the version

Returns:

the synchronizer result

getVersions

public java.util.List<java.lang.Integer> getVersions(java.lang.Integer pageId)

Gets the versions of a page with given id.

Parameters:

pageId - the page id

Returns:

the versions

getAcestorId

public java.lang.String getAcestorId(java.lang.String type)

Loads the acestor page-id for the page as workitem-representation.

Parameters:

type - the type of a workitem as string

Returns:

the acestor id

saveImageAttachmentOfPage

public void saveImageAttachmentOfPage(java.lang.String pageId,
                                      java.lang.String filename)

Save image attachment of page.

Parameters:

pageId - the page id

filename - the filename

saveImageAttachmentOfPage

public void saveImageAttachmentOfPage(int pageId,
                                      java.lang.String filename)

Save image attachment of page.

Parameters:

pageId - the page id

filename - the filename

get

public IWorkitem get(java.lang.String indexId)
              throws SynchronizerException

Description copied from interface: ISynchronizer

Gets the workitem of named id.

Specified by:

get in interface ISynchronizer

Overrides:

get in class DefaultSynchronizer

Parameters:

indexId - the workitem of specific synchronizer. Every synchronizer could have own id-logic

Returns:

the loaded workitem

Throws:

SynchronizerException - the synchronizer exception

delete

public java.lang.String delete(IWorkitem workitem)
                        throws SynchronizerException

Description copied from interface: ISynchronizer

Delete workitem in system which is connected through synchronizer.

Specified by:

delete in interface ISynchronizer

Overrides:

delete in class DefaultSynchronizer

Parameters:

workitem - the workitem to delete

Returns:

the result and response of deletion

Throws:

SynchronizerException - the synchronizer exception

delete

public SynchronizerResult delete(int pageId)

Delete.

Parameters:

pageId - the page id

Returns:

the synchronizer result

loadIndex

public java.util.List<java.lang.String> loadIndex(WorkitemType workitemType)

Description copied from interface: ISynchronizer

Load index for all workitems which where found by synchronizer of named workitem-type.

Specified by:

loadIndex in interface ISynchronizer

Overrides:

loadIndex in class DefaultSynchronizer

Parameters:

workitemType - the workitem type

Returns:

the list of query results of found items

getRenderer

public ISynchronizerRendererEngine getRenderer()

Description copied from interface: ISynchronizer

Gets the renderer which is used to render workitems and reports for target system.

Specified by:

getRenderer in interface ISynchronizer

Overrides:

getRenderer in class DefaultSynchronizer

Returns:

the renderer for the synchronizer