Package nl.nn.adapterframework.pipes

Class CleanupOldFilesPipe

    • Constructor Detail

      • CleanupOldFilesPipe

        public CleanupOldFilesPipe()

    • Method Detail

      • doPipe

        public PipeRunResult doPipe​(Message message,
                            PipeLineSession session)
                     throws PipeRunException
        Description copied from interface: IPipe
        This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
        Throws:
        PipeRunException

      • setFilePattern

        public void setFilePattern​(String string)
        files that match this pattern will be deleted. parameters of the pipe are applied to this pattern. if this attribute is not set, the input of the pipe is interpreted as the file to be removed

      • getFilePattern

        public String getFilePattern()

      • setFilePatternSessionKey

        public void setFilePatternSessionKey​(String string)
        session key that contains the pattern of files to be deleted, only used if filePattern is not set

      • getFilePatternSessionKey

        public String getFilePatternSessionKey()

      • setLastModifiedDelta

        public void setLastModifiedDelta​(long l)
        time in milliseconds after last modification that must have passed at least before a file will be deleted (set to negative value to disable)
        Default value
        0

      • getLastModifiedDelta

        public long getLastModifiedDelta()

      • setSubdirectories

        public void setSubdirectories​(boolean b)
        when true, files in subdirectories will be deleted, too
        Default value
        false

      • isSubdirectories

        public boolean isSubdirectories()

      • setDeleteEmptySubdirectories

        public void setDeleteEmptySubdirectories​(boolean b)
        when true, empty subdirectories will be deleted, too
        Default value
        false

      • isDeleteEmptySubdirectories

        public boolean isDeleteEmptySubdirectories()

      • setWildcard

        public void setWildcard​(String string)
        filter of files to delete. if not set and a directory is specified, all files in the directory are interpreted to be deleted

      • getWildcard

        public String getWildcard()

      • setExcludeWildcard

        public void setExcludeWildcard​(String excludeWildcard)
        filter of files to be excluded for deletion

      • getExcludeWildcard

        public String getExcludeWildcard()

      • setMinStableTime

        public void setMinStableTime​(long minStableTime)
        Minimal age of file in milliseconds, to avoid deleting a file while it is still being written (only used when wildcard is set) (set to 0 to disable)
        Default value
        1000

      • getMinStableTime

        public long getMinStableTime()