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

Field Summary

Fields

Modifier and Type	Field and Description
static String	WS_SYNCH_SYNCH_STATUS

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>	getAvailableCataloguesByToken(String token) Gets the available catalogues by token.
static WorkspaceThreddsSynchronize	getInstance() Gets the single instance of WorkspaceThreddsSynchronize.
static org.gcube.common.storagehub.client.dsl.StorageHubClient	getStorageHubInstance() Gets the storage hub instance.
Sync_Status	getSynchedStatusFromItemProperty(String itemId, String username) Gets the synched status from item property.
Boolean	initRepository() Inits the repository.
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

Field Detail

WS_SYNCH_SYNCH_STATUS

public static final String WS_SYNCH_SYNCH_STATUS

See Also:

Constant Field Values

Method Detail

getInstance

public static WorkspaceThreddsSynchronize getInstance()

Gets the single instance of WorkspaceThreddsSynchronize.

Returns:

single instance of WorkspaceThreddsSynchronize

getStorageHubInstance

public static org.gcube.common.storagehub.client.dsl.StorageHubClient getStorageHubInstance()

Gets the storage hub instance.

Returns:

the storage hub instance

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

removeSync

public Boolean removeSync(String itemId)

Removes the sync.

Specified by:

removeSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the boolean

stopSync

public Boolean stopSync(String itemId)

Stop sync.

Specified by:

stopSync in interface DoSyncItem<ThSyncStatus>

Parameters:

itemId - the item id

Returns:

the boolean

initRepository

public Boolean initRepository()

Inits the repository.

Specified by:

initRepository in interface DoConnectRepository

Returns:

the boolean

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

getSynchedStatusFromItemProperty

public Sync_Status getSynchedStatusFromItemProperty(String itemId,
                                                    String username)
                                             throws ItemNotSynched,
                                                    Exception

Gets the synched status from item property.

Parameters:

itemId - the item id

username - the username

Returns:

the synched status from item property

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

getAvailableCataloguesByToken

public List<ThCatalogueBean> getAvailableCataloguesByToken(String token)
                                                    throws Exception

Gets the available catalogues by token.

Parameters:

token - the token

Returns:

the available catalogues by token

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