Uses of Class
com.axway.ats.common.PublicAtsApi

Packages that use PublicAtsApi

Package	Description
com.axway.ats.common.dbaccess	SQL related classes
com.axway.ats.common.dbaccess.snapshot
com.axway.ats.common.dbaccess.snapshot.equality
com.axway.ats.common.filesystem	Variety of classes used when working on the file system.
com.axway.ats.common.filesystem.snapshot
com.axway.ats.common.filesystem.snapshot.equality
com.axway.ats.common.filetransfer	Classes related to file transfers like transfer modes or list of supported SSH ciphers.
com.axway.ats.common.performance.monitor	Definition of a Monitor interface which can be used to collect statistical data about some system
com.axway.ats.common.performance.monitor.beans	Package providing bean reading classes
com.axway.ats.common.process	Package providing process executor exception classes
com.axway.ats.common.registry	Package providing windows registry exception class.
com.axway.ats.common.system	Classes used when running basic system operations.
com.axway.ats.common.systemproperties
com.axway.ats.common.xml

Uses of PublicAtsApi in com.axway.ats.common.dbaccess

Classes in com.axway.ats.common.dbaccess with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	CassandraKeys Constants used when initializing connection to a Casssadra database
class	DbQuery Wrapper, containing all the data needed to build up a PreparedStatement for the specific Database Provider.
class	OracleKeys

Fields in com.axway.ats.common.dbaccess with annotations of type PublicAtsApi

Modifier and Type	Field and Description
static String	CassandraKeys.ALLOW_FILTERING For some queries with a WHERE clause it is needed to allow the filtering option
static String	DbKeys.KEY_STORE_FULL_PATH
static String	DbKeys.KEY_STORE_PASSWORD
static String	DbKeys.KEY_STORE_TYPE
static String	DbKeys.PORT_KEY The key for the port custom property
static String	OracleKeys.SERVICE_NAME_KEY
static String	OracleKeys.SID_KEY
static String	DbKeys.USE_ADMIN_CREDENTIALS Use this property with value 'true' to use the admin credentials

Constructors in com.axway.ats.common.dbaccess with annotations of type PublicAtsApi

Constructor and Description
DbQuery(String q) Constructor
DbQuery(String q, List<Object> args) Constructor
DbQuery(String q, Object[] args) Constructor

Uses of PublicAtsApi in com.axway.ats.common.dbaccess.snapshot

Classes in com.axway.ats.common.dbaccess.snapshot with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	DatabaseSnapshotException Error while working with Database Snapshot
interface	IndexNameMatcher User can implement this interface in order to tell whether some table index names should be treated as same or not.

Methods in com.axway.ats.common.dbaccess.snapshot with annotations of type PublicAtsApi

Modifier and Type	Method and Description
DatabaseEqualityState	DatabaseSnapshotException.getEqualityState() This can be used to retrieve the compare result and then make some custom compare report.
String	DatabaseSnapshotException.getMessage()
boolean	IndexNameMatcher.isSame(String table, String firstName, String secondName) Whether some table index names should be treated as same or not

Uses of PublicAtsApi in com.axway.ats.common.dbaccess.snapshot.equality

Classes in com.axway.ats.common.dbaccess.snapshot.equality with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	DatabaseEqualityState This structure says how equal the snapshots are

Methods in com.axway.ats.common.dbaccess.snapshot.equality with annotations of type PublicAtsApi

Modifier and Type	Method and Description
List<Map<String,String>>	DatabaseEqualityState.getColumnsPresentInOneSnapshotOnly(String snapshot, String table) Get a list of unique columns for the given table and snapshot.
List<String>	DatabaseEqualityState.getColumnsPresentInOneSnapshotOnlyAsStrings(String snapshot, String table) Get a list of unique columns for the given table and snapshot.
Integer	DatabaseEqualityState.getDifferentNumberOfRows(String snapshot, String table) Get the number of rows for the given table and snapshot.
String	DatabaseEqualityState.getDifferentPrimaryKeys(String snapshot, String table) Get the different primary keys per table and snapshot.
String	DatabaseEqualityState.getFirstSnapshotName()
List<Map<String,String>>	DatabaseEqualityState.getIndexesPresentInOneSnapshotOnly(String snapshot, String table) Get a list of unique indexes for the given table and snapshot.
List<String>	DatabaseEqualityState.getIndexesPresentInOneSnapshotOnlyAsStrings(String snapshot, String table) Get a list of unique indexes for the given table and snapshot.
List<Map<String,String>>	DatabaseEqualityState.getRowsPresentInOneSnapshotOnly(String snapshot, String table) Get a list of unique rows for the given table and snapshot.
List<String>	DatabaseEqualityState.getRowsPresentInOneSnapshotOnlyAsStrings(String snapshot, String table) Get a list of unique rows for the given table and snapshot.
String	DatabaseEqualityState.getSecondSnapshotName()
List<String>	DatabaseEqualityState.getTablesPresentInOneSnapshotOnly(String snapshot)
List<String>	DatabaseEqualityState.getTablesWithColumnsPresentInOneSnapshotOnly(String snapshot) Get list of tables with unique columns
List<String>	DatabaseEqualityState.getTablesWithDifferentNumberOfRows(String snapshot) Get list of tables with different number of rows Note that the list of tables is the same for both snapshots
List<String>	DatabaseEqualityState.getTablesWithDifferentPrimaryKeys(String snapshot) Get list of tables with different primary keys Note that the list of tables is the same for both snapshots
List<String>	DatabaseEqualityState.getTablesWithIndexesPresentInOneSnapshotOnly(String snapshot) Get list of tables with unique indexes
List<String>	DatabaseEqualityState.getTablesWithRowsPresentInOneSnapshotOnly(String snapshot) Get list of tables with unique rows
boolean	DatabaseEqualityState.hasDifferences()

Uses of PublicAtsApi in com.axway.ats.common.filesystem

Classes in com.axway.ats.common.filesystem with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	EndOfLineStyle Enumeration for end of line style.
class	FileMatchInfo Contains a basic information for a text match in file.
class	FileSystemOperationException Exception while executing some file system operations
class	Md5SumMode Enumeration for MD5 sum mode

Fields in com.axway.ats.common.filesystem with annotations of type PublicAtsApi

Modifier and Type	Field and Description
long	FileMatchInfo.lastReadByte the sequence of the last read byte
int	FileMatchInfo.lastReadLineNumber the index of the last read line
Integer[]	FileMatchInfo.lineNumbers indexes of the matched lines from the file beginning
String[]	FileMatchInfo.lines matched lines
boolean	FileMatchInfo.matched if there were any matches
String[]	FileMatchInfo.matchedPatterns matched patterns
int	FileMatchInfo.numberOfMatchedLines number of matched lines

Uses of PublicAtsApi in com.axway.ats.common.filesystem.snapshot

Classes in com.axway.ats.common.filesystem.snapshot with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	FileSystemSnapshotException Error while working with File System Snapshot

Methods in com.axway.ats.common.filesystem.snapshot with annotations of type PublicAtsApi

Modifier and Type	Method and Description
FileSystemEqualityState	FileSystemSnapshotException.getEqualityState() This can be used to retrieve the compare result and then make some custom compare report.
String	FileSystemSnapshotException.getMessage()

Uses of PublicAtsApi in com.axway.ats.common.filesystem.snapshot.equality

Classes in com.axway.ats.common.filesystem.snapshot.equality with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	DifferenceType Type of found difference
class	FileSystemEqualityState This structure can say how equal the snapshots are
class	FileTrace We keep here the differences found between two files or directories

Methods in com.axway.ats.common.filesystem.snapshot.equality with annotations of type PublicAtsApi

Modifier and Type	Method and Description
String	DifferenceType.getDescription(String firstSnapshot, String secondSnapshot)
List<FileTrace>	FileSystemEqualityState.getDifferences()
DifferenceType	FileTrace.getDifferenceType()
String	FileTrace.getFirstEntityPath()
String	FileTrace.getFirstSnapshot()
Map<String,String>	FileTrace.getFirstSnapshotDifferencies() Get what is present in the first snapshot only
String	FileSystemEqualityState.getFirstSnapshotName()
String	FileTrace.getSecondEntityPath()
String	FileTrace.getSecondSnapshot()
Map<String,String>	FileTrace.getSecondSnapshotDifferencies() Get what is present in the second snapshot only
String	FileSystemEqualityState.getSecondSnapshotName()
boolean	FileTrace.hasDifferencies()
String	FileTrace.toString()

Uses of PublicAtsApi in com.axway.ats.common.filetransfer

Classes in com.axway.ats.common.filetransfer with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	FileTransferException Exception while transferring a file over any transfer protocol
class	SshCipher This class describes an SSH Cipher.
class	TransferMode Defines the available transfer modes that could be set for each protocol
class	TransferProtocol Contains all the transfer protocol types

Fields in com.axway.ats.common.filetransfer with annotations of type PublicAtsApi

Modifier and Type	Field and Description
static SshCipher	SshCipher._3DES_CBC
static SshCipher	SshCipher.AES128_CBC
static SshCipher	SshCipher.AES128_CTR
static SshCipher	SshCipher.AES192_CBC
static SshCipher	SshCipher.AES192_CTR
static SshCipher	SshCipher.AES256_CBC
static SshCipher	SshCipher.AES256_CTR
static SshCipher	SshCipher.ARCFOUR128
static SshCipher	SshCipher.ARCFOUR256
static SshCipher	SshCipher.BLOWFISH_CBC

Methods in com.axway.ats.common.filetransfer with annotations of type PublicAtsApi

Modifier and Type	Method and Description
int	SshCipher.getBlockLength()
String	SshCipher.getJceAlgorithmName()
int	SshCipher.getKeyLength()
String	SshCipher.getProvider()
String	SshCipher.getSshAlgorithmName()
void	SshCipher.setBlockLength(int blockLength)
void	SshCipher.setJceAlgorithmName(String jceAlgorithmName)
void	SshCipher.setKeyLength(int keyLength)
void	SshCipher.setProvider(String provider)
void	SshCipher.setSshAlgorithmName(String sshAlgorithmName)

Constructors in com.axway.ats.common.filetransfer with annotations of type PublicAtsApi

Constructor and Description
SshCipher(String sshAlgorithmName, String jceAlgorithmName, int blockLength, int keyLength)
SshCipher(String sshAlgorithmName, String jceAlgorithmName, String provider, int blockLength, int keyLength)

Uses of PublicAtsApi in com.axway.ats.common.performance.monitor

Classes in com.axway.ats.common.performance.monitor with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	PerformanceMonitor A Monitor that can be used by the ATS Performance Monitor Service to collect statistical data about a tested system

Methods in com.axway.ats.common.performance.monitor with annotations of type PublicAtsApi

Modifier and Type	Method and Description
abstract void	PerformanceMonitor.deinit() Called to do some clean up procedures, for example to release some resources allocated in the init() method
abstract String	PerformanceMonitor.getDescription()
abstract void	PerformanceMonitor.init(ReadingBean[] readings) Called before start polling the monitor for statistical data.
abstract List<ReadingBean>	PerformanceMonitor.pollNewData() Called repetitively in intervals specified by the user.
abstract List<ReadingBean>	PerformanceMonitor.pollNewDataForFirstTime() Called only once, then the pollNewData method is called repetitively in intervals specified by the user.

Uses of PublicAtsApi in com.axway.ats.common.performance.monitor.beans

Classes in com.axway.ats.common.performance.monitor.beans with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	ReadingBean A full reading info.

Methods in com.axway.ats.common.performance.monitor.beans with annotations of type PublicAtsApi

Modifier and Type	Method and Description
String	ReadingBean.getMonitorName()
String	ReadingBean.getName()
String	ReadingBean.getUnit()
String	ReadingBean.getValue()
void	ReadingBean.setName(String name)
void	ReadingBean.setValue(String value)

Constructors in com.axway.ats.common.performance.monitor.beans with annotations of type PublicAtsApi

Constructor and Description
ReadingBean()
ReadingBean(String monitorClass, String name, String unit)

Uses of PublicAtsApi in com.axway.ats.common.process

Classes in com.axway.ats.common.process with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	ProcessExecutorException
class	ProcessTalkException

Uses of PublicAtsApi in com.axway.ats.common.registry

Classes in com.axway.ats.common.registry with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	RegistryOperationsException Exception while working with the Windows registry

Uses of PublicAtsApi in com.axway.ats.common.system

Classes in com.axway.ats.common.system with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	OperatingSystemType Enumeration representing the operating system type
class	SystemOperationException

Methods in com.axway.ats.common.system with annotations of type PublicAtsApi

Modifier and Type	Method and Description
static OperatingSystemType	OperatingSystemType.getCurrentOsType() Get the operating system on which the current JVM runs
static OperatingSystemType	OperatingSystemType.getOsType(String osName) Extract the operating system type from the name
boolean	OperatingSystemType.isUnix() Check if this OperatingSystemType instance is a Unix-type system
boolean	OperatingSystemType.isWindows() Check if this OperatingSystemType instance is a Windows system

Uses of PublicAtsApi in com.axway.ats.common.systemproperties

Classes in com.axway.ats.common.systemproperties with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	AtsSystemProperties This class is used as a central place for working with ATS related system properties.

Fields in com.axway.ats.common.systemproperties with annotations of type PublicAtsApi

Modifier and Type	Field and Description
static String	AtsSystemProperties.AGENT__COMPONENTS_FOLDER
static String	AtsSystemProperties.AGENT__MONITOR_INITIAL_POLL_DELAY
static String	AtsSystemProperties.AGENT__TEMPLATE_ACTIONS_PROXY_PROPERTY
static String	AtsSystemProperties.AGENT_HOME_FOLDER
static String	AtsSystemProperties.CORE__JSCH_VERBOSE_MODE
static int	AtsSystemProperties.DEFAULT_AGENT_PORT_VALUE
static String	AtsSystemProperties.LOG__CLASSPATH_ON_START
static String	AtsSystemProperties.LOG__MONITOR_EVENTS_QUEUE
static String	AtsSystemProperties.TEST_HARNESS__JUNIT_RUN_NAME
static String	AtsSystemProperties.TEST_HARNESS__TESTS_SOURCE_LOCATION
static String	AtsSystemProperties.UI_ENGINE__SWING_ROBOT_DELAY_BETWEEN_EVENTS

Methods in com.axway.ats.common.systemproperties with annotations of type PublicAtsApi

Modifier and Type	Method and Description
static Integer	AtsSystemProperties.getAgentDefaultPort()
static Boolean	AtsSystemProperties.getPropertyAsBoolean(String key) If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - an error is thrown If key is not found - null is returned.
static Boolean	AtsSystemProperties.getPropertyAsBoolean(String key, Boolean defaultValue) If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
static Integer	AtsSystemProperties.getPropertyAsNonNegativeNumber(String key) If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - an error is thrown If key is not found - null is returned.
static Integer	AtsSystemProperties.getPropertyAsNonNegativeNumber(String key, Integer defaultValue) If key is found and is parsed OK - the wanted value is returned. If key is found and fail parsing - default value is returned if provided, otherwise an error is thrown If key is not found - default value is returned if provided, otherwise null is returned.
static Integer	AtsSystemProperties.getPropertyAsNumber(String key) Return a system property as an integer number.
static Integer	AtsSystemProperties.getPropertyAsNumber(String key, Integer defaultValue) Return a system property as an integer number
static String	AtsSystemProperties.getPropertyAsString(String key) Return a system property as a String.
static String	AtsSystemProperties.getPropertyAsString(String key, String defaultValue) Return a system property as a String if existing.
static void	AtsSystemProperties.setAgentDefaultPort(int defaultAgentPort)

Uses of PublicAtsApi in com.axway.ats.common.xml

Classes in com.axway.ats.common.xml with annotations of type PublicAtsApi

Modifier and Type	Class and Description
class	XMLException Exception while working with @XMLText

Constructors in com.axway.ats.common.xml with annotations of type PublicAtsApi

Constructor and Description
XMLException()
XMLException(String message)
XMLException(String message, Throwable cause)
XMLException(Throwable cause)