﻿<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="scheduler_job_documentation.xsl"?>
<description xmlns="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0 http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0.xsd">

  <job name  = "JobSchedulerCleanupFiles"
       title = "Remove temporary files"
       order = "no"
       tasks = "1">
    <script language   = "java"
            java_class = "sos.scheduler.job.JobSchedulerCleanupFiles"
            resource   = "1">
    </script>
  </job>

  <releases>
    <release id="1.0" created="2006-02-20" modified="2006-02-21">
      <title>Version 1.0</title>
      <author name="Andreas Püschel" email="andreas.pueschel@sos-berlin.com"/>
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Initiale Auslieferung</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Initial release</div></note>
    </release>
  </releases>

  <resources>
    <file os="all" type="java" file="sos.scheduler.jar" id="1">
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Standard-Job der Auslieferung</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Standard job in distribution</div></note>
    </file>
    <file os="all" type="java" file="sos.spooler.jar" id="2">
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Klasse Job_Impl</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Class Job_Impl</div></note>
    </file>
    <file os="all" type="java" file="sos.util.jar" id="3">
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Klasse SOSFile</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Class SOSFile</div></note>
    </file>
    <file os="all" type="java" file="sos.settings.jar" id="4">
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Klasse SOSProfileSettings</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Class SOSProfileSettings</div></note>
    </file>
    <file os="win32"     type="binary" file="hostole.dll"    id="5"/>
    <file os="win32"     type="binary" file="hostjava.dll"   id="6"/>
    <file os="linux32"   type="binary" file="libhostole.so"  id="7"/>
    <file os="linux32"   type="binary" file="libhostjava.so" id="8"/>
    <file os="solaris32" type="binary" file="libhostole.so"  id="9"/>
    <file os="solaris32" type="binary" file="libhostjava.so" id="10"/>
    <file os="hpux64"    type="binary" file="libhostjava.sl" id="11"/>
  </resources>

  <configuration>
    <params id="job_parameter">
      <param name="file_path" default_value="" required="false">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter benennt ein Verzeichnis mit Dateien, die entfernt werden sollen.
            <br/><br/>
            Fehlt der Parameter, dann wird das Verzeichnis für temporäre Dateien verwendet.
            Unter Unix ist dies das Verzeichnis <code>/tmp</code>, unter Windows das Temp-Verzeichnis der Kennung des Job Schedulers.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies a directory with files to be removed.
            <br/><br/>
            If this parameter is not given, then the temporary files directory for will be used.
            For Unix this is <code>/tmp</code>, for Windows this is the Job Scheduler account temporary files directory.
          </div>
        </note>
      </param>
      <param name="file_specification" default_value="^(sos.*)" required="false">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter spezifiziert einen regulären Ausdruck für die zu entfernenden Dateien.
            <br/><br/>
            Per Voreinstellung werden die vom Job Scheduler erzeugten und ggf. nicht entfernten Dateien gelöscht.
            Vom Job Scheduler erzeugte temporäre Dateien enthalten das Präfix <em>sos</em>.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies a regular expression for the files to be removed.
            <br/><br/>
            By default temporary files are removed that have been created by the Job Scheduler
            and for some reason could not be deleted.
            Temporary files created by the Job Scheduler have the prefix <em>sos</em>.
          </div>
        </note>
      </param>
      <param name="file_age" default_value="24:00" required="false">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter bestimmt das Mindestalter der Dateien, die entfernt werden.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies the minimum age of the files to be removed.
          </div>
        </note>
      </param>
      <param name="warning_file_limit" default_value="0" required="false">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Werden in einem Verzeichnis mehr als die hier konfigurierte Anzahl an Dateien gefunden,
            so wird eine Warnung ausgegeben.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Should more files be found in a directory than the number which is configured here, the job
            will produce a warning message.
          </div>
        </note>
      </param>
    </params>
  </configuration>

  <documentation language="de">
    <div xmlns="http://www.w3.org/1999/xhtml">
      Der Job entfernt temporäre Dateien. Dies ist für den Job Scheduler selbst nicht erforderlich,
      da hier temporäre Dateien, z.B. der Ausgaben von Jobs nach stdout oder stderr, automatisch gelöscht werden.
      <br/><br/>
      Sie können den Job einsetzen, um die von indivduell implementierten Job erzeugten temporären Dateien
      regelmäßig zu löschen.
    </div>
  </documentation>

  <documentation language="en">
    <div xmlns="http://www.w3.org/1999/xhtml">
      This job removes temporary files. 
      It is not required for the Job Scheduler itself - which automatically removes temporary files, 
      e.g. for output to stdout or stderr.
      <br/><br/>
      This job should be used when indivdual job implementations create temporary files, 
      which then need to be regularly deleted.
    </div>
  </documentation>
</description>
