AddDatasourceRequest (Hawkular Command Gateway JSON API 0.9.0.Final API)

java.lang.Object
- org.hawkular.bus.common.AbstractMessage
- - org.hawkular.cmdgw.api.AuthMessage
  - - org.hawkular.cmdgw.api.ResourcePathRequest
    - - org.hawkular.cmdgw.api.AddDatasourceRequest

All Implemented Interfaces:

BasicMessage, FailOnUnknownProperties, ResourcePathDestination, UiSessionOrigin

Direct Known Subclasses:

UpdateDatasourceRequest
```
@Generated(value="org.jsonschema2pojo")
public class AddDatasourceRequest
extends ResourcePathRequest
```
Adds a Datasource or a XA Datasource to an Application Server instance given by the inventory path stored in resourcePath field.

Constructor Summary

Constructors
Constructor and Description

AddDatasourceRequest()

Constructors
Constructor and Description
`AddDatasourceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConnectionUrl()` The JDBC driver connection URL.
`String`	`getDatasourceName()` The name for this datasource.
`Map<String,String>`	`getDatasourceProperties()` Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.
`String`	`getDriverClass()` The fully qualified name of the JDBC driver class.
`String`	`getDriverName()` Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration.
`String`	`getJndiName()` the JNDI name for the datasource (Required)
`String`	`getPassword()` The password used when creating a new connection.
`String`	`getSecurityDomain()` The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
`String`	`getUserName()` The user name used when creating a new connection.
`String`	`getXaDataSourceClass()` The fully qualified name of the javax.sql.XADataSource implementation.
`boolean`	`isXaDatasource()` true if an XA datasource should be added, false otherwise (Required)
`void`	`setConnectionUrl(String connectionUrl)` The JDBC driver connection URL.
`void`	`setDatasourceName(String datasourceName)` The name for this datasource.
`void`	`setDatasourceProperties(Map<String,String> datasourceProperties)` Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.
`void`	`setDriverClass(String driverClass)` The fully qualified name of the JDBC driver class.
`void`	`setDriverName(String driverName)` Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration.
`void`	`setJndiName(String jndiName)` the JNDI name for the datasource (Required)
`void`	`setPassword(String password)` The password used when creating a new connection.
`void`	`setSecurityDomain(String securityDomain)` The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
`void`	`setUserName(String userName)` The user name used when creating a new connection.
`void`	`setXaDatasource(boolean xaDatasource)` true if an XA datasource should be added, false otherwise (Required)
`void`	`setXaDataSourceClass(String xaDataSourceClass)` The fully qualified name of the javax.sql.XADataSource implementation.

Methods inherited from class org.hawkular.cmdgw.api.ResourcePathRequest
getResourcePath, getSenderRequestId, getSenderSessionId, setResourcePath, setSenderRequestId, setSenderSessionId

Methods inherited from class org.hawkular.cmdgw.api.AuthMessage
getAuthentication, setAuthentication

Methods inherited from class org.hawkular.bus.common.AbstractMessage
buildObjectMapperForDeserialization, buildObjectMapperForSerialization, fromJSON, fromJSON, getCorrelationId, getHeaders, getMessageId, setCorrelationId, setHeaders, setMessageId, toJSON, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hawkular.bus.common.BasicMessage
getCorrelationId, getHeaders, getMessageId, setCorrelationId, setHeaders, setMessageId, toJSON

- Constructor Detail
  - AddDatasourceRequest
```
public AddDatasourceRequest()
```
- Method Detail
  - isXaDatasource
```
public boolean isXaDatasource()
```
    true if an XA datasource should be added, false otherwise (Required)
    
    Returns:
    
    The xaDatasource
  - setXaDatasource
```
public void setXaDatasource(boolean xaDatasource)
```
    true if an XA datasource should be added, false otherwise (Required)
    
    Parameters:
    
    xaDatasource - The xaDatasource
  - getDatasourceName
```
public String getDatasourceName()
```
    The name for this datasource. (Required)
    
    Returns:
    
    The datasourceName
  - setDatasourceName
```
public void setDatasourceName(String datasourceName)
```
    The name for this datasource. (Required)
    
    Parameters:
    
    datasourceName - The datasourceName
  - getJndiName
```
public String getJndiName()
```
    the JNDI name for the datasource (Required)
    
    Returns:
    
    The jndiName
  - setJndiName
```
public void setJndiName(String jndiName)
```
    the JNDI name for the datasource (Required)
    
    Parameters:
    
    jndiName - The jndiName
  - getDriverName
```
public String getDriverName()
```
    Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration. (Required)
    
    Returns:
    
    The driverName
  - setDriverName
```
public void setDriverName(String driverName)
```
    Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration. (Required)
    
    Parameters:
    
    driverName - The driverName
  - getDriverClass
```
public String getDriverClass()
```
    The fully qualified name of the JDBC driver class. For non-XA Datasources either needs to be explicitly set here or in the JDBC driver referenced in driverName.
    
    Returns:
    
    The driverClass
  - setDriverClass
```
public void setDriverClass(String driverClass)
```
    The fully qualified name of the JDBC driver class. For non-XA Datasources either needs to be explicitly set here or in the JDBC driver referenced in driverName.
    
    Parameters:
    
    driverClass - The driverClass
  - getConnectionUrl
```
public String getConnectionUrl()
```
    The JDBC driver connection URL. Required for non-XA datasources.
    
    Returns:
    
    The connectionUrl
  - setConnectionUrl
```
public void setConnectionUrl(String connectionUrl)
```
    The JDBC driver connection URL. Required for non-XA datasources.
    
    Parameters:
    
    connectionUrl - The connectionUrl
  - getXaDataSourceClass
```
public String getXaDataSourceClass()
```
    The fully qualified name of the javax.sql.XADataSource implementation. For XA Datasources either needs to be explicitly set here or in the JDBC driver referenced in driverName.
    
    Returns:
    
    The xaDataSourceClass
  - setXaDataSourceClass
```
public void setXaDataSourceClass(String xaDataSourceClass)
```
    The fully qualified name of the javax.sql.XADataSource implementation. For XA Datasources either needs to be explicitly set here or in the JDBC driver referenced in driverName.
    
    Parameters:
    
    xaDataSourceClass - The xaDataSourceClass
  - getDatasourceProperties
```
public Map<String,String> getDatasourceProperties()
```
    Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.
    
    Returns:
    
    The datasourceProperties
  - setDatasourceProperties
```
public void setDatasourceProperties(Map<String,String> datasourceProperties)
```
    Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.
    
    Parameters:
    
    datasourceProperties - The datasourceProperties
  - getUserName
```
public String getUserName()
```
    The user name used when creating a new connection.
    
    Returns:
    
    The userName
  - setUserName
```
public void setUserName(String userName)
```
    The user name used when creating a new connection.
    
    Parameters:
    
    userName - The userName
  - getPassword
```
public String getPassword()
```
    The password used when creating a new connection.
    
    Returns:
    
    The password
  - setPassword
```
public void setPassword(String password)
```
    The password used when creating a new connection.
    
    Parameters:
    
    password - The password
  - getSecurityDomain
```
public String getSecurityDomain()
```
    The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
    
    Returns:
    
    The securityDomain
  - setSecurityDomain
```
public void setSecurityDomain(String securityDomain)
```
    The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
    
    Parameters:
    
    securityDomain - The securityDomain

Class AddDatasourceRequest

Constructor Summary

Method Summary

Methods inherited from class org.hawkular.cmdgw.api.ResourcePathRequest

Methods inherited from class org.hawkular.cmdgw.api.AuthMessage

Methods inherited from class org.hawkular.bus.common.AbstractMessage

Methods inherited from class java.lang.Object

Methods inherited from interface org.hawkular.bus.common.BasicMessage

Constructor Detail

AddDatasourceRequest

Method Detail

isXaDatasource

setXaDatasource

getDatasourceName

setDatasourceName

getJndiName

setJndiName

getDriverName

setDriverName

getDriverClass

setDriverClass

getConnectionUrl

setConnectionUrl

getXaDataSourceClass

setXaDataSourceClass

getDatasourceProperties

setDatasourceProperties

getUserName

setUserName

getPassword

setPassword

getSecurityDomain

setSecurityDomain