hudson.plugins.starteam
Class StarTeamSCM

java.lang.Object
  hudson.scm.SCM
      hudson.plugins.starteam.StarTeamSCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>

public class StarTeamSCM
extends hudson.scm.SCM

StarTeam SCM plugin for Hudson. Add support for change log and synchronization between starteam repository and hudson's workspace. Add support for change log creation. Refactoring to use Extension annotation and to remove use of deprecated API.

Author:

Ilkka Laukkanen , Steve Favez

Nested Class Summary

static class

StarTeamSCM.StarTeamSCMDescriptorImpl Descriptor class for the SCM class.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static StarTeamSCM.StarTeamSCMDescriptorImpl

DESCRIPTOR Singleton descriptor.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

StarTeamSCM(java.lang.String hostname, int port, java.lang.String projectname, java.lang.String viewname, java.lang.String foldername, java.lang.String username, java.lang.String password)
default stapler constructor.

Method Summary

boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, java.io.File changelogFile)
hudson.scm.ChangeLogParser	createChangeLogParser()
StarTeamSCM.StarTeamSCMDescriptorImpl	getDescriptor()
java.lang.String	getFoldername() Get the root folder name of our monitored workspace.
java.lang.String	getHostname() Get the hostname this SCM is using.
java.lang.String	getPassword() Get the password used to connect to starteam.
int	getPort() Get the port number this SCM is using.
java.lang.String	getProjectname() Get the project name this SCM is connected to.
java.lang.String	getUsername() Get the username used to connect to starteam.
java.lang.String	getViewname() Get the view name in the project this SCM uses.
boolean	pollChanges(hudson.model.AbstractProject proj, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener)

Methods inherited from class hudson.scm.SCM

_for, all, buildEnvVars, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getModuleRoot, getModuleRoots, getType, nullify, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, supportsPolling

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final StarTeamSCM.StarTeamSCMDescriptorImpl DESCRIPTOR

Singleton descriptor.

Constructor Detail

StarTeamSCM

@DataBoundConstructor
public StarTeamSCM(java.lang.String hostname,
                                        int port,
                                        java.lang.String projectname,
                                        java.lang.String viewname,
                                        java.lang.String foldername,
                                        java.lang.String username,
                                        java.lang.String password)

default stapler constructor.

Parameters:

hostname - starteam host name.

port - starteam port name

projectname - name of the project

viewname - name of the view

foldername - parent folder name.

username - the user name required to connect to starteam's server

password - password required to connect to starteam's server

Method Detail

checkout

public boolean checkout(hudson.model.AbstractBuild build,
                        hudson.Launcher launcher,
                        hudson.FilePath workspace,
                        hudson.model.BuildListener listener,
                        java.io.File changelogFile)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Specified by:

checkout in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

getDescriptor

public StarTeamSCM.StarTeamSCMDescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.scm.SCM>

Overrides:

getDescriptor in class hudson.scm.SCM

pollChanges

public boolean pollChanges(hudson.model.AbstractProject proj,
                           hudson.Launcher launcher,
                           hudson.FilePath workspace,
                           hudson.model.TaskListener listener)
                    throws java.io.IOException,
                           java.lang.InterruptedException

Specified by:

pollChanges in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

getHostname

public java.lang.String getHostname()

Get the hostname this SCM is using.

Returns:

The hostname.

getPort

public int getPort()

Get the port number this SCM is using.

Returns:

The port.

getProjectname

public java.lang.String getProjectname()

Get the project name this SCM is connected to.

Returns:

The project's name.

getViewname

public java.lang.String getViewname()

Get the view name in the project this SCM uses.

Returns:

The name of the view.

getFoldername

public java.lang.String getFoldername()

Get the root folder name of our monitored workspace.

Returns:

The name of the folder.

getUsername

public java.lang.String getUsername()

Get the username used to connect to starteam.

Returns:

The username.

getPassword

public java.lang.String getPassword()

Get the password used to connect to starteam.

Returns:

The password.