Package com.inductiveautomation.ignition.common.datasource

Class SerializableDatasourceMeta

java.lang.Object

com.inductiveautomation.ignition.common.datasource.SerializableDatasourceMeta

All Implemented Interfaces:

DatasourceMeta, Serializable

public class SerializableDatasourceMeta
extends Object
implements DatasourceMeta, Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SerializableDatasourceMeta(DatasourceMeta copy)

Method Summary

Modifier and Type	Method	Description
int	getActiveConnections()	Returns the current number of connections in use
List<ActiveQuery>	getActiveQueries()	A snapshot of the currently executing queries for this datasource
String	getDescription()
DatasourceStatus	getExtendedStatus()	Returns the "best" status of this datasource or of any failover datasources.
DatasourceFailoverMode	getFailoverMode()	Returns the behavioral failover mode for this datasource
int	getMaxConnections()	Returns the maximum number of connections the underlying pool is configured to use.
String	getName()
String	getProblemDescription()	A string describing the current problem, if the status is not good
StatMetric	getStatistics()	A StatMetric that tracks the overall query throughput for this datasource
DatasourceStatus	getStatus()	Returns the Status of this datasource based on its last tested condition
String	getValidationQuery()	Returns a SQL query that will be used to validate the status of this datasource.
DatabaseVendor	getVendor()

Methods inherited from class java.lang.Object

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

Constructor Details

SerializableDatasourceMeta

public SerializableDatasourceMeta(DatasourceMeta copy)

Method Details

getName

public String getName()

Specified by:

getName in interface DatasourceMeta

Returns:

the name of this datasource

getDescription

public String getDescription()

Specified by:

getDescription in interface DatasourceMeta

Returns:

the description for this datasource

getProblemDescription

public String getProblemDescription()

Description copied from interface: DatasourceMeta

A string describing the current problem, if the status is not good

Specified by:

getProblemDescription in interface DatasourceMeta

getValidationQuery

public String getValidationQuery()

Description copied from interface: DatasourceMeta

Returns a SQL query that will be used to validate the status of this datasource. This query should always return at least 1 row.

Specified by:

getValidationQuery in interface DatasourceMeta

getActiveConnections

public int getActiveConnections()

Description copied from interface: DatasourceMeta

Returns the current number of connections in use

Specified by:

getActiveConnections in interface DatasourceMeta

getMaxConnections

public int getMaxConnections()

Description copied from interface: DatasourceMeta

Returns the maximum number of connections the underlying pool is configured to use.

Specified by:

getMaxConnections in interface DatasourceMeta

getStatus

public DatasourceStatus getStatus()

Description copied from interface: DatasourceMeta

Returns the Status of this datasource based on its last tested condition

Specified by:

getStatus in interface DatasourceMeta

getExtendedStatus

public DatasourceStatus getExtendedStatus()

Description copied from interface: DatasourceMeta

Returns the "best" status of this datasource or of any failover datasources. This is a better indicator of whether or not getConnection() will succeed

Specified by:

getExtendedStatus in interface DatasourceMeta

getFailoverMode

public DatasourceFailoverMode getFailoverMode()

Description copied from interface: DatasourceMeta

Returns the behavioral failover mode for this datasource

Specified by:

getFailoverMode in interface DatasourceMeta

getStatistics

public StatMetric getStatistics()

Description copied from interface: DatasourceMeta

A StatMetric that tracks the overall query throughput for this datasource

Specified by:

getStatistics in interface DatasourceMeta

getVendor

public DatabaseVendor getVendor()

Specified by:

getVendor in interface DatasourceMeta

Returns:

the database type that this connection's driver is connecting to

getActiveQueries

public List<ActiveQuery> getActiveQueries()

Description copied from interface: DatasourceMeta

A snapshot of the currently executing queries for this datasource

Specified by:

getActiveQueries in interface DatasourceMeta