public class JdbcReference extends GenericReference
Modifier and Type | Field and Description |
---|---|
FileReference |
credFileReference |
Constructor and Description |
---|
JdbcReference() |
JdbcReference(java.lang.Integer driverId,
java.lang.String jdbcUrl,
FileReference creds)
Construct a reference to the JDBC connection information
|
Modifier and Type | Method and Description |
---|---|
void |
checkValid()
Check whether the reference is syntactically valid.
|
FileReference |
getCredFileReference() |
java.lang.Integer |
getJdbcDriverId() |
java.lang.String |
getValue()
Getter
|
void |
setJdbcDriverId(java.lang.Integer driverId) |
checkOptionalReference, checkRequiredReference, setValue
public FileReference credFileReference
public JdbcReference()
public JdbcReference(java.lang.Integer driverId, java.lang.String jdbcUrl, FileReference creds)
driverId
- The ID of the extended driver uploaded via jdbcDriver
API endpoint.jdbcUrl
- The JDBC URL of the database servercreds
- A FileReference
object to a file that contains credentials in JSON
format. It should have the schema {"username": "USERNAME", "password": "PASSWORD"}@JsonPropertyDescription(value="Jdbc URL of the database server") public java.lang.String getValue()
GenericReference
getValue
in class GenericReference
@JsonPropertyDescription(value="ID of the extended jdbc driver") public java.lang.Integer getJdbcDriverId()
@JsonPropertyDescription(value="The reference to the file storing the credentials in the form username") public FileReference getCredFileReference()
public void setJdbcDriverId(java.lang.Integer driverId)
public void checkValid() throws ComponentConfigurationException
GenericReference
checkValid
in class GenericReference
ComponentConfigurationException
- When the reference is not valid.