UpkeepResponse (Parent module for everything of interest. 6.2.3 API)

java.lang.Object
- edu.uiuc.ncsa.security.storage.monitored.upkeep.UpkeepResponse

public class UpkeepResponse
extends Object

Created by Jeff Gaynor
on 2/14/24 at 11:19 AM

Field Summary

Fields
Modifier and Type	Field	Description
`int`	`archiveCount`	The identifiers (as strings) to archive
`List<String>`	`archivedList`
`UpkeepStats`	`archivedStats`
`int`	`attempted`	Total number of deletions attempted
`int`	`deleteCount`
`List<String>`	`deletedList`	The identifiers (as strings) to remove.
`UpkeepStats`	`deletedStats`
`String`	`name`
`int`	`retainedCount`	The number skipped, i.e., that had retain = true.
`List<String>`	`retainedList`
`int`	`skipped`	Would have been deleted normally, but some other rule said to retain.
`int`	`testedCount`
`boolean`	`testModeOnly`

Constructor Summary

Constructors
Constructor Description

UpkeepResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`formatCollaterals(boolean prettyPrint, int width)`	Format the contents of the collateral map.
`Map<String,Long>`	`getCollateralMap()`
`String`	`report(boolean prettyPrint)`
`void`	`setCollateralMap(Map<String,Long> collateralMap)`
`net.sf.json.JSONObject`	`toJSON()`
`String`	`toString()`

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

Field Detail
- attempted
```
public int attempted
```
  Total number of deletions attempted
- deleteCount
```
public int deleteCount
```
- deletedList
```
public List<String> deletedList
```
  The identifiers (as strings) to remove.
- deletedStats
```
public UpkeepStats deletedStats
```
- archiveCount
```
public int archiveCount
```
  The identifiers (as strings) to archive
- archivedList
```
public List<String> archivedList
```
- archivedStats
```
public UpkeepStats archivedStats
```
- retainedList
```
public List<String> retainedList
```
- retainedCount
```
public int retainedCount
```
  The number skipped, i.e., that had retain = true.
- name
```
public String name
```
- testedCount
```
public int testedCount
```
- testModeOnly
```
public boolean testModeOnly
```
- skipped
```
public int skipped
```
  Would have been deleted normally, but some other rule said to retain.

Constructor Detail
- UpkeepResponse
```
public UpkeepResponse()
```

Method Detail

getCollateralMap

public Map<String,Long> getCollateralMap()

setCollateralMap

public void setCollateralMap(Map<String,Long> collateralMap)

report

public String report(boolean prettyPrint)

formatCollaterals
```
protected String formatCollaterals(boolean prettyPrint,
                                   int width)
```
Format the contents of the collateral map. This offsets each entry for proper display within the margins.

Parameters:

prettyPrint -

width -

Returns:

toString
```
public String toString()
```
Overrides:

toString in class Object

toJSON

public net.sf.json.JSONObject toJSON()