hudson.plugins.accurev

Class AccurevSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.accurev.AccurevSCM

All Implemented Interfaces:

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

public class AccurevSCM
extends hudson.scm.SCM

Accurev SCM plugin for Jenkins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccurevSCM.AccurevSCMDescriptor
static class	AccurevSCM.AccurevServer

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<String>	DEFAULT_VALID_STREAM_TRANSACTION_TYPES
protected static List<String>	DEFAULT_VALID_WORKSPACE_TRANSACTION_TYPES
static ReentrantLock	MASTER_LOCK The accurev server has been known to crash if more than one copy of the accurev has been run concurrently on the local machine.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
AccurevSCM(String serverName, String depot, String stream) Deprecated.
AccurevSCM(String serverName, String serverUUID, String depot, String stream) Deprecated.
AccurevSCM(String serverName, String serverUUID, String depot, String stream, String wspaceORreftree)

Method Summary

Modifier and Type	Method and Description
void	buildEnvironment(hudson.model.Run<?,?> build, Map<String,String> env) Exposes AccuRev-specific information to the environment.
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	checkout(hudson.model.Run<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, File changelogFile, hudson.scm.SCMRevisionState baseline)
hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.Job<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline)
static AccurevSCM.AccurevSCMDescriptor	configuration()
hudson.scm.ChangeLogParser	createChangeLogParser()
String	getAccurevTool()
String	getDepot()
AccurevSCM.AccurevSCMDescriptor	getDescriptor()
String	getDirectoryOffset()
String	getFilterForPollSCM()
ReentrantLock	getMandatoryLock(hudson.FilePath workspace) Gets the lock to be used on accurev commands where synchronization is mandatory.
ReentrantLock	getOptionalLock(hudson.FilePath workspace) Gets the lock to be used on "normal" accurev commands, or null if command synchronization is switched off.
String	getPollingStream(hudson.model.Job<?,?> project, hudson.model.TaskListener listener)
String	getReftree()
AccurevSCM.AccurevServer	getServer() Getter for Accurev server
String	getServerName()
String	getServerUUID()
String	getSnapshotNameFormat()
String	getStream()
String	getSubPath()
boolean	getSubPathOnly()
String	getWorkspace()
String	getWspaceORreftree()
boolean	hasStringVariableReference(String str)
boolean	isCleanreftree()
boolean	isDontPopContent()
boolean	isIgnoreStreamParent()
boolean	isNoWspaceNoReftree()
boolean	isSynctime()
boolean	isUseReftree()
boolean	isUseSnapshot()
boolean	isUseWorkspace()
boolean	requiresWorkspaceForPolling()
void	setAccurevTool(String accurevTool)
void	setCleanreftree(boolean cleanreftree)
void	setDirectoryOffset(String directoryOffset)
void	setDontPopContent(boolean dontPopContent)
void	setFilterForPollSCM(String filterForPollSCM)
void	setIgnoreStreamParent(boolean ignoreStreamParent)
void	setReftree(String reftree)
void	setServerName(String serverName)
void	setServerUUID(String uuid)
void	setSnapshotNameFormat(String snapshotNameFormat)
void	setSubPath(String subPath)
void	setSubPathOnly(boolean subPathOnly)
void	setSynctime(boolean synctime)
void	setUseSnapshot(boolean useSnapshot)
void	setWorkspace(String workspace)
void	setWspaceORreftree(String wspaceORreftree)

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, supportsPolling

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VALID_STREAM_TRANSACTION_TYPES

protected static final List<String> DEFAULT_VALID_STREAM_TRANSACTION_TYPES

DEFAULT_VALID_WORKSPACE_TRANSACTION_TYPES

protected static final List<String> DEFAULT_VALID_WORKSPACE_TRANSACTION_TYPES

MASTER_LOCK

public static final ReentrantLock MASTER_LOCK

The accurev server has been known to crash if more than one copy of the accurev has been run concurrently on the local machine.
Also, the accurev client has been known to complain that it's not logged in if another client on the same machine logs in again.

Constructor Detail

AccurevSCM

@Deprecated
public AccurevSCM(String serverName,
                               String depot,
                               String stream)

Deprecated.

AccurevSCM

@Deprecated
public AccurevSCM(String serverName,
                               String serverUUID,
                               String depot,
                               String stream)

Deprecated.

AccurevSCM

@DataBoundConstructor
public AccurevSCM(String serverName,
                                         String serverUUID,
                                         String depot,
                                         String stream,
                                         String wspaceORreftree)

Method Detail

configuration

public static AccurevSCM.AccurevSCMDescriptor configuration()

getDepot

public String getDepot()

getServerName

public String getServerName()

setServerName

@DataBoundSetter
public void setServerName(String serverName)

getServerUUID

public String getServerUUID()

setServerUUID

@DataBoundSetter
public void setServerUUID(String uuid)

getServer

@CheckForNull
public AccurevSCM.AccurevServer getServer()

Getter for Accurev server

Returns:

AccurevServer based on serverUUID (or serverName if serverUUID is null)

getStream

public String getStream()

getWspaceORreftree

public String getWspaceORreftree()

setWspaceORreftree

@DataBoundSetter
public void setWspaceORreftree(String wspaceORreftree)

getReftree

public String getReftree()

setReftree

@DataBoundSetter
public void setReftree(String reftree)

getWorkspace

public String getWorkspace()

setWorkspace

@DataBoundSetter
public void setWorkspace(String workspace)

getAccurevTool

@CheckForNull
public String getAccurevTool()

setAccurevTool

@DataBoundSetter
public void setAccurevTool(String accurevTool)

getSubPath

public String getSubPath()

setSubPath

@DataBoundSetter
public void setSubPath(String subPath)

getSubPathOnly

public boolean getSubPathOnly()

setSubPathOnly

@DataBoundSetter
public void setSubPathOnly(boolean subPathOnly)

getFilterForPollSCM

public String getFilterForPollSCM()

setFilterForPollSCM

@DataBoundSetter
public void setFilterForPollSCM(String filterForPollSCM)

getSnapshotNameFormat

public String getSnapshotNameFormat()

setSnapshotNameFormat

@DataBoundSetter
public void setSnapshotNameFormat(String snapshotNameFormat)

isIgnoreStreamParent

public boolean isIgnoreStreamParent()

setIgnoreStreamParent

@DataBoundSetter
public void setIgnoreStreamParent(boolean ignoreStreamParent)

isSynctime

public boolean isSynctime()

setSynctime

@DataBoundSetter
public void setSynctime(boolean synctime)

isDontPopContent

public boolean isDontPopContent()

setDontPopContent

@DataBoundSetter
public void setDontPopContent(boolean dontPopContent)

isCleanreftree

public boolean isCleanreftree()

setCleanreftree

@DataBoundSetter
public void setCleanreftree(boolean cleanreftree)

isUseSnapshot

public boolean isUseSnapshot()

setUseSnapshot

@DataBoundSetter
public void setUseSnapshot(boolean useSnapshot)

isUseReftree

public boolean isUseReftree()

isUseWorkspace

public boolean isUseWorkspace()

isNoWspaceNoReftree

public boolean isNoWspaceNoReftree()

getDirectoryOffset

public String getDirectoryOffset()

setDirectoryOffset

@DataBoundSetter
public void setDirectoryOffset(String directoryOffset)

getDescriptor

public AccurevSCM.AccurevSCMDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.scm.SCM

Returns:

SCMDescriptor

buildEnvironment

public void buildEnvironment(hudson.model.Run<?,?> build,
                             Map<String,String> env)

Exposes AccuRev-specific information to the environment. The following variables become available, if not null:

• ACCUREV_DEPOT - The depot name
• ACCUREV_STREAM - The stream name
• ACCUREV_SERVER - The server name
• ACCUREV_REFTREE - The workspace name
• ACCUREV_SUBPATH - The workspace subpath

Overrides:

buildEnvironment in class hudson.scm.SCM

Parameters:

build - build

env - enviroments

Since:

0.6.9

checkout

public void checkout(@NonNull
                     hudson.model.Run<?,?> build,
                     @NonNull
                     hudson.Launcher launcher,
                     @NonNull
                     hudson.FilePath workspace,
                     @NonNull
                     hudson.model.TaskListener listener,
                     @CheckForNull
                     File changelogFile,
                     @CheckForNull
                     hudson.scm.SCMRevisionState baseline)
              throws IOException,
                     InterruptedException

Overrides:

checkout in class hudson.scm.SCM

Parameters:

build - build

launcher - launcher

workspace - jenkins workspace

listener - listener

changelogFile - change log file

baseline - SCMRevisionState

Throws:

IOException - on failing IO

InterruptedException - on failing interrupt

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

Returns:

ChangeLogParser

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

getOptionalLock

public ReentrantLock getOptionalLock(hudson.FilePath workspace)

Gets the lock to be used on "normal" accurev commands, or null if command synchronization is switched off.

Parameters:

workspace - The workspace the command will run in

Returns:

See above.

getMandatoryLock

public ReentrantLock getMandatoryLock(hudson.FilePath workspace)

Gets the lock to be used on accurev commands where synchronization is mandatory.

Parameters:

workspace - The workspace the command will run in

Returns:

See above.

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(@NonNull
                                                          hudson.model.Run<?,?> build,
                                                          @Nullable
                                                          hudson.FilePath workspace,
                                                          @Nullable
                                                          hudson.Launcher launcher,
                                                          @NonNull
                                                          hudson.model.TaskListener listener)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

compareRemoteRevisionWith

public hudson.scm.PollingResult compareRemoteRevisionWith(@NonNull
                                                          hudson.model.Job<?,?> project,
                                                          @Nullable
                                                          hudson.Launcher launcher,
                                                          @Nullable
                                                          hudson.FilePath workspace,
                                                          @NonNull
                                                          hudson.model.TaskListener listener,
                                                          @NonNull
                                                          hudson.scm.SCMRevisionState baseline)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

hasStringVariableReference

public boolean hasStringVariableReference(String str)

getPollingStream

public String getPollingStream(hudson.model.Job<?,?> project,
                               hudson.model.TaskListener listener)
                        throws IllegalArgumentException

Parameters:

project - Running build

listener - Listener that it runs the build on

Returns:

Stream name tries to expand Variable reference to a String

Throws:

IllegalArgumentException - Thrown when Variable reference is not supported or cannot expand