Package org.jenkinsci.plugins.IBM_zOS_Connector

Class SCLMSCM

java.lang.Object
hudson.scm.SCM
org.jenkinsci.plugins.IBM_zOS_Connector.SCLMSCM
All Implemented Interfaces:
hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>
public class SCLMSCM
extends hudson.scm.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

    hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Field Summary

    Fields inherited from class hudson.scm.SCM

    PERMISSIONS, TAG

  • Constructor Summary

    Constructors
    Constructor Description
    SCLMSCM()
    Dummy constructor
    SCLMSCM​(java.lang.String server, int port, java.lang.String credentialsId, boolean JESINTERFACELEVEL1, boolean FTPActiveMode, java.lang.String project, java.lang.String alternate, java.lang.String group, java.lang.String types, boolean custJobStep, java.lang.String JobStep, boolean custJobHeader, java.lang.String JobHeader)
    Constructor that is invoked from project configuration page.

  • Method Summary

    Modifier and Type Method Description
    hudson.scm.SCMRevisionState calcRevisionsFromBuild​(hudson.model.Run<?,​?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
    Calculate revision from build.
    void checkout​(hudson.model.Run<?,​?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, java.io.File changelogFile, hudson.scm.SCMRevisionState baseline)
    Checkout remote changes to the workspace.
    hudson.scm.PollingResult compareRemoteRevisionWith​(hudson.model.Job<?,​?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState _baseline)
    Compare remote revision with old one.
    hudson.scm.ChangeLogParser createChangeLogParser()
    Get parser for changelog.xml .
    java.lang.String getAlternate()
    Get SCM Alternate Project Definition.
    java.lang.String getCredentialsId()  
    boolean getCustJobHeader()
    Get custJobHeader.
    boolean getCustJobStep()
    Get custJobStep.
    SCLMSCM.SCLMSCMDescriptor getDescriptor()
    Get descriptor.
    boolean getFTPActiveMode()
    Get FTPActiveMode
    java.lang.String getGroup()
    Get SCLM Group.
    boolean getJESINTERFACELEVEL1()
    Get JESINTERFACELEVEL1.
    java.lang.String getJobHeader()
    Get Job header.
    java.lang.String getJobStep()
    Get Job step.
    int getPort()
    Get FTP port to connect to.
    java.lang.String getProject()
    Get SCLM Project Name.
    java.lang.String getServer()
    Get LPAR name or IP address.
    java.lang.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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SCLMSCM

      @DataBoundConstructor public SCLMSCM​(java.lang.String server, int port, java.lang.String credentialsId, boolean JESINTERFACELEVEL1, boolean FTPActiveMode, java.lang.String project, java.lang.String alternate, java.lang.String group, java.lang.String types, boolean custJobStep, java.lang.String JobStep, boolean custJobHeader, java.lang.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 Details

    • getCustJobHeader

      public boolean getCustJobHeader()
      Get custJobHeader.
      Returns:
      custJobHeader

    • getCustJobStep

      public boolean getCustJobStep()
      Get custJobStep.
      Returns:
      custJobStep

    • getServer

      public java.lang.String getServer()
      Get LPAR name or IP address.
      Returns:
      server

    • getPort

      public int getPort()
      Get FTP port to connect to.
      Returns:
      port

    • getCredentialsId

      public java.lang.String getCredentialsId()
      Returns:
      credentials id provided.

    • getJESINTERFACELEVEL1

      public boolean getJESINTERFACELEVEL1()
      Get JESINTERFACELEVEL1.
      Returns:
      JESINTERFACELEVEL1

    • getFTPActiveMode

      public boolean getFTPActiveMode()
      Get FTPActiveMode
      Returns:
      FTPActiveMode

    • getProject

      public java.lang.String getProject()
      Get SCLM Project Name.
      Returns:
      project

    • getAlternate

      public java.lang.String getAlternate()
      Get SCM Alternate Project Definition.
      Returns:
      alternate

    • getGroup

      public java.lang.String getGroup()
      Get SCLM Group.
      Returns:
      group

    • getJobHeader

      public java.lang.String getJobHeader()
      Get Job header.
      Returns:
      JobHeader

    • getJobStep

      public java.lang.String getJobStep()
      Get Job step.
      Returns:
      JobStep

    • getTypes

      public java.lang.String getTypes()
      Get SCLM file types under interest.
      Returns:
      types

    • supportsPolling

      public boolean supportsPolling()
      Whether SCM supports polling.
      Overrides:
      supportsPolling in class hudson.scm.SCM
      Returns:
      true

    • requiresWorkspaceForPolling

      public boolean requiresWorkspaceForPolling()
      Whether SCM requires workspace for polling process.
      Overrides:
      requiresWorkspaceForPolling in class hudson.scm.SCM
      Returns:
      false

    • compareRemoteRevisionWith

      public hudson.scm.PollingResult compareRemoteRevisionWith​(@Nonnull hudson.model.Job<?,​?> project, hudson.Launcher launcher, hudson.FilePath workspace, @Nonnull hudson.model.TaskListener listener, @Nonnull hudson.scm.SCMRevisionState _baseline)
      Compare remote revision with old one.
      Overrides:
      compareRemoteRevisionWith in class hudson.scm.SCM
      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 hudson.model.Run<?,​?> build, @Nonnull hudson.Launcher launcher, @Nonnull hudson.FilePath workspace, @Nonnull hudson.model.TaskListener listener, java.io.File changelogFile, hudson.scm.SCMRevisionState baseline) throws java.io.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 class hudson.scm.SCM
      Parameters:
      build - Current build.
      launcher - Current launcher.
      workspace - Current workspace.
      listener - Current listener.
      changelogFile - Current changeLogFile.
      baseline - Last revision.
      Throws:
      java.io.IOException
      See Also:
      SCLMSCMRevisionState, getNewRevision(SCLMSCMRevisionState, String, String)

    • calcRevisionsFromBuild

      public hudson.scm.SCMRevisionState calcRevisionsFromBuild​(@Nonnull hudson.model.Run<?,​?> build, hudson.FilePath workspace, hudson.Launcher launcher, @Nonnull hudson.model.TaskListener listener)
      Calculate revision from build. Dummy.
      Overrides:
      calcRevisionsFromBuild in class hudson.scm.SCM
      Parameters:
      build - Current build.
      workspace - Current workspace.
      launcher - Current launcher.
      listener - Current listener.
      Returns:
      Actual revision.
      See Also:
      SCLMSCMRevisionState

    • createChangeLogParser

      public hudson.scm.ChangeLogParser createChangeLogParser()
      Get parser for changelog.xml .
      Specified by:
      createChangeLogParser in class hudson.scm.SCM
      Returns:
      SCLMChangeLogParser instance.

    • getDescriptor

      public SCLMSCM.SCLMSCMDescriptor getDescriptor()
      Get descriptor.
      Specified by:
      getDescriptor in interface hudson.model.Describable<hudson.scm.SCM>
      Overrides:
      getDescriptor in class hudson.scm.SCM
      Returns:
      Descriptor for SCLMSCM.