org.jenkinsci.plugins.badge.actions

Class PublicBuildStatusAction

java.lang.Object

org.jenkinsci.plugins.badge.actions.PublicBuildStatusAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, hudson.model.UnprotectedRootAction

@Extension
public class PublicBuildStatusAction
extends Object
implements hudson.model.UnprotectedRootAction

Exposes the build status badge via unprotected URL. Even though the URL is unprotected, the user does still need the 'ViewStatus' permission on the given Job. If you want the status icons to be public readable/accessible, just grant the 'ViewStatus' permission globally to 'anonymous'.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.security.Permission	VIEW_STATUS

Constructor Summary

Constructors

Constructor and Description
PublicBuildStatusAction()

Method Summary

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doIcon(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String job, String build, String style, String subject, String status, String color, String animatedOverlayColor, String config)
org.kohsuke.stapler.HttpResponse	doIconDotSvg(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String job, String build, String style, String subject, String status, String color, String animatedOverlayColor, String config)
String	doText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String job, String build)
String	getDisplayName()
String	getIconFileName()
static hudson.model.Run<?,?>	getRun(hudson.model.Job<?,?> project, String build, Boolean throwErrorWhenNotFound)
String	getUrlName()

Methods inherited from class java.lang.Object

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

Field Detail

VIEW_STATUS

public static final hudson.security.Permission VIEW_STATUS

Constructor Detail

PublicBuildStatusAction

public PublicBuildStatusAction()
                        throws IOException

Throws:

IOException

Method Detail

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

doIcon

@WebMethod(name="icon")
public org.kohsuke.stapler.HttpResponse doIcon(org.kohsuke.stapler.StaplerRequest req,
                                                                        org.kohsuke.stapler.StaplerResponse rsp,
                                                                        @QueryParameter
                                                                        String job,
                                                                        @QueryParameter
                                                                        String build,
                                                                        @QueryParameter
                                                                        String style,
                                                                        @QueryParameter
                                                                        String subject,
                                                                        @QueryParameter
                                                                        String status,
                                                                        @QueryParameter
                                                                        String color,
                                                                        @QueryParameter
                                                                        String animatedOverlayColor,
                                                                        @QueryParameter
                                                                        String config)

doIconDotSvg

@WebMethod(name="icon.svg")
public org.kohsuke.stapler.HttpResponse doIconDotSvg(org.kohsuke.stapler.StaplerRequest req,
                                                                                  org.kohsuke.stapler.StaplerResponse rsp,
                                                                                  @QueryParameter
                                                                                  String job,
                                                                                  @QueryParameter
                                                                                  String build,
                                                                                  @QueryParameter
                                                                                  String style,
                                                                                  @QueryParameter
                                                                                  String subject,
                                                                                  @QueryParameter
                                                                                  String status,
                                                                                  @QueryParameter
                                                                                  String color,
                                                                                  @QueryParameter
                                                                                  String animatedOverlayColor,
                                                                                  @QueryParameter
                                                                                  String config)

doText

public String doText(org.kohsuke.stapler.StaplerRequest req,
                     org.kohsuke.stapler.StaplerResponse rsp,
                     @QueryParameter
                     String job,
                     @QueryParameter
                     String build)

getRun

public static hudson.model.Run<?,?> getRun(hudson.model.Job<?,?> project,
                                           String build,
                                           Boolean throwErrorWhenNotFound)