|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.dna.connector.store.jpa.JpaSource
public class JpaSource
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.)
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 |
---|
public static final boolean DEFAULT_SUPPORTS_UPDATES
be
read-only or updateable
.
public static final boolean DEFAULT_SUPPORTS_CREATING_WORKSPACES
public static final String DEFAULT_ROOT_NODE_UUID
public static final String DEFAULT_NAME_OF_DEFAULT_WORKSPACE
name of the default workspace
is ""default" ", unless otherwise specified.
Constructor Detail |
---|
public JpaSource()
Method Detail |
---|
public String getName()
getName
in interface RepositorySource
RepositorySource.getName()
public void setName(String name)
name
- the new name for the sourcepublic RepositorySourceCapabilities getCapabilities()
getCapabilities
in interface RepositorySource
RepositorySource.getCapabilities()
public boolean getSupportsUpdates()
public void setSupportsUpdates(boolean supportsUpdates)
supportsUpdates
- true if this source supports updating content, or false if this source only supports reading
content.public int getRetryLimit()
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.
getRetryLimit
in interface RepositorySource
RepositorySource.getRetryLimit()
public void setRetryLimit(int limit)
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.
setRetryLimit
in interface RepositorySource
limit
- the maximum number of allowable retries, or 0 if the source has no limitRepositorySource.setRetryLimit(int)
public int getCacheTimeToLiveInMilliseconds()
public void setCacheTimeToLiveInMilliseconds(int cacheTimeToLive)
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 valuepublic String getRootNodeUuid()
public void setRootNodeUuid(String rootNodeUuid)
rootNodeUuid
- Sets rootNodeUuid to the specified value.
IllegalArgumentException
- if the string value cannot be converted to UUIDpublic String getNameOfDefaultWorkspace()
public void setNameOfDefaultWorkspace(String nameOfDefaultWorkspace)
nameOfDefaultWorkspace
- the name of the workspace that should be used by default, or null if the
default name
should be usedpublic String[] getPredefinedWorkspaceNames()
setPredefinedWorkspaceNames(String[])
,
setCreatingWorkspacesAllowed(boolean)
public void setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)
predefinedWorkspaceNames
- the names of the workspaces that this source should start with, or null if there are no
such workspacessetCreatingWorkspacesAllowed(boolean)
,
getPredefinedWorkspaceNames()
public boolean isCreatingWorkspacesAllowed()
set of workspaces
is fixedsetPredefinedWorkspaceNames(String[])
,
getPredefinedWorkspaceNames()
,
setCreatingWorkspacesAllowed(boolean)
public void setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)
allowWorkspaceCreation
- true if this source allows workspaces to be created by clients, or false if the
set of workspaces
is fixedsetPredefinedWorkspaceNames(String[])
,
getPredefinedWorkspaceNames()
,
isCreatingWorkspacesAllowed()
public String getDialect()
public void setDialect(String dialect)
dialect
- Sets dialect to the specified value.public String getDataSourceJndiName()
public void setDataSourceJndiName(String dataSourceJndiName)
dataSourceJndiName
- Sets dataSourceJndiName to the specified value.public String getDriverClassName()
public void setDriverClassName(String driverClassName)
driverClassName
- Sets driverClassName to the specified value.public String getDriverClassloaderName()
public void setDriverClassloaderName(String driverClassloaderName)
driverClassloaderName
- Sets driverClassloaderName to the specified value.public String getUsername()
public void setUsername(String username)
username
- Sets username to the specified value.public String getPassword()
public void setPassword(String password)
password
- Sets password to the specified value.public String getUrl()
public void setUrl(String url)
url
- Sets url to the specified value.public int getMaximumConnectionsInPool()
public void setMaximumConnectionsInPool(int maximumConnectionsInPool)
maximumConnectionsInPool
- Sets maximumConnectionsInPool to the specified value.public int getMinimumConnectionsInPool()
public void setMinimumConnectionsInPool(int minimumConnectionsInPool)
minimumConnectionsInPool
- Sets minimumConnectionsInPool to the specified value.public int getMaximumConnectionIdleTimeInSeconds()
public void setMaximumConnectionIdleTimeInSeconds(int maximumConnectionIdleTimeInSeconds)
maximumConnectionIdleTimeInSeconds
- Sets maximumConnectionIdleTimeInSeconds to the specified value.public int getMaximumSizeOfStatementCache()
public void setMaximumSizeOfStatementCache(int maximumSizeOfStatementCache)
maximumSizeOfStatementCache
- Sets maximumSizeOfStatementCache to the specified value.public int getNumberOfConnectionsToAcquireAsNeeded()
public void setNumberOfConnectionsToAcquireAsNeeded(int numberOfConnectionsToAcquireAsNeeded)
numberOfConnectionsToAcquireAsNeeded
- Sets numberOfConnectionsToAcquireAsNeeded to the specified value.public int getIdleTimeInSecondsBeforeTestingConnections()
public void setIdleTimeInSecondsBeforeTestingConnections(int idleTimeInSecondsBeforeTestingConnections)
idleTimeInSecondsBeforeTestingConnections
- Sets idleTimeInSecondsBeforeTestingConnections to the specified value.public String getModel()
public void setModel(String modelName)
modelName
- the name of the model that should be used for new stores, or null if the default should be usedpublic long getLargeValueSizeInBytes()
public void setLargeValueSizeInBytes(long largeValueSizeInBytes)
largeValueSizeInBytes
- Sets largeValueSizeInBytes to the specified value.public boolean isCompressData()
public void setCompressData(boolean compressData)
compressData
- Sets compressData to the specified value.public boolean isReferentialIntegrityEnforced()
public void setReferentialIntegrityEnforced(boolean referentialIntegrityEnforced)
referentialIntegrityEnforced
- Sets referentialIntegrityEnforced to the specified value.public void initialize(RepositoryContext context) throws RepositorySourceException
RepositoryContext
, from which this source can obtain
connections
to other sources
as well as
execution contexts
.
initialize
in interface RepositorySource
RepositorySourceException
RepositorySource.initialize(org.jboss.dna.graph.connector.RepositoryContext)
public Reference getReference()
getReference
in interface Referenceable
Referenceable.getReference()
public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment) throws Exception
getObjectInstance
in interface ObjectFactory
Exception
public RepositoryConnection getConnection() throws RepositorySourceException
getConnection
in interface RepositorySource
RepositorySourceException
- if there is a problem obtaining a connectionRepositorySource.getConnection()
public void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |