com.starteam
Class PurgeController

java.lang.Object
  com.starteam.PurgeController

public final class PurgeController
extends java.lang.Object

Provides control of the Online Purge service. The service may be configured to start automatically when the server starts up. If configured to do so, it will run a purge in the background while the server is running. This eliminates the requirement for costly down time just to purge the starteam repository. The online purge will not affect any resources deleted during the current active server session. Access the purge log by issuing a writeLogFile command with a logType value of 1.

Nested Class Summary

static class

PurgeController.Status Describes the current state of the purge service

Method Summary

PurgeController.Status	getPurgeStatus() Request the status of the Purge Service
PurgeController.Status	start() Start the online purge service
PurgeController.Status	stop() Stop the online purge service.

Methods inherited from class java.lang.Object

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

Method Detail

getPurgeStatus

public PurgeController.Status getPurgeStatus()

Request the status of the Purge Service

Returns:

the status of the Purge Service (Ready , In Progress, Completed, Error)

start

public PurgeController.Status start()

Start the online purge service

Returns:

the status of the start request

stop

public PurgeController.Status stop()

Stop the online purge service.

Returns:

the status of the stop request