hudson.scm
Class IntegrityCMMember

java.lang.Object
  hudson.scm.IntegrityCMMember

public final class IntegrityCMMember
extends Object

This class is intended to represent an Integrity CM Member However, due to scalability constraints, the bulk of the member metadata will be stored in an embedded database. The purpose of this class is to statically assist with various Integrity member operations, like co.

Constructor Summary

IntegrityCMMember()

Method Summary

static boolean	checkout(APISession api, String configPath, String memberID, String memberRev, File targetFile, boolean restoreTimestamp, String lineTerminator) Performs a checkout of this Integrity Source File to a working file location on the build server represented by targetFile
static String	getAnnotatedLink(String configPath, String memberID, String memberRev) Returns an URL encoded string representation for invoking this Integrity member's annotated view
static String	getAuthor(APISession api, String configPath, String memberID, String memberRev) Performs a revision info on this Integrity Source File
static String	getDifferencesLink(String configPath, String memberID, String memberRev, String oldMemberRev) Returns an URL encoded string representation for invoking this Integrity member's differences view This assumes that IntegrityCMProject.compareBaseline() was invoked!
static String	getMD5Checksum(File targetFile) Returns the MD5 checksum hash for a file
static String	getName(String memberID) Returns only the file name portion for this full server-side member path

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrityCMMember

public IntegrityCMMember()

Method Detail

getName

public static final String getName(String memberID)

Returns only the file name portion for this full server-side member path

Parameters:

memberID - The full server side path for the Integrity member

Returns:

getAnnotatedLink

public static final String getAnnotatedLink(String configPath,
                                            String memberID,
                                            String memberRev)
                                     throws UnsupportedEncodingException

Returns an URL encoded string representation for invoking this Integrity member's annotated view

Parameters:

configPath - Full server side path for this Integrity member's project/subproject

memberID - Full server side path for this Integrity member

memberRev - Member revision string for this Integrity member

Returns:

Throws:

UnsupportedEncodingException

getDifferencesLink

public static final String getDifferencesLink(String configPath,
                                              String memberID,
                                              String memberRev,
                                              String oldMemberRev)
                                       throws UnsupportedEncodingException

Returns an URL encoded string representation for invoking this Integrity member's differences view This assumes that IntegrityCMProject.compareBaseline() was invoked!

Parameters:

configPath - Full server side path for this Integrity member's project/subproject

memberID - Full server side path for this Integrity member

memberRev - Member revision string for this Integrity member

oldMemberRev - Revision string representing the previous or next revision

Returns:

Throws:

UnsupportedEncodingException

checkout

public static final boolean checkout(APISession api,
                                     String configPath,
                                     String memberID,
                                     String memberRev,
                                     File targetFile,
                                     boolean restoreTimestamp,
                                     String lineTerminator)
                              throws com.mks.api.response.APIException

Performs a checkout of this Integrity Source File to a working file location on the build server represented by targetFile

Parameters:

api - Integrity API Session

configPath - Full server side path for this Integrity member's project/subproject

memberID - Full server side path for this Integrity member

memberRev - Member revision string for this Integrity member

targetFile - File object representing the target location for this file

restoreTimestamp - Toggles whether or not the original timestamp should be used

lineTerminator - Sets the line terminator for this file (native, crlf, or lf)

Returns:

true if the operation succeeded or false if failed

Throws:

com.mks.api.response.APIException

getAuthor

public static String getAuthor(APISession api,
                               String configPath,
                               String memberID,
                               String memberRev)

Performs a revision info on this Integrity Source File

Parameters:

api - Integrity API Session

configPath - Full project configuration path

memberID - Member ID for this file

memberRev - Member Revision for this file

Returns:

User responsible for making this change

getMD5Checksum

public static final String getMD5Checksum(File targetFile)
                                   throws IOException

Returns the MD5 checksum hash for a file

Parameters:

targetFile - File object representing the target file

Returns:

Throws:

IOException