hudson.plugins.dimensionsscm

Class DimensionsAPI

java.lang.Object

hudson.plugins.dimensionsscm.DimensionsAPI

All Implemented Interfaces:

Serializable

public class DimensionsAPI
extends Object
implements Serializable

Dimensions API facade. The Jenkins Dimensions Plugin provides support for Dimensions CM SCM repositories.

Author:

Tim Payne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DimensionsAPI()

Method Summary

Methods

Modifier and Type	Method and Description
com.serena.dmclient.api.DimensionsResult	actionBaseline(long key, String projectId, hudson.model.Run build, String state, String blnName) Action a baseline.
com.serena.dmclient.api.DimensionsResult	buildBaseline(long key, String area, String projectId, boolean batch, boolean buildClean, String buildConfig, String options, boolean capture, String requests, String targets, hudson.model.Run build, String blnName) Build a baseline.
com.serena.dmclient.api.DimensionsResult	buildProject(long key, String area, String projectId, boolean batch, boolean buildClean, String buildConfig, String options, boolean capture, String requests, String targets, String stage, String type, boolean audit, boolean populate, boolean touch, hudson.model.Run build) Build a project.
boolean	checkout(long key, String projectName, hudson.FilePath projectDir, hudson.FilePath workspaceName, StringBuffer cmdOutput, String baseline, String requests, boolean doRevert, boolean doExpand, boolean doNoMetadata, boolean doNoTouch, String permissions, String eol) Get a copy of the code.
com.serena.dmclient.api.DimensionsResult	createBaseline(long key, String projectVersion, hudson.model.Run build, String blnScope, String blnTemplate, String blnOwningPart, String blnType, String requestId, String blnId, String blnName, StringBuffer cblId) Create a project tag.
boolean	createChangeSetLogs(long key, String projectName, hudson.FilePath projectDir, Calendar fromDate, Calendar toDate, File changelogFile, TimeZone tz, String url, String baseline, String requests) Generate changelog file.
com.serena.dmclient.api.DimensionsResult	deployBaseline(long key, String projectId, hudson.model.Run build, String state, String blnName) Deploy a baseline.
com.serena.dmclient.api.DimensionsConnection	getCon(long key) Gets the repository connection class
int	getDmVersion() Gets the Dimensions version if set.
List	getItemsInRequests(com.serena.dmclient.api.DimensionsConnection connection, String projName, String requests, String dateAfter, String dateBefore) Populate list with all the items related to a set of requests.
PrintStream	getLogger() Gets the logger.
String	getSCMBaseDb() Gets the base database for the connection.
String	getSCMDatabase() Gets the base database for the connection (as "NAME@CONNECTION").
String	getSCMDsn() Gets the database DNS for the connection.
String	getSCMPath() Gets the project path.
String	getSCMProject() Gets the project ID for the connection.
String	getSCMServer() Gets the server for the connection.
String	getSCMUserID() Gets the user ID for the connection.
boolean	hasRepositoryBeenUpdated(long key, String projectName, hudson.FilePath workspace, Calendar fromDate, Calendar toDate, TimeZone tz) Has the repository had any changes made during a certain time?
boolean	isStream(long key, String projectId)
com.serena.dmclient.api.DimensionsResult	lockProject(long key, String projectId) Lock a project.
long	login(String userID, String password, String database, String server) Creates a Dimensions session using the supplied login credentials and server details.
long	login(String userID, String password, String database, String server, hudson.model.Run build) Creates a Dimensions session using the supplied login credentials and server details.
void	logout(long key) Disconnects from the Dimensions repository
void	logout(long key, hudson.model.Run build) Disconnects from the Dimensions repository, with additional tracing from supplied build details.
void	setLogger(PrintStream logger) Set the logger.
com.serena.dmclient.api.DimensionsResult	unlockProject(long key, String projectId) Unlock a project.
com.serena.dmclient.api.DimensionsResult	UploadFiles(long key, hudson.FilePath rootDir, String projectId, File cmdFile, String projectName, int buildNo, String requests, boolean forceCheckIn, boolean forceTip, String owningPart) Upload files.

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionsAPI

public DimensionsAPI()

Method Detail

getLogger

public final PrintStream getLogger()

Gets the logger.

Returns:

the task logger

setLogger

public final void setLogger(PrintStream logger)

Set the logger.

getSCMUserID

public final String getSCMUserID()

Gets the user ID for the connection.

Returns:

the user ID of the user as whom to connect

getDmVersion

public final int getDmVersion()

Gets the Dimensions version if set.

Returns:

version

getSCMDatabase

public final String getSCMDatabase()

Gets the base database for the connection (as "NAME@CONNECTION").

Returns:

the name of the base database to connect to

getSCMBaseDb

public final String getSCMBaseDb()

Gets the base database for the connection.

Returns:

the name of the base database only

getSCMDsn

public final String getSCMDsn()

Gets the database DNS for the connection.

Returns:

the name of the DSN only

getSCMServer

public final String getSCMServer()

Gets the server for the connection.

Returns:

the name of the server to connect to

getSCMProject

public final String getSCMProject()

Gets the project ID for the connection.

Returns:

the project ID

getSCMPath

public final String getSCMPath()

Gets the project path.

Returns:

the project path

getCon

public final com.serena.dmclient.api.DimensionsConnection getCon(long key)

Gets the repository connection class

Returns:

the SCM repository connection

login

public final long login(String userID,
         String password,
         String database,
         String server)
                 throws IllegalArgumentException,
                        com.serena.dmclient.api.DimensionsRuntimeException

Creates a Dimensions session using the supplied login credentials and server details.

Parameters:

userID - Dimensions user ID

password - Dimensions password

database - Base database name

server - Hostname of the remote Dimensions server

Returns:

A long key for the connection

Throws:

DimensionsRuntimeException, - IllegalArgumentException

IllegalArgumentException

com.serena.dmclient.api.DimensionsRuntimeException

login

public final long login(String userID,
         String password,
         String database,
         String server,
         hudson.model.Run build)
                 throws IllegalArgumentException,
                        com.serena.dmclient.api.DimensionsRuntimeException

Creates a Dimensions session using the supplied login credentials and server details. With additional tracing from supplied build details.

Parameters:

userID - Dimensions user ID

password - Dimensions password

database - base database name

server - hostname of the remote Dimensions server

build - details of the invoking build run

Returns:

a long

Throws:

DimensionsRuntimeException, - IllegalArgumentException

IllegalArgumentException

com.serena.dmclient.api.DimensionsRuntimeException

logout

public final void logout(long key)

Disconnects from the Dimensions repository

logout

public final void logout(long key,
          hudson.model.Run build)

Disconnects from the Dimensions repository, with additional tracing from supplied build details.

hasRepositoryBeenUpdated

public boolean hasRepositoryBeenUpdated(long key,
                               String projectName,
                               hudson.FilePath workspace,
                               Calendar fromDate,
                               Calendar toDate,
                               TimeZone tz)
                                 throws IOException,
                                        InterruptedException

Has the repository had any changes made during a certain time?

Throws:

IOException

InterruptedException

checkout

public boolean checkout(long key,
               String projectName,
               hudson.FilePath projectDir,
               hudson.FilePath workspaceName,
               StringBuffer cmdOutput,
               String baseline,
               String requests,
               boolean doRevert,
               boolean doExpand,
               boolean doNoMetadata,
               boolean doNoTouch,
               String permissions,
               String eol)
                 throws IOException,
                        InterruptedException

Get a copy of the code.

Throws:

IOException

InterruptedException

createChangeSetLogs

public boolean createChangeSetLogs(long key,
                          String projectName,
                          hudson.FilePath projectDir,
                          Calendar fromDate,
                          Calendar toDate,
                          File changelogFile,
                          TimeZone tz,
                          String url,
                          String baseline,
                          String requests)
                            throws IOException,
                                   InterruptedException

Generate changelog file.

Throws:

IOException

InterruptedException

lockProject

public com.serena.dmclient.api.DimensionsResult lockProject(long key,
                                                   String projectId)
                                                     throws com.serena.dmclient.api.DimensionsRuntimeException

Lock a project.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

unlockProject

public com.serena.dmclient.api.DimensionsResult unlockProject(long key,
                                                     String projectId)
                                                       throws com.serena.dmclient.api.DimensionsRuntimeException

Unlock a project.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

buildBaseline

public com.serena.dmclient.api.DimensionsResult buildBaseline(long key,
                                                     String area,
                                                     String projectId,
                                                     boolean batch,
                                                     boolean buildClean,
                                                     String buildConfig,
                                                     String options,
                                                     boolean capture,
                                                     String requests,
                                                     String targets,
                                                     hudson.model.Run build,
                                                     String blnName)
                                                       throws com.serena.dmclient.api.DimensionsRuntimeException

Build a baseline.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

buildProject

public com.serena.dmclient.api.DimensionsResult buildProject(long key,
                                                    String area,
                                                    String projectId,
                                                    boolean batch,
                                                    boolean buildClean,
                                                    String buildConfig,
                                                    String options,
                                                    boolean capture,
                                                    String requests,
                                                    String targets,
                                                    String stage,
                                                    String type,
                                                    boolean audit,
                                                    boolean populate,
                                                    boolean touch,
                                                    hudson.model.Run build)
                                                      throws com.serena.dmclient.api.DimensionsRuntimeException

Build a project.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

UploadFiles

public com.serena.dmclient.api.DimensionsResult UploadFiles(long key,
                                                   hudson.FilePath rootDir,
                                                   String projectId,
                                                   File cmdFile,
                                                   String projectName,
                                                   int buildNo,
                                                   String requests,
                                                   boolean forceCheckIn,
                                                   boolean forceTip,
                                                   String owningPart)
                                                     throws com.serena.dmclient.api.DimensionsRuntimeException

Upload files.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

createBaseline

public com.serena.dmclient.api.DimensionsResult createBaseline(long key,
                                                      String projectVersion,
                                                      hudson.model.Run build,
                                                      String blnScope,
                                                      String blnTemplate,
                                                      String blnOwningPart,
                                                      String blnType,
                                                      String requestId,
                                                      String blnId,
                                                      String blnName,
                                                      StringBuffer cblId)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Create a project tag.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

deployBaseline

public com.serena.dmclient.api.DimensionsResult deployBaseline(long key,
                                                      String projectId,
                                                      hudson.model.Run build,
                                                      String state,
                                                      String blnName)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Deploy a baseline.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

actionBaseline

public com.serena.dmclient.api.DimensionsResult actionBaseline(long key,
                                                      String projectId,
                                                      hudson.model.Run build,
                                                      String state,
                                                      String blnName)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Action a baseline.

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

isStream

public boolean isStream(long key,
               String projectId)
                 throws com.serena.dmclient.api.DimensionsRuntimeException

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

getItemsInRequests

public List getItemsInRequests(com.serena.dmclient.api.DimensionsConnection connection,
                      String projName,
                      String requests,
                      String dateAfter,
                      String dateBefore)
                        throws com.serena.dmclient.api.DimensionsRuntimeException

Populate list with all the items related to a set of requests.

Parameters:

connection - Dimensions connection

projectName - Name of the project

requests - List of requests

dateAfter - Date filter

dateBefore - Date filter

Returns:

List

Throws:

com.serena.dmclient.api.DimensionsRuntimeException