jp.ikedam.jenkins.plugins.jobcopy_builder

Class AbstractXmlJobcopyOperation

java.lang.Object

hudson.model.AbstractDescribableImpl<JobcopyOperation>

jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation

jp.ikedam.jenkins.plugins.jobcopy_builder.AbstractXmlJobcopyOperation

All Implemented Interfaces:

ExtensionPoint, Describable<JobcopyOperation>

Direct Known Subclasses:

DisableOperation, EnableOperation, ReplaceOperation

public abstract class AbstractXmlJobcopyOperation
extends JobcopyOperation

Abstract class for job copy operation using XML DOM.

See Also:

JobcopyOperation

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AbstractXmlJobcopyOperation()

Method Summary

Modifier and Type	Method and Description
protected Node	getNode(Document doc, String xpath) Retrieve a XML node using XPath.
protected NodeList	getNodeList(Document doc, String xpathExpression) Retrieve a XML node list using XPath.
protected String	getXpath(Node targetNode) Retrieve a XPath expression of a node.
abstract Document	perform(Document doc, EnvVars env, PrintStream logger) Performs modifications to job configure XML Document.
String	perform(String xmlString, String encoding, EnvVars env, PrintStream logger) Returns modified XML string of the job configuration.

Methods inherited from class jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation

all

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlJobcopyOperation

public AbstractXmlJobcopyOperation()

Method Detail

perform

public abstract Document perform(Document doc,
                                 EnvVars env,
                                 PrintStream logger)

Performs modifications to job configure XML Document.

Parameters:

doc - XML Document of the job to be copied (job/NAME/config.xml)

env - Variables defined in the build.

logger - The output stream to log.

Returns:

modified XML Document. Return null if an error occurs.

perform

public String perform(String xmlString,
                      String encoding,
                      EnvVars env,
                      PrintStream logger)

Returns modified XML string of the job configuration.

Specified by:

perform in class JobcopyOperation

Parameters:

xmlString - the XML string of the job to be copied (job/NAME/config.xml)

encoding - the encoding of the XML.

env - Variables defined in the build.

logger - The output stream to log.

Returns:

modified XML string. Returns null if an error occurs.

See Also:

JobcopyOperation.perform(java.lang.String, java.lang.String, hudson.EnvVars, java.io.PrintStream)

getNode

protected Node getNode(Document doc,
                       String xpath)
                throws XPathExpressionException

Retrieve a XML node using XPath. Returns null in following cases:

• No node found.
• More than one node found.

Parameters:

doc - the XML Document object.

xpath - a XPath specifying the retrieving node.

Returns:

the retrieved node.

Throws:

XPathExpressionException - problems in xpath

getNodeList

protected NodeList getNodeList(Document doc,
                               String xpathExpression)
                        throws XPathExpressionException

Retrieve a XML node list using XPath.

Parameters:

doc - the XML Document object.

xpathExpression - a XPath specifying the retrieving nodes.

Returns:

retrieved nodes in NodeList

Throws:

XPathExpressionException - problems in xpathExpression

getXpath

protected String getXpath(Node targetNode)

Retrieve a XPath expression of a node. Use only for displaying purposes only. For this works not so strict, the return value supposes not to work proper with XPath processors.

Parameters:

targetNode - a node whose XPath expression is retrieved.

Returns:

XPath expression.