Package ch.systemsx.cisd.etlserver.registrator.api.v2

Class JavaTopLevelDataSetHandlerV2<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

  • All Implemented Interfaces:
    ch.systemsx.cisd.common.filesystem.FaultyPathDirectoryScanningHandler.IFaultyPathDirectoryScanningHandlerDelegate, ch.systemsx.cisd.common.filesystem.IPathHandler, ch.systemsx.cisd.common.filesystem.IStopSignaler, ch.systemsx.cisd.common.utilities.ISelfTestable, ch.systemsx.cisd.etlserver.ITopLevelDataSetRegistrator, ch.systemsx.cisd.etlserver.registrator.v2.IOmniscientEntityRegistrator<T>
    public class JavaTopLevelDataSetHandlerV2<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>
extends ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T>

    • Nested Class Summary

      • Nested classes/interfaces inherited from class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler

        ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler.RecoveryHookAdaptor

      • Nested classes/interfaces inherited from class ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator

        ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator.DoNothingDelegatedAction, ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator.NoOpDelegate, ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator.OmniscientTopLevelDataSetRegistratorState, ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator.PostRegistrationCleanUpAction

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROGRAM_CLASS_KEY  

      • Fields inherited from class ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator

        notificationLog, operationLog, state

    • Constructor Summary

      Constructors 
      Constructor Description
      JavaTopLevelDataSetHandlerV2​(ch.systemsx.cisd.etlserver.TopLevelDataSetRegistratorGlobalState globalState)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> createDataSetRegistrationService​(ch.systemsx.cisd.etlserver.registrator.DataSetFile incomingDataSetFile, ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation userProvidedDataSetInformationOrNull, ch.systemsx.cisd.common.action.IDelegatedActionWithResult<java.lang.Boolean> cleanAfterwardsAction, ch.systemsx.cisd.etlserver.ITopLevelDataSetRegistratorDelegate delegate)
      Create a V2 registration service.
      protected ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler.RecoveryHookAdaptor getRecoveryHookAdaptor​(java.io.File incoming)  
      protected IJavaDataSetRegistrationDropboxV2 getV2DropboxProgram​(ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> service)  
      protected void handleDataSet​(ch.systemsx.cisd.etlserver.registrator.DataSetFile dataSetFile, ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> service)  
      protected boolean hasRecoveryMarkerFile​(java.io.File incoming)  
      boolean shouldNotAddToFaultyPathsOrNull​(java.io.File file)
      V2 registration framework -- do not put files that are scheduled for recovery into the faulty paths.

      • Methods inherited from class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler

        asSerializableException, createJythonDataSetRegistrationService, createObjectFactory, didCommitTransaction, didPostRegistration, didPreRegistration, didRollbackTransaction, executeProcessFunctionWithRetries, handleRecovery, waitTheRetryPeriod, waitUntilApplicationIsReady, wrapTransaction

      • Methods inherited from class ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator

        check, didEncounterSecondaryTransactionErrors, getRegistrationLock, getRegistratorState, getRollBackStackParentFolder, handle, handle, handle, handleValidationErrors, isRemote, isStopped, registerDataSetInApplicationServer, rollback, updateStopped

      • Methods inherited from class ch.systemsx.cisd.etlserver.AbstractTopLevelDataSetRegistrator

        getGlobalState, isUseIsFinishedMarkerFile

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface ch.systemsx.cisd.etlserver.registrator.v2.IOmniscientEntityRegistrator

        getGlobalState

    • Field Detail

      • PROGRAM_CLASS_KEY

        public static final java.lang.String PROGRAM_CLASS_KEY
        See Also:
        Constant Field Values

    • Constructor Detail

      • JavaTopLevelDataSetHandlerV2

        public JavaTopLevelDataSetHandlerV2​(ch.systemsx.cisd.etlserver.TopLevelDataSetRegistratorGlobalState globalState)
        Parameters:
        globalState -

    • Method Detail

      • shouldNotAddToFaultyPathsOrNull

        public boolean shouldNotAddToFaultyPathsOrNull​(java.io.File file)
        V2 registration framework -- do not put files that are scheduled for recovery into the faulty paths.
        Specified by:
        shouldNotAddToFaultyPathsOrNull in interface ch.systemsx.cisd.common.filesystem.FaultyPathDirectoryScanningHandler.IFaultyPathDirectoryScanningHandlerDelegate
        Specified by:
        shouldNotAddToFaultyPathsOrNull in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

      • handleDataSet

        protected void handleDataSet​(ch.systemsx.cisd.etlserver.registrator.DataSetFile dataSetFile,
                             ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> service)
                      throws java.lang.Throwable
        Specified by:
        handleDataSet in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>
        Throws:
        java.lang.Throwable

      • getRecoveryHookAdaptor

        protected ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler.RecoveryHookAdaptor getRecoveryHookAdaptor​(java.io.File incoming)
        Specified by:
        getRecoveryHookAdaptor in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

      • createDataSetRegistrationService

        protected ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> createDataSetRegistrationService​(ch.systemsx.cisd.etlserver.registrator.DataSetFile incomingDataSetFile,
                                                                                                                   ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation userProvidedDataSetInformationOrNull,
                                                                                                                   ch.systemsx.cisd.common.action.IDelegatedActionWithResult<java.lang.Boolean> cleanAfterwardsAction,
                                                                                                                   ch.systemsx.cisd.etlserver.ITopLevelDataSetRegistratorDelegate delegate)
        Create a V2 registration service.
        Overrides:
        createDataSetRegistrationService in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

      • hasRecoveryMarkerFile

        protected boolean hasRecoveryMarkerFile​(java.io.File incoming)
        Overrides:
        hasRecoveryMarkerFile in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractOmniscientTopLevelDataSetRegistrator<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>

      • getV2DropboxProgram

        protected IJavaDataSetRegistrationDropboxV2 getV2DropboxProgram​(ch.systemsx.cisd.etlserver.registrator.v2.DataSetRegistrationService<T> service)
        Specified by:
        getV2DropboxProgram in class ch.systemsx.cisd.etlserver.registrator.v2.AbstractProgrammableTopLevelDataSetHandler<T extends ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation>