hudson.plugins.dimensionsscm
Class DimensionsAPI

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

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

DimensionsAPI()

Method Summary

com.serena.dmclient.api.DimensionsResult	actionBaseline(long key, java.lang.String projectId, hudson.model.AbstractBuild build, java.lang.String state) Action a baseline
com.serena.dmclient.api.DimensionsResult	buildBaseline(long key, 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
com.serena.dmclient.api.DimensionsResult	buildProject(long key, 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, java.lang.String stage, java.lang.String type, boolean audit, boolean populate, boolean touch, hudson.model.AbstractBuild build) Build a project
boolean	checkout(long key, java.lang.String projectName, hudson.FilePath projectDir, hudson.FilePath workspaceName, java.lang.StringBuffer cmdOutput, java.lang.String baseline, java.lang.String requests, boolean doRevert, java.lang.String permissions)
com.serena.dmclient.api.DimensionsResult	createBaseline(long key, java.lang.String projectId, hudson.model.AbstractBuild build, java.lang.String blnScope, java.lang.String blnTemplate, java.lang.String blnOwningPart) Create a project tag
boolean	createChangeSetLogs(long key, java.lang.String projectName, hudson.FilePath projectDir, java.util.Calendar fromDate, java.util.Calendar toDate, java.io.File changelogFile, java.util.TimeZone tz, java.lang.String url, java.lang.String baseline, java.lang.String requests)
com.serena.dmclient.api.DimensionsResult	deployBaseline(long key, java.lang.String projectId, hudson.model.AbstractBuild build, java.lang.String state) Deploy a baseline
com.serena.dmclient.api.DimensionsConnection	getCon(long key)
int	getDmVersion()
java.util.List	getItemsInRequests(com.serena.dmclient.api.DimensionsConnection connection, java.lang.String projName, java.lang.String requests, java.lang.String dateAfter, java.lang.String dateBefore) Populate list with all the items related to a set of requests
java.io.PrintStream	getLogger()
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(long key, java.lang.String projectName, hudson.FilePath workspace, java.util.Calendar fromDate, java.util.Calendar toDate, java.util.TimeZone tz)
boolean	isStream(long key, java.lang.String projectId)
com.serena.dmclient.api.DimensionsResult	lockProject(long key, java.lang.String projectId) Lock a project
long	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(long key) Disconnects from the Dimensions repository
boolean	ping(long key) Ping the server to see if it is alive
void	setLogger(java.io.PrintStream logger)
com.serena.dmclient.api.DimensionsResult	unlockProject(long key, java.lang.String projectId) UnLock a project
com.serena.dmclient.api.DimensionsResult	UploadFiles(long key, hudson.FilePath rootDir, java.lang.String projectId, java.io.File cmdFile, java.lang.String projectName, int buildNo, java.lang.String requests, boolean forceCheckIn, boolean forceTip, java.lang.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 java.io.PrintStream getLogger()

setLogger

public final void setLogger(java.io.PrintStream logger)

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(long key)

ping

public final boolean ping(long key)
                   throws com.serena.dmclient.api.DimensionsRuntimeException

Ping the server to see if it is alive

Returns:

a boolean

Throws:

com.serena.dmclient.api.DimensionsNetworkException

com.serena.dmclient.api.DimensionsRuntimeException

login

public final long 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 long

Throws:

DimensionsRuntimeException, - IllegalArgumentException

java.lang.IllegalArgumentException

com.serena.dmclient.api.DimensionsRuntimeException

logout

public final void logout(long key)

Disconnects from the Dimensions repository

hasRepositoryBeenUpdated

public boolean hasRepositoryBeenUpdated(long key,
                                        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(long key,
                        java.lang.String projectName,
                        hudson.FilePath projectDir,
                        hudson.FilePath workspaceName,
                        java.lang.StringBuffer cmdOutput,
                        java.lang.String baseline,
                        java.lang.String requests,
                        boolean doRevert,
                        java.lang.String permissions)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

createChangeSetLogs

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

Throws:

java.io.IOException

java.lang.InterruptedException

lockProject

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

Lock a project

Parameters:

long -

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

unlockProject

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

UnLock a project

Parameters:

long -

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

buildBaseline

public com.serena.dmclient.api.DimensionsResult buildBaseline(long key,
                                                              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:

long -

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

buildProject

public com.serena.dmclient.api.DimensionsResult buildProject(long key,
                                                             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,
                                                             java.lang.String stage,
                                                             java.lang.String type,
                                                             boolean audit,
                                                             boolean populate,
                                                             boolean touch,
                                                             hudson.model.AbstractBuild build)
                                                      throws com.serena.dmclient.api.DimensionsRuntimeException

Build a project

Parameters:

long -

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

AbstractBuild - build

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

UploadFiles

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

Upload files

Parameters:

long -

FilePath -

String -

File -

String -

String -

int -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

createBaseline

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

Create a project tag

Parameters:

long -

String -

AbstractBuild -

String -

String -

String -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

deployBaseline

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

Deploy a baseline

Parameters:

long -

String -

String -

AbstractBuild -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

actionBaseline

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

Action a baseline

Parameters:

long -

String -

String -

AbstractBuild -

Returns:

DimensionsResult

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

isStream

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

Throws:

com.serena.dmclient.api.DimensionsRuntimeException

getItemsInRequests

public java.util.List getItemsInRequests(com.serena.dmclient.api.DimensionsConnection connection,
                                         java.lang.String projName,
                                         java.lang.String requests,
                                         java.lang.String dateAfter,
                                         java.lang.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