Package ch.systemsx.cisd.etlserver

Class TopLevelDataSetRegistratorGlobalState

java.lang.Object

ch.systemsx.cisd.etlserver.TopLevelDataSetRegistratorGlobalState

All Implemented Interfaces:

ch.systemsx.cisd.common.resource.IReleasable

public class TopLevelDataSetRegistratorGlobalState
extends java.lang.Object
implements ch.systemsx.cisd.common.resource.IReleasable

Global state needed by top level data set registrators.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_PRE_STAGING_DIR
static org.apache.log4j.Logger	operationLog
static java.lang.String	PRE_COMMIT_DIR
static java.lang.String	PRE_STAGING_DIR
static java.lang.String	RECOVERY_MARKER_DIR
static java.lang.String	STAGING_DIR

Constructor Summary

Constructors

Constructor	Description
TopLevelDataSetRegistratorGlobalState(java.lang.String dssCode, java.lang.String shareId, java.io.File storeRootDir, java.io.File dssInternalTempDir, java.io.File dssRegistrationLogDir, java.io.File dssRecoveryStateDir, ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService openBisService, IMailClient mailClient, ch.systemsx.cisd.etlserver.validation.IDataSetValidator dataSetValidator, IDataSourceQueryService dataSourceQueryService, ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory dynamicTransactionQueryFactory, boolean notifySuccessfulRegistration, ch.systemsx.cisd.etlserver.ThreadParameters threadParameters, boolean useIsFinishedMarkerFile, boolean deleteUnidentified, java.lang.String preRegistrationScriptOrNull, java.lang.String postRegistrationScriptOrNull, java.lang.String[] validationScriptsOrNull, ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager storageRecoveryManager)
TopLevelDataSetRegistratorGlobalState(java.lang.String dssCode, java.lang.String shareId, java.io.File storeRootDir, java.io.File dssInternalTempDir, java.io.File dssRegistrationLogDir, java.io.File dssRecoveryStateDir, ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService openBisService, IMailClient mailClient, ch.systemsx.cisd.etlserver.validation.IDataSetValidator dataSetValidator, IDataSourceQueryService dataSourceQueryService, ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory dynamicTransactionQueryFactory, boolean notifySuccessfulRegistration, ch.systemsx.cisd.etlserver.ThreadParameters threadParameters, ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager storageRecoveryManager)	Constructor that takes some values from the thread parameters.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAdministratorEmails()	Return the email addresses of all administrator users registered on the openBIS AS.
ch.systemsx.cisd.etlserver.validation.IDataSetValidator	getDataSetValidator()
IDataSourceQueryService	getDataSourceQueryService()
java.lang.String	getDssCode()
java.io.File	getDssInternalTempDir()	Get a directory that can be used for temporary files, and is local to the server.
java.io.File	getDssRegistrationLogDir()	Get the directory that hold the DSS registration logs
ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory	getDynamicTransactionQueryFactory()
IMailClient	getMailClient()
ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService	getOpenBisService()
java.lang.String	getPostRegistrationScript()
java.io.File	getPreCommitDir()	Get's the precommit directory.
java.lang.String	getPreRegistrationScript()
java.io.File	getPreStagingDir()	Get the directory used for pre-staging.
java.io.File	getRecoveryStateDir()
java.lang.String	getShareId()
java.io.File	getStagingDir()	Get the staging directory used in registration.
ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager	getStorageRecoveryManager()
java.io.File	getStoreRootDir()
ch.systemsx.cisd.etlserver.ThreadParameters	getThreadParameters()
java.lang.String[]	getValidationScriptsOrNull()
boolean	isDeleteUnidentified()
boolean	isNotifySuccessfulRegistration()
boolean	isUseIsFinishedMarkerFile()
void	release()

Methods inherited from class java.lang.Object

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

Field Detail

operationLog

public static final org.apache.log4j.Logger operationLog

STAGING_DIR

public static final java.lang.String STAGING_DIR

See Also:

Constant Field Values

PRE_STAGING_DIR

public static final java.lang.String PRE_STAGING_DIR

See Also:

Constant Field Values

DEFAULT_PRE_STAGING_DIR

public static final java.lang.String DEFAULT_PRE_STAGING_DIR

See Also:

Constant Field Values

PRE_COMMIT_DIR

public static final java.lang.String PRE_COMMIT_DIR

See Also:

Constant Field Values

RECOVERY_MARKER_DIR

public static final java.lang.String RECOVERY_MARKER_DIR

See Also:

Constant Field Values

Constructor Detail

TopLevelDataSetRegistratorGlobalState

public TopLevelDataSetRegistratorGlobalState(java.lang.String dssCode,
                                             java.lang.String shareId,
                                             java.io.File storeRootDir,
                                             java.io.File dssInternalTempDir,
                                             java.io.File dssRegistrationLogDir,
                                             java.io.File dssRecoveryStateDir,
                                             ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService openBisService,
                                             IMailClient mailClient,
                                             ch.systemsx.cisd.etlserver.validation.IDataSetValidator dataSetValidator,
                                             IDataSourceQueryService dataSourceQueryService,
                                             ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory dynamicTransactionQueryFactory,
                                             boolean notifySuccessfulRegistration,
                                             ch.systemsx.cisd.etlserver.ThreadParameters threadParameters,
                                             ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager storageRecoveryManager)

Constructor that takes some values from the thread parameters.

TopLevelDataSetRegistratorGlobalState

public TopLevelDataSetRegistratorGlobalState(java.lang.String dssCode,
                                             java.lang.String shareId,
                                             java.io.File storeRootDir,
                                             java.io.File dssInternalTempDir,
                                             java.io.File dssRegistrationLogDir,
                                             java.io.File dssRecoveryStateDir,
                                             ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService openBisService,
                                             IMailClient mailClient,
                                             ch.systemsx.cisd.etlserver.validation.IDataSetValidator dataSetValidator,
                                             IDataSourceQueryService dataSourceQueryService,
                                             ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory dynamicTransactionQueryFactory,
                                             boolean notifySuccessfulRegistration,
                                             ch.systemsx.cisd.etlserver.ThreadParameters threadParameters,
                                             boolean useIsFinishedMarkerFile,
                                             boolean deleteUnidentified,
                                             java.lang.String preRegistrationScriptOrNull,
                                             java.lang.String postRegistrationScriptOrNull,
                                             java.lang.String[] validationScriptsOrNull,
                                             ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager storageRecoveryManager)

Method Detail

getDssCode

public java.lang.String getDssCode()

getShareId

public java.lang.String getShareId()

getStoreRootDir

public java.io.File getStoreRootDir()

getDssInternalTempDir

public java.io.File getDssInternalTempDir()

Get a directory that can be used for temporary files, and is local to the server.

getDssRegistrationLogDir

public java.io.File getDssRegistrationLogDir()

Get the directory that hold the DSS registration logs

getPreStagingDir

public java.io.File getPreStagingDir()

Get the directory used for pre-staging. This holds a hardlink copy of the incoming data.

getStagingDir

public java.io.File getStagingDir()

Get the staging directory used in registration.

getPreCommitDir

public java.io.File getPreCommitDir()

Get's the precommit directory. It is used to keep "ready to store" files.

getRecoveryStateDir

public java.io.File getRecoveryStateDir()

getOpenBisService

public ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService getOpenBisService()

getMailClient

public IMailClient getMailClient()

getDataSetValidator

public ch.systemsx.cisd.etlserver.validation.IDataSetValidator getDataSetValidator()

getDataSourceQueryService

public IDataSourceQueryService getDataSourceQueryService()

getDynamicTransactionQueryFactory

public ch.systemsx.cisd.etlserver.DynamicTransactionQueryFactory getDynamicTransactionQueryFactory()

isNotifySuccessfulRegistration

public boolean isNotifySuccessfulRegistration()

getThreadParameters

public ch.systemsx.cisd.etlserver.ThreadParameters getThreadParameters()

isUseIsFinishedMarkerFile

public boolean isUseIsFinishedMarkerFile()

isDeleteUnidentified

public boolean isDeleteUnidentified()

getPreRegistrationScript

public java.lang.String getPreRegistrationScript()

getPostRegistrationScript

public java.lang.String getPostRegistrationScript()

getValidationScriptsOrNull

public java.lang.String[] getValidationScriptsOrNull()

getAdministratorEmails

public java.util.List<java.lang.String> getAdministratorEmails()

Return the email addresses of all administrator users registered on the openBIS AS.

getStorageRecoveryManager

public ch.systemsx.cisd.etlserver.registrator.recovery.IDataSetStorageRecoveryManager getStorageRecoveryManager()

release

public void release()

Specified by:

release in interface ch.systemsx.cisd.common.resource.IReleasable