org.jboss.dna.connector.store.jpa
Class JpaSource

java.lang.Object
  org.jboss.dna.connector.store.jpa.JpaSource

All Implemented Interfaces:

Serializable, Referenceable, ObjectFactory, RepositorySource

public class JpaSource
extends Object
implements RepositorySource, ObjectFactory

The RepositorySource for the connector that stores content in a (custom) relational database. This connector uses Java Persistence API as the interface to the database, with Hibernate as the JPA implementation. (Note that some Hibernate-specific features are used.)

Author:

Randall Hauch

See Also:

Serialized Form

Nested Class Summary

static class

JpaSource.Models This source is capable of using different database schemas

Field Summary

static String	DEFAULT_NAME_OF_DEFAULT_WORKSPACE The initial name of the default workspace is ""default" ", unless otherwise specified.
static String	DEFAULT_ROOT_NODE_UUID The default UUID that is used for root nodes in a store.
static boolean	DEFAULT_SUPPORTS_CREATING_WORKSPACES This source does support creating workspaces.
static boolean	DEFAULT_SUPPORTS_UPDATES This source supports udpates by default, but each instance may be configured to be read-only or updateable.

Constructor Summary

JpaSource()

Method Summary

void	close() Close any resources held by this source.
int	getCacheTimeToLiveInMilliseconds() Get the time in milliseconds that content returned from this source may used while in the cache.
RepositorySourceCapabilities	getCapabilities() Get the capabilities for this source.
RepositoryConnection	getConnection() Get a connection from this source.
String	getDataSourceJndiName()
String	getDialect()
String	getDriverClassloaderName()
String	getDriverClassName()
int	getIdleTimeInSecondsBeforeTestingConnections()
long	getLargeValueSizeInBytes()
int	getMaximumConnectionIdleTimeInSeconds()
int	getMaximumConnectionsInPool()
int	getMaximumSizeOfStatementCache()
int	getMinimumConnectionsInPool()
String	getModel() Get the model that will be used.
String	getName() Get the name for this repository source.
String	getNameOfDefaultWorkspace() Get the name of the default workspace.
int	getNumberOfConnectionsToAcquireAsNeeded()
Object	getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment)
String	getPassword()
String[]	getPredefinedWorkspaceNames() Gets the names of the workspaces that are available when this source is created.
Reference	getReference()
int	getRetryLimit() Get the maximum number of retries that may be performed on a given operation when using connections created by this source.
String	getRootNodeUuid()
boolean	getSupportsUpdates() Get whether this source supports updates.
String	getUrl()
String	getUsername()
void	initialize(RepositoryContext context) Initialize this source to use the supplied RepositoryContext, from which this source can obtain connections to other sources as well as execution contexts.
boolean	isCompressData()
boolean	isCreatingWorkspacesAllowed() Get whether this source allows workspaces to be created dynamically.
boolean	isReferentialIntegrityEnforced()
void	setCacheTimeToLiveInMilliseconds(int cacheTimeToLive) Set the time in milliseconds that content returned from this source may used while in the cache.
void	setCompressData(boolean compressData)
void	setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation) Set whether this source allows workspaces to be created dynamically.
void	setDataSourceJndiName(String dataSourceJndiName)
void	setDialect(String dialect)
void	setDriverClassloaderName(String driverClassloaderName)
void	setDriverClassName(String driverClassName)
void	setIdleTimeInSecondsBeforeTestingConnections(int idleTimeInSecondsBeforeTestingConnections)
void	setLargeValueSizeInBytes(long largeValueSizeInBytes)
void	setMaximumConnectionIdleTimeInSeconds(int maximumConnectionIdleTimeInSeconds)
void	setMaximumConnectionsInPool(int maximumConnectionsInPool)
void	setMaximumSizeOfStatementCache(int maximumSizeOfStatementCache)
void	setMinimumConnectionsInPool(int minimumConnectionsInPool)
void	setModel(String modelName) Set the model that should be used for this store.
void	setName(String name) Set the name for the source
void	setNameOfDefaultWorkspace(String nameOfDefaultWorkspace) Set the name of the workspace that should be used when clients don't specify a workspace.
void	setNumberOfConnectionsToAcquireAsNeeded(int numberOfConnectionsToAcquireAsNeeded)
void	setPassword(String password)
void	setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames) Sets the names of the workspaces that are available when this source is created.
void	setReferentialIntegrityEnforced(boolean referentialIntegrityEnforced)
void	setRetryLimit(int limit) Set the maximum number of retries that may be performed on a given operation when using connections created by this source.
void	setRootNodeUuid(String rootNodeUuid)
void	setSupportsUpdates(boolean supportsUpdates) Set whether this source supports updates.
void	setUrl(String url)
void	setUsername(String username)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUPPORTS_UPDATES

public static final boolean DEFAULT_SUPPORTS_UPDATES

This source supports udpates by default, but each instance may be configured to be read-only or updateable.

See Also:

Constant Field Values

DEFAULT_SUPPORTS_CREATING_WORKSPACES

public static final boolean DEFAULT_SUPPORTS_CREATING_WORKSPACES

This source does support creating workspaces.

See Also:

Constant Field Values

DEFAULT_ROOT_NODE_UUID

public static final String DEFAULT_ROOT_NODE_UUID

The default UUID that is used for root nodes in a store.

See Also:

Constant Field Values

DEFAULT_NAME_OF_DEFAULT_WORKSPACE

public static final String DEFAULT_NAME_OF_DEFAULT_WORKSPACE

The initial name of the default workspace is ""default" ", unless otherwise specified.

See Also:

Constant Field Values

Constructor Detail

JpaSource

public JpaSource()

Method Detail

getName

public String getName()

Get the name for this repository source.

Specified by:

getName in interface RepositorySource

Returns:

the name; never null or empty

See Also:

RepositorySource.getName()

setName

public void setName(String name)

Set the name for the source

Parameters:

name - the new name for the source

getCapabilities

public RepositorySourceCapabilities getCapabilities()

Get the capabilities for this source.

Specified by:

getCapabilities in interface RepositorySource

Returns:

the capabilities for this source; never null

See Also:

RepositorySource.getCapabilities()

getSupportsUpdates

public boolean getSupportsUpdates()

Get whether this source supports updates.

Returns:

true if this source supports updates, or false if this source only supports reading content.

setSupportsUpdates

public void setSupportsUpdates(boolean supportsUpdates)

Set whether this source supports updates.

Parameters:

supportsUpdates - true if this source supports updating content, or false if this source only supports reading content.

getRetryLimit

public int getRetryLimit()

Get the maximum number of retries that may be performed on a given operation when using connections created by this source. This value does not constitute a minimum number of retries; in fact, the connection user is not required to retry any operations.

Specified by:

getRetryLimit in interface RepositorySource

Returns:

the maximum number of allowable retries, or 0 if the source has no limit

See Also:

RepositorySource.getRetryLimit()

setRetryLimit

public void setRetryLimit(int limit)

Set the maximum number of retries that may be performed on a given operation when using connections created by this source. This value does not constitute a minimum number of retries; in fact, the connection user is not required to retry any operations.

Specified by:

setRetryLimit in interface RepositorySource

Parameters:

limit - the maximum number of allowable retries, or 0 if the source has no limit

See Also:

RepositorySource.setRetryLimit(int)

getCacheTimeToLiveInMilliseconds

public int getCacheTimeToLiveInMilliseconds()

Get the time in milliseconds that content returned from this source may used while in the cache.

Returns:

the time to live, in milliseconds, or 0 if the time to live is not specified by this source

setCacheTimeToLiveInMilliseconds

public void setCacheTimeToLiveInMilliseconds(int cacheTimeToLive)

Set the time in milliseconds that content returned from this source may used while in the cache.

Parameters:

cacheTimeToLive - the time to live, in milliseconds; 0 if the time to live is not specified by this source; or a negative number for the default value

getRootNodeUuid

public String getRootNodeUuid()

Returns:

rootNodeUuid

setRootNodeUuid

public void setRootNodeUuid(String rootNodeUuid)

Parameters:

rootNodeUuid - Sets rootNodeUuid to the specified value.

Throws:

IllegalArgumentException - if the string value cannot be converted to UUID

getNameOfDefaultWorkspace

public String getNameOfDefaultWorkspace()

Get the name of the default workspace.

Returns:

the name of the workspace that should be used by default, or null if there is no default workspace

setNameOfDefaultWorkspace

public void setNameOfDefaultWorkspace(String nameOfDefaultWorkspace)

Set the name of the workspace that should be used when clients don't specify a workspace.

Parameters:

nameOfDefaultWorkspace - the name of the workspace that should be used by default, or null if the default name should be used

getPredefinedWorkspaceNames

public String[] getPredefinedWorkspaceNames()

Gets the names of the workspaces that are available when this source is created.

Returns:

the names of the workspaces that this source starts with, or null if there are no such workspaces

See Also:

setPredefinedWorkspaceNames(String[]), setCreatingWorkspacesAllowed(boolean)

setPredefinedWorkspaceNames

public void setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)

Sets the names of the workspaces that are available when this source is created.

Parameters:

predefinedWorkspaceNames - the names of the workspaces that this source should start with, or null if there are no such workspaces

See Also:

setCreatingWorkspacesAllowed(boolean), getPredefinedWorkspaceNames()

isCreatingWorkspacesAllowed

public boolean isCreatingWorkspacesAllowed()

Get whether this source allows workspaces to be created dynamically.

Returns:

true if this source allows workspaces to be created by clients, or false if the set of workspaces is fixed

See Also:

setPredefinedWorkspaceNames(String[]), getPredefinedWorkspaceNames(), setCreatingWorkspacesAllowed(boolean)

setCreatingWorkspacesAllowed

public void setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)

Set whether this source allows workspaces to be created dynamically.

Parameters:

allowWorkspaceCreation - true if this source allows workspaces to be created by clients, or false if the set of workspaces is fixed

See Also:

setPredefinedWorkspaceNames(String[]), getPredefinedWorkspaceNames(), isCreatingWorkspacesAllowed()

getDialect

public String getDialect()

Returns:

dialect

setDialect

public void setDialect(String dialect)

Parameters:

dialect - Sets dialect to the specified value.

getDataSourceJndiName

public String getDataSourceJndiName()

Returns:

dataSourceJndiName

setDataSourceJndiName

public void setDataSourceJndiName(String dataSourceJndiName)

Parameters:

dataSourceJndiName - Sets dataSourceJndiName to the specified value.

getDriverClassName

public String getDriverClassName()

Returns:

driverClassName

setDriverClassName

public void setDriverClassName(String driverClassName)

Parameters:

driverClassName - Sets driverClassName to the specified value.

getDriverClassloaderName

public String getDriverClassloaderName()

Returns:

driverClassloaderName

setDriverClassloaderName

public void setDriverClassloaderName(String driverClassloaderName)

Parameters:

driverClassloaderName - Sets driverClassloaderName to the specified value.

getUsername

public String getUsername()

Returns:

username

setUsername

public void setUsername(String username)

Parameters:

username - Sets username to the specified value.

getPassword

public String getPassword()

Returns:

password

setPassword

public void setPassword(String password)

Parameters:

password - Sets password to the specified value.

getUrl

public String getUrl()

Returns:

url

setUrl

public void setUrl(String url)

Parameters:

url - Sets url to the specified value.

getMaximumConnectionsInPool

public int getMaximumConnectionsInPool()

Returns:

maximumConnectionsInPool

setMaximumConnectionsInPool

public void setMaximumConnectionsInPool(int maximumConnectionsInPool)

Parameters:

maximumConnectionsInPool - Sets maximumConnectionsInPool to the specified value.

getMinimumConnectionsInPool

public int getMinimumConnectionsInPool()

Returns:

minimumConnectionsInPool

setMinimumConnectionsInPool

public void setMinimumConnectionsInPool(int minimumConnectionsInPool)

Parameters:

minimumConnectionsInPool - Sets minimumConnectionsInPool to the specified value.

getMaximumConnectionIdleTimeInSeconds

public int getMaximumConnectionIdleTimeInSeconds()

Returns:

maximumConnectionIdleTimeInSeconds

setMaximumConnectionIdleTimeInSeconds

public void setMaximumConnectionIdleTimeInSeconds(int maximumConnectionIdleTimeInSeconds)

Parameters:

maximumConnectionIdleTimeInSeconds - Sets maximumConnectionIdleTimeInSeconds to the specified value.

getMaximumSizeOfStatementCache

public int getMaximumSizeOfStatementCache()

Returns:

maximumSizeOfStatementCache

setMaximumSizeOfStatementCache

public void setMaximumSizeOfStatementCache(int maximumSizeOfStatementCache)

Parameters:

maximumSizeOfStatementCache - Sets maximumSizeOfStatementCache to the specified value.

getNumberOfConnectionsToAcquireAsNeeded

public int getNumberOfConnectionsToAcquireAsNeeded()

Returns:

numberOfConnectionsToAcquireAsNeeded

setNumberOfConnectionsToAcquireAsNeeded

public void setNumberOfConnectionsToAcquireAsNeeded(int numberOfConnectionsToAcquireAsNeeded)

Parameters:

numberOfConnectionsToAcquireAsNeeded - Sets numberOfConnectionsToAcquireAsNeeded to the specified value.

getIdleTimeInSecondsBeforeTestingConnections

public int getIdleTimeInSecondsBeforeTestingConnections()

Returns:

idleTimeInSecondsBeforeTestingConnections

setIdleTimeInSecondsBeforeTestingConnections

public void setIdleTimeInSecondsBeforeTestingConnections(int idleTimeInSecondsBeforeTestingConnections)

Parameters:

idleTimeInSecondsBeforeTestingConnections - Sets idleTimeInSecondsBeforeTestingConnections to the specified value.

getModel

public String getModel()

Get the model that will be used. This may be null if not yet connected, but after connections will reflect the type of model that is being used in the store.

Returns:

the name of the model

setModel

public void setModel(String modelName)

Set the model that should be used for this store. If the store already has a model, specifying a different value has no effect, since the store's model will not be changed. After connection, this value will reflect the actual store value.

Parameters:

modelName - the name of the model that should be used for new stores, or null if the default should be used

getLargeValueSizeInBytes

public long getLargeValueSizeInBytes()

Returns:

largeValueSizeInBytes

setLargeValueSizeInBytes

public void setLargeValueSizeInBytes(long largeValueSizeInBytes)

Parameters:

largeValueSizeInBytes - Sets largeValueSizeInBytes to the specified value.

isCompressData

public boolean isCompressData()

Returns:

compressData

setCompressData

public void setCompressData(boolean compressData)

Parameters:

compressData - Sets compressData to the specified value.

isReferentialIntegrityEnforced

public boolean isReferentialIntegrityEnforced()

Returns:

referentialIntegrityEnforced

setReferentialIntegrityEnforced

public void setReferentialIntegrityEnforced(boolean referentialIntegrityEnforced)

Parameters:

referentialIntegrityEnforced - Sets referentialIntegrityEnforced to the specified value.

initialize

public void initialize(RepositoryContext context)
                throws RepositorySourceException

Initialize this source to use the supplied RepositoryContext, from which this source can obtain connections to other sources as well as execution contexts.

Specified by:

initialize in interface RepositorySource

Throws:

RepositorySourceException

See Also:

RepositorySource.initialize(org.jboss.dna.graph.connector.RepositoryContext)

getReference

public Reference getReference()

Specified by:

getReference in interface Referenceable

See Also:

Referenceable.getReference()

getObjectInstance

public Object getObjectInstance(Object obj,
                                Name name,
                                Context nameCtx,
                                Hashtable<?,?> environment)
                         throws Exception

Specified by:

getObjectInstance in interface ObjectFactory

Throws:

Exception

getConnection

public RepositoryConnection getConnection()
                                   throws RepositorySourceException

Get a connection from this source.

Specified by:

getConnection in interface RepositorySource

Returns:

a connection

Throws:

RepositorySourceException - if there is a problem obtaining a connection

See Also:

RepositorySource.getConnection()

close

public void close()

Close any resources held by this source. This will ensure that all connections are closed.