RepositoryCleanerSystemListener (pentaho-platform-extensions 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.platform.plugin.services.repository.RepositoryCleanerSystemListener

All Implemented Interfaces:

org.pentaho.platform.api.engine.IPentahoSystemListener, org.pentaho.platform.api.scheduler2.IJobFilter
```
public class RepositoryCleanerSystemListener
extends Object
implements org.pentaho.platform.api.engine.IPentahoSystemListener, org.pentaho.platform.api.scheduler2.IJobFilter
```
This is a 5.4-only class. To use it, update systemListeners.xml by adding the following section:
```
  <bean id="repositoryCleanerSystemListener"
        class="org.pentaho.platform.plugin.services.repository.RepositoryCleanerSystemListener">
    <property name="gcEnabled" value="true"/>
    <property name="execute" value="now"/>
  </bean>
 
```
gcEnabled is a non-mandatory parameter, true by default. Use it to turn off the listener without removing its description from the XML-file execute is a parameter, that describes a time pattern of GC procedure. Supported values are:
- now - for one time execution
- weekly - for every Monday execution
- monthly - for every first day of month execution
Note, that periodic executions will be planned to start at 0:00. If an execution was not started at that time, e.g. the server was shut down, then it will be started as soon as the scheduler is restored.
Author:

Andrey Khayrutdinov

Constructor Summary

Constructors
Constructor Description

RepositoryCleanerSystemListener()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(org.pentaho.platform.api.scheduler2.Job job)`
`String`	`getExecute()`
`boolean`	`isGcEnabled()`
`void`	`setExecute(String execute)`
`void`	`setGcEnabled(boolean gcEnabled)`
`void`	`shutdown()`
`boolean`	`startup(org.pentaho.platform.api.engine.IPentahoSession session)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RepositoryCleanerSystemListener
```
public RepositoryCleanerSystemListener()
```

Method Detail

startup
```
public boolean startup(org.pentaho.platform.api.engine.IPentahoSession session)
```
Specified by:

startup in interface org.pentaho.platform.api.engine.IPentahoSystemListener

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface org.pentaho.platform.api.engine.IPentahoSystemListener

accept
```
public boolean accept(org.pentaho.platform.api.scheduler2.Job job)
```
Specified by:

accept in interface org.pentaho.platform.api.scheduler2.IJobFilter

isGcEnabled
```
public boolean isGcEnabled()
```

setGcEnabled

public void setGcEnabled(boolean gcEnabled)

getExecute
```
public String getExecute()
```

setExecute

public void setExecute(String execute)