hudson.plugins.starteam
Class StarTeamConnection

java.lang.Object
  hudson.plugins.starteam.StarTeamConnection

All Implemented Interfaces:

java.io.Serializable

public class StarTeamConnection
extends java.lang.Object
implements java.io.Serializable

StarTeamActor is a class that implements connecting to a StarTeam repository, to a given project, view and folder. Add functionality allowing to delete non starteam file in folder while performing listing of all files. and to perform creation of changelog file during the checkout

Author:

Ilkka Laukkanen , Steve Favez

See Also:

Serialized Form

Field Summary

static java.lang.String

FILE_POINT_FILENAME

Constructor Summary

StarTeamConnection(StarTeamConnection oldConnection, StarTeamViewSelector configSelector)

StarTeamConnection(java.lang.String hostName, int port, java.lang.String userName, java.lang.String password, java.lang.String projectName, java.lang.String viewName, java.lang.String folderName, StarTeamViewSelector configSelector)
Default constructor

Method Summary

void	checkOut(StarTeamChangeSet changeSet, java.io.PrintStream logger, java.io.File buildFolder) checkout the files from starteam
void	close() Close the connection.
StarTeamChangeSet	computeChangeSet(com.starbase.starteam.Folder rootFolder, java.io.File workspace, java.util.Collection<StarTeamFilePoint> historicFilePoints, java.io.PrintStream logger)
StarTeamChangeSet	computeDifference(java.util.Collection<StarTeamFilePoint> currentFilePoint, java.util.Collection<StarTeamFilePoint> historicFilePoint, StarTeamChangeSet changeSet, java.util.Map<java.io.File,com.starbase.starteam.File> starteamFileMap)
boolean	equals(java.lang.Object object)
StarTeamChangeLogEntry	FileToStarTeamChangeLogEntry(com.starbase.starteam.File f)
StarTeamChangeLogEntry	FileToStarTeamChangeLogEntry(com.starbase.starteam.File f, java.lang.String change)
protected void	finalize()
com.starbase.starteam.Folder	getRootFolder()
com.starbase.util.OLEDate	getServerTime()
java.lang.String	getUsername(int userId) Returns the name of the user on the StarTeam server with the specified id.
int	hashCode()
void	initialize() Initialize the connection.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILE_POINT_FILENAME

public static final java.lang.String FILE_POINT_FILENAME

See Also:

Constant Field Values

Constructor Detail

StarTeamConnection

public StarTeamConnection(java.lang.String hostName,
                          int port,
                          java.lang.String userName,
                          java.lang.String password,
                          java.lang.String projectName,
                          java.lang.String viewName,
                          java.lang.String folderName,
                          StarTeamViewSelector configSelector)

Default constructor

Parameters:

hostName - the starteam server host / ip name

port - starteam server port

userName - user used to connect starteam server

password - user password to connect to starteam server

projectName - starteam project's name

viewName - starteam view's name

folderName - starteam folder's name

configSelector - configuration selector in case of checking from label, promotion state or time

StarTeamConnection

public StarTeamConnection(StarTeamConnection oldConnection,
                          StarTeamViewSelector configSelector)

Method Detail

initialize

public void initialize()
                throws StarTeamSCMException

Initialize the connection. This means logging on to the server and finding the project, view and folder we want.

Throws:

StarTeamSCMException - if logging on fails.

checkOut

public void checkOut(StarTeamChangeSet changeSet,
                     java.io.PrintStream logger,
                     java.io.File buildFolder)
              throws java.io.IOException

checkout the files from starteam

Parameters:

changeSet - a description of changes

buildFolder - A root folder for given build. it is used for storing information.

Throws:

java.io.IOException - if checkout fails.

getUsername

public java.lang.String getUsername(int userId)

Returns the name of the user on the StarTeam server with the specified id. StarTeam stores user IDs as int values and this method will translate those into the actual user name.
This can be used, for example, with a StarTeam Item's Item.getModifiedBy() property, to determine the name of the user who made a modification to the item.

Parameters:

userId - the id of the user on the StarTeam Server

Returns:

the name of the user as provided by the StarTeam Server

getRootFolder

public com.starbase.starteam.Folder getRootFolder()

getServerTime

public com.starbase.util.OLEDate getServerTime()

close

public void close()

Close the connection.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

computeChangeSet

public StarTeamChangeSet computeChangeSet(com.starbase.starteam.Folder rootFolder,
                                          java.io.File workspace,
                                          java.util.Collection<StarTeamFilePoint> historicFilePoints,
                                          java.io.PrintStream logger)
                                   throws StarTeamSCMException,
                                          java.io.IOException

Parameters:

rootFolder - main project directory

workspace - a workspace directory

historicFilePoints - a collection containing File Points to be compared (previous build)

logger - a logger for consuming log messages

Returns:

set of changes

Throws:

StarTeamSCMException

java.io.IOException

FileToStarTeamChangeLogEntry

public StarTeamChangeLogEntry FileToStarTeamChangeLogEntry(com.starbase.starteam.File f)

FileToStarTeamChangeLogEntry

public StarTeamChangeLogEntry FileToStarTeamChangeLogEntry(com.starbase.starteam.File f,
                                                           java.lang.String change)

computeDifference

public StarTeamChangeSet computeDifference(java.util.Collection<StarTeamFilePoint> currentFilePoint,
                                           java.util.Collection<StarTeamFilePoint> historicFilePoint,
                                           StarTeamChangeSet changeSet,
                                           java.util.Map<java.io.File,com.starbase.starteam.File> starteamFileMap)