Class SCLMSCM
- java.lang.Object
-
- hudson.scm.SCM
-
- org.jenkinsci.plugins.IBM_zOS_Connector.SCLMSCM
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<SCM>
public class SCLMSCM extends SCM
SCLMSCM
Class implementing SCM functionality for SCLM.s- Version:
- 1.0
- Author:
- Alexander Shcherbakov
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SCLMSCM.SCLMSCMDescriptor
SCLMSCMDescriptor-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class hudson.scm.SCM
PERMISSIONS, TAG
-
-
Constructor Summary
Constructors Constructor Description SCLMSCM()
Dummy constructorSCLMSCM(String server, int port, String credentialsId, boolean JESINTERFACELEVEL1, boolean FTPActiveMode, String project, String alternate, String group, String types, boolean custJobStep, String JobStep, boolean custJobHeader, String JobHeader)
Constructor that is invoked from project configuration page.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SCMRevisionState
calcRevisionsFromBuild(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
Calculate revision from build.void
checkout(Run<?,?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline)
Checkout remote changes to the workspace.PollingResult
compareRemoteRevisionWith(Job<?,?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState _baseline)
Compare remote revision with old one.ChangeLogParser
createChangeLogParser()
Get parser for changelog.xml .String
getAlternate()
Get SCM Alternate Project Definition.String
getCredentialsId()
boolean
getCustJobHeader()
Get custJobHeader.boolean
getCustJobStep()
Get custJobStep.SCLMSCM.SCLMSCMDescriptor
getDescriptor()
Get descriptor.boolean
getFTPActiveMode()
Get FTPActiveModeString
getGroup()
Get SCLM Group.boolean
getJESINTERFACELEVEL1()
Get JESINTERFACELEVEL1.String
getJobHeader()
Get Job header.String
getJobStep()
Get Job step.int
getPort()
Get FTP port to connect to.String
getProject()
Get SCLM Project Name.String
getServer()
Get LPAR name or IP address.String
getTypes()
Get SCLM file types under interest.boolean
requiresWorkspaceForPolling()
Whether SCM requires workspace for polling process.boolean
supportsPolling()
Whether SCM supports polling.-
Methods inherited from class hudson.scm.SCM
_calcRevisionsFromBuild, _for, _for, all, buildEnvironment, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion
-
-
-
-
Constructor Detail
-
SCLMSCM
@DataBoundConstructor public SCLMSCM(String server, int port, String credentialsId, boolean JESINTERFACELEVEL1, boolean FTPActiveMode, String project, String alternate, String group, String types, boolean custJobStep, String JobStep, boolean custJobHeader, String JobHeader)
Constructor that is invoked from project configuration page.- Parameters:
server
- LPAR name of IP address.port
- FTP port to connect to.credentialsId
- Credentials id..JESINTERFACELEVEL1
- JESINTERFACELEVEL=1?FTPActiveMode
- FTP data transfer mode (true=active, false=passive)project
- SCLM Project Name.alternate
- SCLM Alternate Project Definition.group
- SCLM Group.types
- Types under interest (separated by comma).custJobStep
- Whether user defines own FLMCMD job step.JobStep
- User-supplies FLMCMD job step.custJobHeader
- Whether user supplied own job header.JobHeader
- User-supplied job header.
-
SCLMSCM
public SCLMSCM()
Dummy constructor
-
-
Method Detail
-
getCustJobHeader
public boolean getCustJobHeader()
Get custJobHeader.- Returns:
custJobHeader
-
getCustJobStep
public boolean getCustJobStep()
Get custJobStep.- Returns:
custJobStep
-
getServer
public String getServer()
Get LPAR name or IP address.- Returns:
server
-
getPort
public int getPort()
Get FTP port to connect to.- Returns:
port
-
getCredentialsId
public String getCredentialsId()
- Returns:
- credentials id provided.
-
getJESINTERFACELEVEL1
public boolean getJESINTERFACELEVEL1()
Get JESINTERFACELEVEL1.- Returns:
JESINTERFACELEVEL1
-
getFTPActiveMode
public boolean getFTPActiveMode()
Get FTPActiveMode- Returns:
FTPActiveMode
-
getProject
public String getProject()
Get SCLM Project Name.- Returns:
project
-
getAlternate
public String getAlternate()
Get SCM Alternate Project Definition.- Returns:
alternate
-
getGroup
public String getGroup()
Get SCLM Group.- Returns:
group
-
getJobHeader
public String getJobHeader()
Get Job header.- Returns:
JobHeader
-
getJobStep
public String getJobStep()
Get Job step.- Returns:
JobStep
-
getTypes
public String getTypes()
Get SCLM file types under interest.- Returns:
types
-
supportsPolling
public boolean supportsPolling()
Whether SCM supports polling.- Overrides:
supportsPolling
in classSCM
- Returns:
true
-
requiresWorkspaceForPolling
public boolean requiresWorkspaceForPolling()
Whether SCM requires workspace for polling process.- Overrides:
requiresWorkspaceForPolling
in classSCM
- Returns:
false
-
compareRemoteRevisionWith
public PollingResult compareRemoteRevisionWith(@Nonnull Job<?,?> project, Launcher launcher, FilePath workspace, @Nonnull TaskListener listener, @Nonnull SCMRevisionState _baseline)
Compare remote revision with old one.- Overrides:
compareRemoteRevisionWith
in classSCM
- Parameters:
project
- Current project.launcher
- Current launcher.workspace
- Current workspace.listener
- Current listener._baseline
- Old revision.- Returns:
- PollingResult with comparison.
- See Also:
PollingResult
,SCLMSCMRevisionState
,getNewRevision(SCLMSCMRevisionState, String, String)
-
checkout
public void checkout(@Nonnull Run<?,?> build, @Nonnull Launcher launcher, @Nonnull FilePath workspace, @Nonnull TaskListener listener, File changelogFile, SCMRevisionState baseline) throws IOException
Checkout remote changes to the workspace.
As the build itself is performed via SCLM, the checkout's main task is generation of revision.- Overrides:
checkout
in classSCM
- Parameters:
build
- Current build.launcher
- Current launcher.workspace
- Current workspace.listener
- Current listener.changelogFile
- Current changeLogFile.baseline
- Last revision.- Throws:
IOException
- See Also:
SCLMSCMRevisionState
,getNewRevision(SCLMSCMRevisionState, String, String)
-
calcRevisionsFromBuild
public SCMRevisionState calcRevisionsFromBuild(@Nonnull Run<?,?> build, FilePath workspace, Launcher launcher, @Nonnull TaskListener listener)
Calculate revision from build. Dummy.- Overrides:
calcRevisionsFromBuild
in classSCM
- Parameters:
build
- Current build.workspace
- Current workspace.launcher
- Current launcher.listener
- Current listener.- Returns:
- Actual revision.
- See Also:
SCLMSCMRevisionState
-
createChangeLogParser
public ChangeLogParser createChangeLogParser()
Get parser for changelog.xml .- Specified by:
createChangeLogParser
in classSCM
- Returns:
- SCLMChangeLogParser instance.
-
getDescriptor
public SCLMSCM.SCLMSCMDescriptor getDescriptor()
Get descriptor.- Specified by:
getDescriptor
in interfaceDescribable<SCM>
- Overrides:
getDescriptor
in classSCM
- Returns:
- Descriptor for SCLMSCM.
-
-