Package org.jenkinsci.plugins.vmanager.charts.util

Class VManagerChartsLayoutStore

java.lang.Object

org.jenkinsci.plugins.vmanager.charts.util.VManagerChartsLayoutStore

public final class VManagerChartsLayoutStore
extends Object

Persists the per-job dashboard layout (chart order and per-chart width) for the two chart pages (VManagerChartsAction and BuildChartAction).

Storage is one JSON file per scope, placed under Job.getRootDir() (i.e. $JENKINS_HOME/jobs/<job>/). One layout is shared by all users; the build-scope layout is shared by every build of the job.

The JSON shape is opaque to Java — just a string blob written by the dashboard JS and replayed back to it. Java only validates length and that it parses as a JSON object (see doSaveLayout on the action classes).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUILD_LAYOUT_FILE
static final String	JOB_LAYOUT_FILE
static final int	MAX_LAYOUT_BYTES	Hard cap on payload size, just to keep a misbehaving client honest.

Method Summary

Modifier and Type	Method	Description
static String	loadBuildLayout(Job<?,?> job)
static String	loadJobLayout(Job<?,?> job)
static void	saveBuildLayout(Job<?,?> job, String json)
static void	saveJobLayout(Job<?,?> job, String json)

Methods inherited from class java.lang.Object

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

Field Details

JOB_LAYOUT_FILE

public static final String JOB_LAYOUT_FILE

See Also:

• Constant Field Values

BUILD_LAYOUT_FILE

public static final String BUILD_LAYOUT_FILE

See Also:

• Constant Field Values

MAX_LAYOUT_BYTES

public static final int MAX_LAYOUT_BYTES

Hard cap on payload size, just to keep a misbehaving client honest.

See Also:

• Constant Field Values

Method Details

loadJobLayout

public static String loadJobLayout(Job<?,?> job)

loadBuildLayout

public static String loadBuildLayout(Job<?,?> job)

saveJobLayout

public static void saveJobLayout(Job<?,?> job,
 String json)
                          throws IOException

Throws:

IOException

saveBuildLayout

public static void saveBuildLayout(Job<?,?> job,
 String json)
                            throws IOException

Throws:

IOException