org.gcube.portal.wssynclibrary.thredds

Class WorkspaceThreddsSynchronize

java.lang.Object

org.gcube.portal.wssynclibrary.thredds.WorkspaceThreddsSynchronize

All Implemented Interfaces:

DoCheckSyncItem<ThSyncFolderDescriptor>, DoConnectRepository, DoSyncItem<ThSyncStatus>, WorkspaceThreddsSynchronizedRepository<ThSyncStatus,ThSyncFolderDescriptor>

public class WorkspaceThreddsSynchronize
extends Object
implements WorkspaceThreddsSynchronizedRepository<ThSyncStatus,ThSyncFolderDescriptor>

The Class WorkspaceThreddsSynchronize.

Author:

Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it Feb 14, 2018

Method Summary

Modifier and Type	Method and Description
ThSyncFolderDescriptor	checkItemSynched(String itemId) Check item synched.
String	decribeSyncRepository() Decribe sync repository.
ThSyncStatus	doSync(String itemId) Do sync.
Boolean	doUnSync(String itemId, boolean deleteRemoteContent) Do un sync.
List<ThCatalogueBean>	getAvailableCatalogues() Gets the available catalogues.
ThSyncFolderDescriptor	getConfiguration(String itemId) Gets the configuration.
ThSyncElementInfo	getElementInfo(Map<String,Object> itemProperties, org.gcube.usecases.ws.thredds.model.ContainerType itemType) Gets the element info.
static WorkspaceThreddsSynchronize	getInstance() Gets the single instance of WorkspaceThreddsSynchronize.
Boolean	initRepository() Inits the repository.
boolean	isItemSynched(String itemId, Map<String,Object> itemProperties, org.gcube.usecases.ws.thredds.model.ContainerType itemType) Checks if is item synched.
ThSyncStatus	monitorSyncStatus(String itemId) Monitor sync status.
void	registerCallbackForId(String itemId) Register callback for id.
Boolean	removeSync(String itemId) Removes the sync.
ThSyncFolderDescriptor	setSynchronizedFolder(ThSynchFolderConfiguration thConfig, String itemId) Sets the synchronized folder.
Boolean	shutDownRepository() Shut down repository.
Boolean	stopSync(String itemId) Stop sync.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static WorkspaceThreddsSynchronize getInstance()

Gets the single instance of WorkspaceThreddsSynchronize.

Returns:

single instance of WorkspaceThreddsSynchronize

checkItemSynched

public ThSyncFolderDescriptor checkItemSynched(String itemId)
                                        throws ItemNotSynched,
                                               WorkspaceFolderLocked,
                                               Exception

Check item synched.

Specified by:

checkItemSynched in interface DoCheckSyncItem<ThSyncFolderDescriptor>

Parameters:

itemId - the item id

Returns:

the th sync folder descriptor

Throws:

ItemNotSynched - the item not synched

WorkspaceFolderLocked - the workspace folder locked

Exception - the exception

setSynchronizedFolder

public ThSyncFolderDescriptor setSynchronizedFolder(ThSynchFolderConfiguration thConfig,
                                                    String itemId)
                                             throws Exception

Sets the synchronized folder.

Parameters:

thConfig - the th config

itemId - the item id

Returns:

the th sync folder descriptor

Throws:

Exception - the exception

doSync

public ThSyncStatus doSync(String itemId)
                    throws Exception

Do sync.

Specified by:

doSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the th sync status

Throws:

Exception - the exception

monitorSyncStatus

public ThSyncStatus monitorSyncStatus(String itemId)
                               throws ItemNotSynched,
                                      Exception

Monitor sync status.

Specified by:

monitorSyncStatus in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the th sync status

Throws:

ItemNotSynched - the item not synched

Exception - the exception

registerCallbackForId

public void registerCallbackForId(String itemId)
                           throws org.gcube.usecases.ws.thredds.faults.ProcessNotFoundException,
                                  Exception

Register callback for id.

Specified by:

registerCallbackForId in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Throws:

org.gcube.usecases.ws.thredds.faults.ProcessNotFoundException - the process not found exception

Exception - the exception

getAvailableCatalogues

public List<ThCatalogueBean> getAvailableCatalogues()
                                             throws Exception

Gets the available catalogues. you need to set the context caller.

Returns:

the available catalogues

Throws:

Exception - the exception

doUnSync

public Boolean doUnSync(String itemId,
                        boolean deleteRemoteContent)
                 throws Exception

Do un sync.

Specified by:

doUnSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

deleteRemoteContent - the delete remote content

Returns:

the boolean

Throws:

Exception - the exception

getConfiguration

public ThSyncFolderDescriptor getConfiguration(String itemId)
                                        throws org.gcube.usecases.ws.thredds.faults.WorkspaceInteractionException,
                                               org.gcube.usecases.ws.thredds.faults.WorkspaceNotSynchedException,
                                               Exception

Gets the configuration.

Specified by:

getConfiguration in interface DoCheckSyncItem<ThSyncFolderDescriptor>

Parameters:

itemId - the item id

Returns:

the configuration

Throws:

org.gcube.usecases.ws.thredds.faults.WorkspaceInteractionException - the workspace interaction exception

org.gcube.usecases.ws.thredds.faults.WorkspaceNotSynchedException - the workspace not synched exception

Exception - the exception NB. it is time consuming due to it calls the SHUB

getElementInfo

public ThSyncElementInfo getElementInfo(Map<String,Object> itemProperties,
                                        org.gcube.usecases.ws.thredds.model.ContainerType itemType)
                                 throws org.gcube.usecases.ws.thredds.faults.WorkspaceNotSynchedException

Gets the element info.

Parameters:

itemProperties - the item properties read from SHUB by accessing to Metadata.Map() of a item

itemType - the item type

Returns:

the element info

Throws:

org.gcube.usecases.ws.thredds.faults.WorkspaceNotSynchedException - the workspace not synched exception

isItemSynched

public boolean isItemSynched(String itemId,
                             Map<String,Object> itemProperties,
                             org.gcube.usecases.ws.thredds.model.ContainerType itemType)

Checks if is item synched. This calls the SyncEngine.parseInfo(Map, ContainerType)

Parameters:

itemId - the item id

itemProperties - the item properties

itemType - the item type

Returns:

true, if is item synched

removeSync

public Boolean removeSync(String itemId)
                   throws Exception

Removes the sync.

Specified by:

removeSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the boolean

Throws:

Exception - the exception

stopSync

public Boolean stopSync(String itemId)
                 throws Exception

Stop sync.

Specified by:

stopSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the boolean

Throws:

Exception - the exception

initRepository

public Boolean initRepository()
                       throws Exception

Inits the repository.

Specified by:

initRepository in interface DoConnectRepository

Returns:

the boolean

Throws:

Exception - the exception

shutDownRepository

public Boolean shutDownRepository()

Shut down repository.

Specified by:

shutDownRepository in interface DoConnectRepository

Returns:

the boolean

decribeSyncRepository

public String decribeSyncRepository()

Decribe sync repository.

Specified by:

decribeSyncRepository in interface WorkspaceThreddsSynchronizedRepository<ThSyncStatus,ThSyncFolderDescriptor>

Returns:

the string