JdbcProfile (Asakusa Framework 0.10.4 API)

java.lang.Object
- com.asakusafw.windgate.jdbc.JdbcProfile

```
public class JdbcProfile
extends Object
```
A structured profile for JdbcResourceMirror.

Since:

0.2.2, 0.9.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BATCH_GET_UNIT` The default value of `KEY_BATCH_GET_UNIT`.
`static long`	`DEFAULT_BATCH_PUT_UNIT` The default value of `KEY_BATCH_PUT_UNIT`.
`static int`	`DEFAULT_CONNECT_RETRY_COUNT` The default value of `KEY_CONNECT_RETRY_COUNT`.
`static int`	`DEFAULT_CONNECT_RETRY_INTERVAL` The default value of `KEY_CONNECT_RETRY_INTERVAL`.
`static String`	`DEFAULT_TRUNCATE_STATEMENT` The default value of `KEY_TRUNCATE_STATEMENT`.
`static String`	`KEY_BATCH_GET_UNIT` The profile key of `getBatchGetUnit()`.
`static String`	`KEY_BATCH_PUT_UNIT` The profile key of `getBatchPutUnit()`.
`static String`	`KEY_CONNECT_RETRY_COUNT` The profile key of `getConnectRetryCount()`.
`static String`	`KEY_CONNECT_RETRY_INTERVAL` The profile key of `getConnectRetryInterval()`.
`static String`	`KEY_DRIVER` The profile key of fully qualified JDBC driver class name.
`static String`	`KEY_OPTIMIZATIONS` The profile key of `getOptimizations()`.
`static String`	`KEY_PASSWORD` The profile key of database connection password.
`static String`	`KEY_PREFIX_PROPERTIES` The profile key of `getConnectionProperties()`.
`static String`	`KEY_TRUNCATE_STATEMENT` The profile key of `getTruncateStatement(String)`.
`static String`	`KEY_URL` The profile key of database URL.
`static String`	`KEY_USER` The profile key of database user name.

Constructor Summary

Constructors
Constructor and Description
`JdbcProfile(String resourceName, ClassLoader classLoader, String driver, String url, String user, String password, long batchPutUnit)` Creates a new instance.
`JdbcProfile(String resourceName, ClassLoader classLoader, String driver, String url, String user, String password, Map<String,String> connectionProperties)` Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JdbcProfile`	`convert(ResourceProfile profile)` Converts `ResourceProfile` into `JdbcProfile`.
`int`	`getBatchGetUnit()` Return the number of rows on each fetch (`fetch-size`).
`long`	`getBatchPutUnit()` Return the number of rows on each batch insertion.
`ClassLoader`	`getClassLoader()` Returns the class loader for the resources.
`Map<String,String>`	`getConnectionProperties()` Return extra configuration properties.
`int`	`getConnectRetryCount()` Returns the retry count on create connection.
`int`	`getConnectRetryInterval()` Returns the retry interval (in second).
`Set<String>`	`getOptimizations()` Returns the optimizations.
`String`	`getResourceName()` Returns the resource name.
`String`	`getTruncateStatement(String tableName)` Returns the truncate statement.
`Connection`	`openConnection()` Creates a new connection using this configuration.
`void`	`setBatchGetUnit(int value)` Configures `KEY_BATCH_GET_UNIT`.
`void`	`setBatchPutUnit(long value)` Configures `KEY_BATCH_PUT_UNIT`.
`void`	`setConnectRetryCount(int value)` Configures `KEY_CONNECT_RETRY_COUNT`.
`void`	`setConnectRetryInterval(int value)` Configures `KEY_CONNECT_RETRY_INTERVAL`.
`void`	`setOptimizations(Collection<String> optimizations)` Sets the enabled optimization symbols.
`void`	`setTruncateStatement(String pattern)` Configures `KEY_TRUNCATE_STATEMENT`.

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

- Field Detail
  - KEY_DRIVER
```
public static final String KEY_DRIVER
```
    The profile key of fully qualified JDBC driver class name.
    
    See Also:
    
    Constant Field Values
  - KEY_URL
```
public static final String KEY_URL
```
    The profile key of database URL.
    
    See Also:
    
    Constant Field Values
  - KEY_USER
```
public static final String KEY_USER
```
    The profile key of database user name.
    
    See Also:
    
    Constant Field Values
  - KEY_PASSWORD
```
public static final String KEY_PASSWORD
```
    The profile key of database connection password.
    
    See Also:
    
    Constant Field Values
  - KEY_BATCH_PUT_UNIT
```
public static final String KEY_BATCH_PUT_UNIT
```
    The profile key of getBatchPutUnit().
    
    See Also:
    
    Constant Field Values
  - KEY_BATCH_GET_UNIT
```
public static final String KEY_BATCH_GET_UNIT
```
    The profile key of getBatchGetUnit().
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - KEY_CONNECT_RETRY_COUNT
```
public static final String KEY_CONNECT_RETRY_COUNT
```
    The profile key of getConnectRetryCount().
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - KEY_CONNECT_RETRY_INTERVAL
```
public static final String KEY_CONNECT_RETRY_INTERVAL
```
    The profile key of getConnectRetryInterval().
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - KEY_TRUNCATE_STATEMENT
```
public static final String KEY_TRUNCATE_STATEMENT
```
    The profile key of getTruncateStatement(String).
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - KEY_PREFIX_PROPERTIES
```
public static final String KEY_PREFIX_PROPERTIES
```
    The profile key of getConnectionProperties().
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - KEY_OPTIMIZATIONS
```
public static final String KEY_OPTIMIZATIONS
```
    The profile key of getOptimizations().
    
    Since:
    
    0.9.0
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BATCH_GET_UNIT
```
public static final int DEFAULT_BATCH_GET_UNIT
```
    The default value of KEY_BATCH_GET_UNIT.
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BATCH_PUT_UNIT
```
public static final long DEFAULT_BATCH_PUT_UNIT
```
    The default value of KEY_BATCH_PUT_UNIT.
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_RETRY_COUNT
```
public static final int DEFAULT_CONNECT_RETRY_COUNT
```
    The default value of KEY_CONNECT_RETRY_COUNT.
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_RETRY_INTERVAL
```
public static final int DEFAULT_CONNECT_RETRY_INTERVAL
```
    The default value of KEY_CONNECT_RETRY_INTERVAL.
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRUNCATE_STATEMENT
```
public static final String DEFAULT_TRUNCATE_STATEMENT
```
    The default value of KEY_TRUNCATE_STATEMENT.
    
    Since:
    
    0.2.4
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JdbcProfile
```
public JdbcProfile(String resourceName,
                   ClassLoader classLoader,
                   String driver,
                   String url,
                   String user,
                   String password,
                   long batchPutUnit)
```
    Creates a new instance.
    
    Parameters:
    
    resourceName - the target resource name
    
    classLoader - a class loader, or null to use the system class loader
    
    driver - a fully qualified class name of JDBC Driver implementation
    
    url - database URL
    
    user - database connection user (nullable)
    
    password - database connection password (nullable)
    
    batchPutUnit - the number of rows on each batch insertion
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
  - JdbcProfile
```
public JdbcProfile(String resourceName,
                   ClassLoader classLoader,
                   String driver,
                   String url,
                   String user,
                   String password,
                   Map<String,String> connectionProperties)
```
    Creates a new instance.
    
    Parameters:
    
    resourceName - the target resource name
    
    classLoader - a class loader, or null to use the system class loader
    
    driver - a fully qualified class name of JDBC Driver implementation
    
    url - database URL
    
    user - database connection user (nullable)
    
    password - database connection password (nullable)
    
    connectionProperties - extra connection properties
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    Since:
    
    0.2.4
- Method Detail
  - convert
```
public static JdbcProfile convert(ResourceProfile profile)
```
    Converts ResourceProfile into JdbcProfile.
    
    Parameters:
    
    profile - target profile
    
    Returns:
    
    the converted profile
    
    Throws:
    
    IllegalArgumentException - if profile is not valid, or any parameter is null
  - getResourceName
```
public String getResourceName()
```
    Returns the resource name.
    
    Returns:
    
    the resource name
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Returns the class loader for the resources.
    
    Returns:
    
    the class loader
  - openConnection
```
public Connection openConnection()
                          throws IOException
```
    Creates a new connection using this configuration.
    
    Returns:
    
    the created connection
    
    Throws:
    
    IOException - if failed to create a new connection
  - getConnectionProperties
```
public Map<String,String> getConnectionProperties()
```
    Return extra configuration properties. If there is no extra configuration, this returns empty map.
    
    Returns:
    
    extra configuration properties
    
    Since:
    
    0.2.4
  - getBatchGetUnit
```
public int getBatchGetUnit()
```
    Return the number of rows on each fetch (fetch-size).
    
    Returns:
    
    the number of rows on each fetch
    
    Since:
    
    0.2.4
  - setBatchGetUnit
```
public void setBatchGetUnit(int value)
```
    Configures KEY_BATCH_GET_UNIT.
    
    Parameters:
    
    value - to set
    
    Throws:
    
    IllegalArgumentException - if < 0
  - getBatchPutUnit
```
public long getBatchPutUnit()
```
    Return the number of rows on each batch insertion.
    
    Returns:
    
    the number of rows on each batch insertion
  - setBatchPutUnit
```
public void setBatchPutUnit(long value)
```
    Configures KEY_BATCH_PUT_UNIT.
    
    Parameters:
    
    value - to set
    
    Throws:
    
    IllegalArgumentException - if <= 0
  - getConnectRetryCount
```
public int getConnectRetryCount()
```
    Returns the retry count on create connection.
    
    Returns:
    
    the retry count, or 0 for no retry
    
    Since:
    
    0.2.4
  - setConnectRetryCount
```
public void setConnectRetryCount(int value)
```
    Configures KEY_CONNECT_RETRY_COUNT.
    
    Parameters:
    
    value - to set
    
    Throws:
    
    IllegalArgumentException - if < 0
  - getConnectRetryInterval
```
public int getConnectRetryInterval()
```
    Returns the retry interval (in second).
    
    Returns:
    
    the connectionRetryInterval
    
    Since:
    
    0.2.4
    
    See Also:
    
    getConnectRetryCount()
  - setConnectRetryInterval
```
public void setConnectRetryInterval(int value)
```
    Configures KEY_CONNECT_RETRY_INTERVAL.
    
    Parameters:
    
    value - to set
    
    Throws:
    
    IllegalArgumentException - if < 0
  - getTruncateStatement
```
public String getTruncateStatement(String tableName)
```
    Returns the truncate statement.
    
    Parameters:
    
    tableName - target table name
    
    Returns:
    
    the truncate statement
    
    Since:
    
    0.2.4
  - setTruncateStatement
```
public void setTruncateStatement(String pattern)
```
    Configures KEY_TRUNCATE_STATEMENT.
    
    Parameters:
    
    pattern - to set
    
    Throws:
    
    IllegalArgumentException - if the pattern is not in form of message format
    
    Since:
    
    0.2.4
  - getOptimizations
```
public Set<String> getOptimizations()
```
    Returns the optimizations.
    
    Returns:
    
    the optimizations
    
    Since:
    
    0.9.0
    
    See Also:
    
    JdbcProcess.OptionSymbols
  - setOptimizations
```
public void setOptimizations(Collection<String> optimizations)
```
    Sets the enabled optimization symbols.
    
    Parameters:
    
    optimizations - the symbols
    
    Since:
    
    0.9.0
    
    See Also:
    
    JdbcProcess.OptionSymbols

Class JdbcProfile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_DRIVER

KEY_URL

KEY_USER

KEY_PASSWORD

KEY_BATCH_PUT_UNIT

KEY_BATCH_GET_UNIT

KEY_CONNECT_RETRY_COUNT

KEY_CONNECT_RETRY_INTERVAL

KEY_TRUNCATE_STATEMENT

KEY_PREFIX_PROPERTIES

KEY_OPTIMIZATIONS

DEFAULT_BATCH_GET_UNIT

DEFAULT_BATCH_PUT_UNIT

DEFAULT_CONNECT_RETRY_COUNT

DEFAULT_CONNECT_RETRY_INTERVAL

DEFAULT_TRUNCATE_STATEMENT

Constructor Detail

JdbcProfile

JdbcProfile

Method Detail

convert

getResourceName

getClassLoader

openConnection

getConnectionProperties

getBatchGetUnit

setBatchGetUnit

getBatchPutUnit

setBatchPutUnit

getConnectRetryCount

setConnectRetryCount

getConnectRetryInterval

setConnectRetryInterval

getTruncateStatement

setTruncateStatement

getOptimizations

setOptimizations