hudson.plugins.dimensionsscm
Class DimensionsAPI

java.lang.Object
  hudson.plugins.dimensionsscm.DimensionsAPI

public class DimensionsAPI
extends java.lang.Object

Constructor Summary

DimensionsAPI()

Method Summary

com.serena.dmclient.api.DimensionsResult	actionBaseline(java.lang.String projectId, hudson.model.AbstractBuild build, java.lang.String state) Action a baseline
com.serena.dmclient.api.DimensionsResult	buildBaseline(java.lang.String area, java.lang.String projectId, boolean batch, boolean buildClean, java.lang.String buildConfig, java.lang.String options, boolean capture, java.lang.String requests, java.lang.String targets, hudson.model.AbstractBuild build) Build a baseline
boolean	checkout(java.lang.String projectName, hudson.FilePath projectDir, hudson.FilePath workspaceName, java.util.Calendar fromDate, java.util.Calendar toDate, java.io.File changelogFile, java.util.TimeZone tz, java.lang.StringBuffer cmdOutput, java.lang.String url, java.lang.String baseline, java.lang.String requests, boolean doFullUpdate, boolean doRevert)
com.serena.dmclient.api.DimensionsResult	createBaseline(java.lang.String projectId, hudson.model.AbstractBuild build) Create a project tag
com.serena.dmclient.api.DimensionsResult	deployBaseline(java.lang.String projectId, hudson.model.AbstractBuild build, java.lang.String state) Deploy a baseline
com.serena.dmclient.api.DimensionsConnection	getCon()
int	getDmVersion()
java.lang.String	getSCMBaseDb()
java.lang.String	getSCMDatabase()
java.lang.String	getSCMDsn()
java.lang.String	getSCMPath()
java.lang.String	getSCMProject()
java.lang.String	getSCMServer()
java.lang.String	getSCMUserID()
boolean	hasRepositoryBeenUpdated(java.lang.String projectName, hudson.FilePath workspace, java.util.Calendar fromDate, java.util.Calendar toDate, java.util.TimeZone tz)
com.serena.dmclient.api.DimensionsResult	lockProject(java.lang.String projectId) Lock a project
boolean	login(java.lang.String userID, java.lang.String password, java.lang.String database, java.lang.String server) Creates a Dimensions session using the supplied login credentials and server details
void	logout() Disconnects from the Dimensions repository
com.serena.dmclient.api.DimensionsResult	unlockProject(java.lang.String projectId) UnLock a project
com.serena.dmclient.api.DimensionsResult	UploadFiles(hudson.FilePath rootDir, java.lang.String projectId, java.io.File cmdFile, hudson.model.AbstractBuild build, java.lang.String requests) 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

getSCMUserID

public final java.lang.String getSCMUserID()

getDmVersion

public final int getDmVersion()

getSCMDatabase

public final java.lang.String getSCMDatabase()

getSCMBaseDb

public final java.lang.String getSCMBaseDb()

getSCMDsn

public final java.lang.String getSCMDsn()

getSCMServer

public final java.lang.String getSCMServer()

getSCMProject

public final java.lang.String getSCMProject()

getSCMPath

public final java.lang.String getSCMPath()

getCon

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

login

public final boolean login(java.lang.String userID,
                           java.lang.String password,
                           java.lang.String database,
                           java.lang.String server)
                    throws java.lang.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 boolean

Throws:

com.serena.dmclient.api.DimensionsNetworkException

java.lang.IllegalArgumentException

com.serena.dmclient.api.DimensionsRuntimeException

logout

public final void logout()

Disconnects from the Dimensions repository

hasRepositoryBeenUpdated

public boolean hasRepositoryBeenUpdated(java.lang.String projectName,
                                        hudson.FilePath workspace,
                                        java.util.Calendar fromDate,
                                        java.util.Calendar toDate,
                                        java.util.TimeZone tz)
                                 throws java.io.IOException,
                                        java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

checkout

public boolean checkout(java.lang.String projectName,
                        hudson.FilePath projectDir,
                        hudson.FilePath workspaceName,
                        java.util.Calendar fromDate,
                        java.util.Calendar toDate,
                        java.io.File changelogFile,
                        java.util.TimeZone tz,
                        java.lang.StringBuffer cmdOutput,
                        java.lang.String url,
                        java.lang.String baseline,
                        java.lang.String requests,
                        boolean doFullUpdate,
                        boolean doRevert)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

lockProject

public com.serena.dmclient.api.DimensionsResult lockProject(java.lang.String projectId)
                                                     throws com.serena.dmclient.api.DimensionsRuntimeException

Lock a project

Parameters:

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

unlockProject

public com.serena.dmclient.api.DimensionsResult unlockProject(java.lang.String projectId)
                                                       throws com.serena.dmclient.api.DimensionsRuntimeException

UnLock a project

Parameters:

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

buildBaseline

public com.serena.dmclient.api.DimensionsResult buildBaseline(java.lang.String area,
                                                              java.lang.String projectId,
                                                              boolean batch,
                                                              boolean buildClean,
                                                              java.lang.String buildConfig,
                                                              java.lang.String options,
                                                              boolean capture,
                                                              java.lang.String requests,
                                                              java.lang.String targets,
                                                              hudson.model.AbstractBuild build)
                                                       throws com.serena.dmclient.api.DimensionsRuntimeException

Build a baseline

Parameters:

String - area

String - projectId

boolean - batch

boolean - buildClean

String - buildConfig

String - options

boolean - capture

String - requests

String - targets

AbstractBuild - build

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

UploadFiles

public com.serena.dmclient.api.DimensionsResult UploadFiles(hudson.FilePath rootDir,
                                                            java.lang.String projectId,
                                                            java.io.File cmdFile,
                                                            hudson.model.AbstractBuild build,
                                                            java.lang.String requests)
                                                     throws com.serena.dmclient.api.DimensionsRuntimeException

Upload files

Parameters:

FilePath -

String -

File -

AbstractBuild -

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

createBaseline

public com.serena.dmclient.api.DimensionsResult createBaseline(java.lang.String projectId,
                                                               hudson.model.AbstractBuild build)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Create a project tag

Parameters:

String -

AbstractBuild -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

deployBaseline

public com.serena.dmclient.api.DimensionsResult deployBaseline(java.lang.String projectId,
                                                               hudson.model.AbstractBuild build,
                                                               java.lang.String state)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Deploy a baseline

Parameters:

String -

String -

AbstractBuild -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

actionBaseline

public com.serena.dmclient.api.DimensionsResult actionBaseline(java.lang.String projectId,
                                                               hudson.model.AbstractBuild build,
                                                               java.lang.String state)
                                                        throws com.serena.dmclient.api.DimensionsRuntimeException

Action a baseline

Parameters:

String -

String -

AbstractBuild -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException