com.maxxton.microdocs.jenkins

Class MicroDocsChecker

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.maxxton.microdocs.jenkins.MicroDocsChecker

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class MicroDocsChecker
extends hudson.tasks.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MicroDocsChecker.Descriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
MicroDocsChecker(java.lang.String microDocsReportFile, java.lang.String microDocsProjectName, java.lang.String microDocsGroupName, java.lang.String microDocsEnvironments, java.lang.String microDocsSourceFolder, boolean microDocsFailBuild, boolean microDocsPublish, boolean microDocsNotifyPullRequest)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMicroDocsEnvironments()
java.lang.String	getMicroDocsGroupName()
java.lang.String	getMicroDocsProjectName()
java.lang.String	getMicroDocsReportFile()
java.lang.String	getMicroDocsSourceFolder()
boolean	isMicroDocsFailBuild()
boolean	isMicroDocsNotifyPullRequest()
boolean	isMicroDocsPublish()
protected <C extends com.cloudbees.plugins.credentials.Credentials> java.util.List<C>	lookupCredentials(java.lang.Class<C> type, hudson.model.Item item, org.acegisecurity.Authentication authentication, java.util.ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
protected <C extends com.cloudbees.plugins.credentials.Credentials> java.util.List<C>	lookupCredentials(java.lang.Class<C> type, hudson.model.ItemGroup<?> itemGroup, org.acegisecurity.Authentication authentication, java.util.ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

MicroDocsChecker

@DataBoundConstructor
public MicroDocsChecker(java.lang.String microDocsReportFile,
                                               java.lang.String microDocsProjectName,
                                               java.lang.String microDocsGroupName,
                                               java.lang.String microDocsEnvironments,
                                               java.lang.String microDocsSourceFolder,
                                               boolean microDocsFailBuild,
                                               boolean microDocsPublish,
                                               boolean microDocsNotifyPullRequest)

Method Detail

getMicroDocsReportFile

public java.lang.String getMicroDocsReportFile()

getMicroDocsProjectName

public java.lang.String getMicroDocsProjectName()

getMicroDocsGroupName

public java.lang.String getMicroDocsGroupName()

getMicroDocsEnvironments

public java.lang.String getMicroDocsEnvironments()

getMicroDocsSourceFolder

public java.lang.String getMicroDocsSourceFolder()

isMicroDocsFailBuild

public boolean isMicroDocsFailBuild()

isMicroDocsPublish

public boolean isMicroDocsPublish()

isMicroDocsNotifyPullRequest

public boolean isMicroDocsNotifyPullRequest()

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

java.lang.InterruptedException

java.io.IOException

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> java.util.List<C> lookupCredentials(java.lang.Class<C> type,
                                                                                                        hudson.model.Item item,
                                                                                                        org.acegisecurity.Authentication authentication,
                                                                                                        java.util.ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

item - the item.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> java.util.List<C> lookupCredentials(java.lang.Class<C> type,
                                                                                                        hudson.model.ItemGroup<?> itemGroup,
                                                                                                        org.acegisecurity.Authentication authentication,
                                                                                                        java.util.ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

itemGroup - the item group.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.