Package io.jenkins.plugins.swarmcloud

Class SwarmDashboard

java.lang.Object

hudson.model.ManagementLink

io.jenkins.plugins.swarmcloud.SwarmDashboard

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class SwarmDashboard
extends ManagementLink
implements RootAction

Dashboard for monitoring Docker Swarm agents. Accessible from Jenkins Management page.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.ManagementLink

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor	Description
SwarmDashboard()

Method Summary

Modifier and Type	Method	Description
void	doApi(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String cloud)	API endpoint to get cluster status as JSON.
org.kohsuke.stapler.HttpResponse	doRefresh(String cloud)	API endpoint to refresh metrics for a cloud.
org.kohsuke.stapler.HttpResponse	doRemoveService(String cloud, String serviceId)	API endpoint to remove a service.
Map<String,ClusterStatus>	getAllStatuses()	Gets all cluster statuses.
ManagementLink.Category	getCategory()
ClusterStatus	getClusterStatus(String cloudName)	Gets the status for a specific cloud.
String	getDescription()
String	getDisplayName()
String	getIconFileName()
long	getLastUpdate()	Gets the last update timestamp.
Permission	getRequiredPermission()
List<SwarmCloud>	getSwarmClouds()	Gets all Swarm clouds.
String	getUrlName()

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategoryName, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.RootAction

getBadge, isPrimaryAction

Constructor Details

SwarmDashboard

public SwarmDashboard()

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

getDescription

public String getDescription()

Overrides:

getDescription in class ManagementLink

getCategory

@NonNull
public ManagementLink.Category getCategory()

Overrides:

getCategory in class ManagementLink

getRequiredPermission

@NonNull
public Permission getRequiredPermission()

Overrides:

getRequiredPermission in class ManagementLink

getSwarmClouds

@NonNull
public List<SwarmCloud> getSwarmClouds()

Gets all Swarm clouds.

getClusterStatus

@NonNull
public ClusterStatus getClusterStatus(@NonNull
 String cloudName)

Gets the status for a specific cloud.

getAllStatuses

@NonNull
public Map<String,ClusterStatus> getAllStatuses()

Gets all cluster statuses.

getLastUpdate

public long getLastUpdate()

Gets the last update timestamp.

doApi

@GET
public void doApi(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp,
 @QueryParameter
 String cloud)
           throws IOException

API endpoint to get cluster status as JSON.

Throws:

IOException

doRefresh

@POST
public org.kohsuke.stapler.HttpResponse doRefresh(@QueryParameter
 String cloud)

API endpoint to refresh metrics for a cloud.

doRemoveService

@POST
public org.kohsuke.stapler.HttpResponse doRemoveService(@QueryParameter
 String cloud,
 @QueryParameter
 String serviceId)

API endpoint to remove a service.