com.myyearbook.hudson.plugins.confluence

Class ConfluencePublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.myyearbook.hudson.plugins.confluence.ConfluencePublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, Saveable, BuildStep, SimpleBuildStep

public final class ConfluencePublisher
extends Notifier
implements Saveable, SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfluencePublisher.DescriptorImpl
static class	ConfluencePublisher.EnvVarAction Build action that is capable of inserting arbitrary KVPs into the EnvVars.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ConfluencePublisher(String siteName, boolean buildIfUnstable, String spaceName, String pageName, String labels, boolean attachArchivedArtifacts, String fileSet, List<MarkupEditor> editorList, boolean replaceAttachments, long parentId) Deprecated.
ConfluencePublisher(String siteName, String spaceName, String pageName)

Method Summary

Modifier and Type	Method and Description
ConfluencePublisher.DescriptorImpl	getDescriptor()
List<MarkupEditor>	getEditorList()
String	getFileSet()
String	getLabels()
String	getPageName()
long	getParentId()
BuildStepMonitor	getRequiredMonitorService()
ConfluenceSite	getSite()
String	getSiteName()
String	getSpaceName()
boolean	isAttachArchivedArtifacts()
boolean	isBuildIfUnstable()
boolean	isReplaceAttachments()
protected void	log(TaskListener listener, String message) Log helper
void	perform(Run<?,?> build, FilePath filePath, Launcher launcher, TaskListener listener)
protected List<com.atlassian.confluence.api.model.content.Content>	performAttachments(Run build, FilePath ws, TaskListener listener, ConfluenceSession confluence, com.atlassian.confluence.api.model.content.Content pageContent)
void	save()
void	setAttachArchivedArtifacts(boolean attachArchivedArtifacts)
void	setBuildIfUnstable(boolean buildIfUnstable)
void	setEditorList(List<MarkupEditor> editorList)
void	setFileSet(String fileSet)
void	setLabels(String labels)
void	setParentId(long parentId)
void	setReplaceAttachments(boolean replaceAttachments)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

ConfluencePublisher

@Deprecated
public ConfluencePublisher(String siteName,
                                       boolean buildIfUnstable,
                                       String spaceName,
                                       String pageName,
                                       String labels,
                                       boolean attachArchivedArtifacts,
                                       String fileSet,
                                       List<MarkupEditor> editorList,
                                       boolean replaceAttachments,
                                       long parentId)

Deprecated.

ConfluencePublisher

@DataBoundConstructor
public ConfluencePublisher(@NonNull
                                                 String siteName,
                                                 @NonNull
                                                 String spaceName,
                                                 @NonNull
                                                 String pageName)

Method Detail

setBuildIfUnstable

@DataBoundSetter
public void setBuildIfUnstable(boolean buildIfUnstable)

setAttachArchivedArtifacts

@DataBoundSetter
public void setAttachArchivedArtifacts(boolean attachArchivedArtifacts)

setFileSet

@DataBoundSetter
public void setFileSet(String fileSet)

setReplaceAttachments

@DataBoundSetter
public void setReplaceAttachments(boolean replaceAttachments)

setLabels

@DataBoundSetter
public void setLabels(String labels)

setParentId

@DataBoundSetter
public void setParentId(long parentId)

setEditorList

@DataBoundSetter
public void setEditorList(List<MarkupEditor> editorList)

getEditorList

public List<MarkupEditor> getEditorList()

getDescriptor

public ConfluencePublisher.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

getFileSet

public String getFileSet()

Returns:

the fileSet

getPageName

@NonNull
public String getPageName()

Returns:

the pageName

getParentId

public long getParentId()

Returns:

the parentId

getLabels

public String getLabels()

Returns:

the labels

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

getSite

public ConfluenceSite getSite()

getSiteName

@NonNull
public String getSiteName()

Returns:

the siteName

getSpaceName

@NonNull
public String getSpaceName()

Returns:

the spaceName

performAttachments

protected List<com.atlassian.confluence.api.model.content.Content> performAttachments(Run build,
                                                                                      FilePath ws,
                                                                                      TaskListener listener,
                                                                                      ConfluenceSession confluence,
                                                                                      com.atlassian.confluence.api.model.content.Content pageContent)
                                                                               throws IOException,
                                                                                      InterruptedException

Throws:

IOException

InterruptedException

perform

public void perform(@NonNull
                    Run<?,?> build,
                    @NonNull
                    FilePath filePath,
                    @NonNull
                    Launcher launcher,
                    @NonNull
                    TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

log

protected void log(TaskListener listener,
                   String message)

Log helper

Parameters:

listener -

message -

isAttachArchivedArtifacts

public boolean isAttachArchivedArtifacts()

Returns:

the attachArchivedArtifacts

isBuildIfUnstable

public boolean isBuildIfUnstable()

Returns:

the buildIfUnstable

isReplaceAttachments

public boolean isReplaceAttachments()

Returns:

the replaceAttachments

save

public void save()

Specified by:

save in interface Saveable