Package step.repository.alm.v16.otaclient

Interface ITDConnection13

All Superinterfaces:

com4j.Com4jObject, ITDConnection, ITDConnection10, ITDConnection11, ITDConnection12, ITDConnection2, ITDConnection3, ITDConnection4, ITDConnection5, ITDConnection6, ITDConnection7, ITDConnection8, ITDConnection9

public interface ITDConnection13
extends ITDConnection12

Represents a single server connection.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getApprovalId(java.lang.String startDateTime)	Obtain approval token.
java.lang.String	getAuthenticationToken(java.lang.String approvalId)	Get access token by approval token.
void	importConnectionSettings2(IConnectionSettings2 connectionSettings2)	This is a dummy interface, used to keep compatibility with ALM 14
void	initConnectionWithApiKey(java.lang.String serverName, java.lang.String apiKey, java.lang.String apiKeySecret)	Initialize connection with provided apiKey and secret
IList	initConnectionWithApiKeyEx(java.lang.String serverName, java.lang.String apiKey, java.lang.String apiKeySecret)	Initialize connection with provided apiKey and secret and get project list
void	initConnectionWithCookies(java.lang.String serverName, java.lang.String cookies)	Initialize connection with provided SSO token cookie
IList	initConnectionWithCookiesEx(java.lang.String serverName, java.lang.String cookies)	Initialize connection with provided SSO token cookie and get project list
void	setConnectionSettingsLockKey(java.lang.String connectionSettingsLockKey)	This is a dummy interface, used to keep compatibility with ALM 14

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection

actionPermission, alertManager, allowReconnect, allowReconnect, analysis, bugFactory, changeFactory, changePassword, checkoutRepository, clientType, command, commonSettings, componentFactory, componentFolderFactory, connected, connectProject, connectProjectEx, connectToVCSAs, customization, dbManager, dbName, dbType, directoryPath, disconnectProject, domainName, domainsList, domainsList, extendedStorage, fields, getLicense, getLicenses, getLicenseStatus, getTDVersion, hostFactory, hostGroupFactory, ignoreHtmlFormat, ignoreHtmlFormat, initConnection, initConnectionEx, keepConnection, keepConnection, mailConditions, moduleVisible, password, projectConnected, projectName, projectProperties, projectsList, projectsList, projectsListEx, purgeRuns, releaseConnection, reportRole, reqFactory, rules, runFactory, sendMail, serverName, serverTime, serverURL, synchronizeFollowUps, tdParams, tdSettings, testFactory, testRepository, testSetFactory, testSetTreeManager, textParam, treeManager, userGroupsList, userGroupsList, userName, userSettings, usersList, usersList, usingProgress, usingProgress, vcs, vcsDbRepository, viewsRepository, vmRepository

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection10

importConnectionSettings, setBasicAuthHeaderMode, useInstanceCache

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection11

almEnvironmentFactory, getServerSetting

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection12

getLicensesEx

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection2

auditPropertyFactory, auditRecordFactory, connect, disconnect, graphBuilder, isSearchSupported, loggedIn, login, logout, productInfo, tsTestFactory, visibleDomains, visibleDomains, visibleProjects

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection3

applicationConfigurationFactory, applicationEntityFactory, applicationEntityTreeManager, blueprintFactory, changeEntityFactory, changeEntityTreeManager, cycleFactory, extensionFactory, extensionsManager, getExtensions, getNonce, getTDParamsNames, getTDParamsNames, releaseFactory, releaseFolderFactory, serviceChangeFactory, serviceFactory, serviceFolderFactory, serviceGroupFactory, validate

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection4

analysisItemFactory, analysisItemFolderFactory, assetRelationFactory, assetRepositoryItemFactory, baselineFactory, clientVersion, comparisonFactory, comparisonNodeFactory, crossProjectAPI, dashboardFolderFactory, dashboardPageFactory, dashboardPageItemFactory, excelReportManager, getAllVisibleProjectDescriptors, getAllVisibleProjectDescriptors, getFavoriteFactory, getFavoriteFolderFactory, getRootsFavoriteFactory, getRootsFavoriteFolderFactory, libraryFactory, libraryFolderFactory, licenseManager, policyStatus, qcResourceFactory, qcResourceFolderFactory, refreshConnectionState, rootsAnalysisItemFactory, rootsAnalysisItemFolderFactory, rootsDashboardFolderFactory, rootsDashboardPageFactory, sendFramedMail, taskFactory, taskLogFactory, templateManager, userAssetFactory

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection5

applicativeSessionCookie, attachmentFactory, authenticationToken, bpComponentFactory, bpIterationFactory, bpIterationParamFactory, bpmLinkFactory, bpModelElementFactory, bpModelFactory, bpModelFolderFactory, bpModelPathFactory, bpParamFactory, brand, brandDisplayName, componentParamFactory, componentStepFactory, connectedProjectDescriptor, contentDefinitionFactory, coverageFactory, deletedAssetInfoFactory, deniedFeatures, disconnectLocally, edition, eventLogFactory, genericOneParamCall, getCommonFavoriteFactory, getCommonFavoriteFolderFactory, getLinkedProjects, kpiDefinitionFactory, kpiFactory, kpiMilestoneScopeItemFactory, loginEx, loginMetadata, loginSessionId, loginWithAuthenticationToken, milestoneFactory, milestoneScopeItemFactory, projectSessionId, publicEntityKeyFactory, purgeRuns2, reconnect, reportManager, reportToReportProjectTemplateLinkFactory, reportUserTemplateFactory, runCriterionFactory, runIterationFactory, scopeItemFactory, serverAddress, sessionToken, stepFactory, testConfigFactory, testCriterionFactory, thresholdValueFactory

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection6

designStepFactory, setProxyCredentials, setServerCredentials

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection7

analysisItemFileFactory, analysisSegmentFactory, asyncMailEnabled, asyncMailEnabled, bpStepParamFactory, businessViewsExcelReportManager, facetFactory, ldapToken, testFolderFactory, testLabFolderFactory

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection8

getTDVersionEx, sendFramedMailEx, sendMailEx

Methods inherited from interface step.repository.alm.v16.otaclient.ITDConnection9

applyClientCert, applyCookie, createSession, createSessionEx, createSessionEx, externalAuthenticationEnabled, initAndCheckServerCompatibility, isServerCompatible, setExecutionMode

Method Detail

initConnectionWithCookies

void initConnectionWithCookies(java.lang.String serverName,
                               java.lang.String cookies)

Initialize connection with provided SSO token cookie

Parameters:

serverName - Mandatory java.lang.String parameter.

cookies - Mandatory java.lang.String parameter.

initConnectionWithCookiesEx

IList initConnectionWithCookiesEx(java.lang.String serverName,
                                  java.lang.String cookies)

Initialize connection with provided SSO token cookie and get project list

Parameters:

serverName - Mandatory java.lang.String parameter.

cookies - Mandatory java.lang.String parameter.

Returns:

Returns a value of type step.repository.alm.v16.otaclient.IList

importConnectionSettings2

void importConnectionSettings2(IConnectionSettings2 connectionSettings2)

This is a dummy interface, used to keep compatibility with ALM 14

Parameters:

connectionSettings2 - Mandatory step.repository.alm.v16.otaclient.IConnectionSettings2 parameter.

getApprovalId

java.lang.String getApprovalId(java.lang.String startDateTime)

Obtain approval token.

Parameters:

startDateTime - Optional parameter. Default value is ""

Returns:

Returns a value of type java.lang.String

getAuthenticationToken

java.lang.String getAuthenticationToken(java.lang.String approvalId)

Get access token by approval token.

Parameters:

approvalId - Mandatory java.lang.String parameter.

Returns:

Returns a value of type java.lang.String

setConnectionSettingsLockKey

void setConnectionSettingsLockKey(java.lang.String connectionSettingsLockKey)

This is a dummy interface, used to keep compatibility with ALM 14

Parameters:

connectionSettingsLockKey - Mandatory java.lang.String parameter.

initConnectionWithApiKey

void initConnectionWithApiKey(java.lang.String serverName,
                              java.lang.String apiKey,
                              java.lang.String apiKeySecret)

Initialize connection with provided apiKey and secret

Parameters:

serverName - Mandatory java.lang.String parameter.

apiKey - Mandatory java.lang.String parameter.

apiKeySecret - Mandatory java.lang.String parameter.

initConnectionWithApiKeyEx

IList initConnectionWithApiKeyEx(java.lang.String serverName,
                                 java.lang.String apiKey,
                                 java.lang.String apiKeySecret)

Initialize connection with provided apiKey and secret and get project list

Parameters:

serverName - Mandatory java.lang.String parameter.

apiKey - Mandatory java.lang.String parameter.

apiKeySecret - Mandatory java.lang.String parameter.

Returns:

Returns a value of type step.repository.alm.v16.otaclient.IList