AndroMDA Spring Cartridge Namespace Components

  • cartridge
  • metafacades
  • profile

AndroMDA Spring Cartridge Namespace Properties

Hibernate
The properties for configuring Hibernate support generation. Use ${hibernate.version} to get value from pom.xml files when hibernate.version is set.
JMS
The properties for configuring JMS support generation. JMS support is only available whtn using Spring 2.x.
Other
Outlets
Defines the locations to which output is generated.
Remoting
Properties related to Spring remote services
Rich Client
Configures code generation when developing in a Rich Client environment.
Spring Security
Configures the declaritive role based security without EJB, which uses the Spring Security System.

value-objects(Back to Outlets)
Optional property
 No default value available
When using the CRUD feature (manageable entities) this outlet will be used to emit the value objects to (returned by the services to the client).
criteria(Back to Outlets)
Optional property
 No default value available
The location to which search criteria classes are being generated. If you do not specify this outlet criteria classes will be generated to the daos outlet.
services(Back to Outlets)
Required property
 No default value available
The location to which all service classes (including the service locator(s)) will be generated.
service-impls(Back to Outlets)
Required property
 No default value available
The location to which all service implementation classes will be generated.
service-interfaces(Back to Outlets)
Required property
 No default value available
The location to which all service interfaces and common API classes such as default service exceptions will be generated.
daos(Back to Outlets)
Optional property
 No default value available
The location to which Spring DAOs, and any support classes.

Please NOTE that the dao implementation classes will also be generated to this location when no operations are present on the entity with classifier scope.

dao-impls(Back to Outlets)
Optional property
 No default value available
The location to which Spring DAO implementation classes will be generated (if there are any classifier scoped business operations modeled on any entity).

Please NOTE that the dao implementation classes will be generated to the daos outlet when no operations are present on the entity with classifier scope.

spring-configuration(Back to Outlets)
Required property
 No default value available
The location to which the Spring applicationContext.xml will be generated.
open-session-in-view(Back to Outlets)
Optional property
 No default value available
The location to which the AndroMDA OpenSessionInViewFilter will be generated (allows the Hibernate open-session-in-view pattern when you want to expose your entities directly to your presentation tier - allows lazy-loading to occur that level).
session-ejbs(Back to Outlets)
Optional property
 No default value available
The outlet to which EJB support is generated. If undefined, EJB support will not be generated. Note: the EJB interfaces can be separated from beans with session-ejb-interfaces.
session-ejb-interfaces(Back to Outlets)
Optional property
 No default value available
The outlet to which EJB interfaces are generated (home and remote). If undefined, EJB interfaces will be generated into session-ejbs outlet.
advice-impls(Back to Outlets)
Optional property
 No default value available
The location to which any advice implementation classes will be generated. Currently this is useful when using the cartridge's remoting support.
client(Back to Outlets)
Optional property
 No default value available
The location where client side code is generated if using Spring remoting.
client-config(Back to Outlets)
Optional property
 No default value available
The location where client side configuration files are generated if using Spring remoting.
client-test(Back to Outlets)
Optional property
 No default value available
The location where client side test implementation code will be generated if using a Rich Client environment (i.e. the richClient namespace entry is "true").
server(Back to Outlets)
Optional property
 No default value available
The location where server side code is generated if using a Rich Client environment (i.e. the richClient namespace entry is "true").
server-impl(Back to Outlets)
Optional property
 No default value available
The location where server side implementation code will be generated if using a Rich Client environment (i.e. the richClient namespace entry is "true").
server-config(Back to Outlets)
Optional property
 No default value available
The location where server side configuration code is generated if using a Rich Client environment (i.e. the richClient namespace entry is "true").
server-test(Back to Outlets)
Optional property
 No default value available
The location where server side test implementation code will be generated if using a Rich Client environment (i.e. the richClient namespace entry is "true") or if generating unit tests.
server-test-config(Back to Outlets)
Optional property
 No default value available
The location where server side test configuration files will be generated if using a Rich Client environment (i.e. the richClient namespace entry is "true") or if generating unit tests.
merge-mappings(Back to Outlets)
Optional property
 No default value available
The location where AndroMDA merge mapping stub files should be generated.
remoting-war-support(Back to Outlets)
Optional property
 No default value available
The location where any remoting support files to be bundled in the war used to expose the remote services will be generated.
osgi(Back to Outlets)
Optional property
 No default value available
The location to which OSGi related files (e.g. the Spring applicationContext-osgi-export.xml) will be generated.
roo-directory(Back to Outlets)
Optional property
 No default value available
The location to which Spring Roo scripts will be generated. Default if unspecified = 'Roo'.
projectId(Back to Other)
Optional property
 Default value: ${project.parent.artifactId}
The artifactId of the project (i.e. timetracker), passed into the templates as a configuration value. Typically lowercase, no spaces. Must be specified if using Roo scripts. Use ${project.parent.artifactId} to get value from pom.xml files.
projectName(Back to Other)
Optional property
 Default value: ${project.parent.name}
The name of the project (i.e. TimeTracker), passed into the templates as a configuration value. Typically mixed case, may contain spaces. Use ${project.parent.name} to get value from pom.xml files.
projectGroupId(Back to Other)
Optional property
 Default value: ${project.parent.groupId}
The groupId of the project (i.e. org.andromda.timetracker), passed into the templates as a configuration value. Used by Roo scripts when creating multi-module subprojects. Must be specified if using Roo scripts. Use ${project.parent.groupId} to get value from pom.xml files.
projectVersion(Back to Other)
Optional property
 Default value: ${project.parent.version}
The version of the project (i.e. 3.5-SNAPSHOT), passed into the templates as a configuration value. Used by Roo scripts when creating multi-module subprojects. Must be specified if using Roo scripts. Use ${project.parent.version} to get value from pom.xml files.
springVersion(Back to Other)
Optional property
 Default value: 3.0
The version of Spring to use/support when generating. Necessary when API changes make some classes and/or methods deprecated.
    Permitted values are:
  • 2.0
  • 2.5
  • 3.0
javaVersion(Back to Other)
Optional property
 Default value: 1.6
The version of Java to use/support when generating. Necessary when Annotation changes make some annotations new or deprecated. For example, Java 1.6 uses @Override on implementation methods for interface implementation classes. Use ${javaVersion} property from the pom.xml.
recordType(Back to Other)
Optional property
 Default value: dao
The data record type. Use dao for Spring 2.x., use active for JpaTemplate, use repository for Spring Data JPA, or use one of the other Spring data implementations. Currently only dao and repository are supported.
    Permitted values are:
  • dao
  • active
  • repository
  • hadoop
  • redis
  • mongo
  • neo4j
  • hbase
  • gemfire
xmlConfiguration(Back to Other)
Optional property
 Default value: true
Create Spring XML configuration files. If false, create Spring annotations (3.x).
rooScripts(Back to Other)
Optional property
 Default value: false
Create Spring Roo scripts in the roo outlet location. If true, two scripts are created: One for one-time project scaffolding setup, and one for ongoing entity/service/ui/test creation. Roo scripts are run in a separate ../Roo subdirectory under the project, and are not run automatically as part of the project build. The outputs can be combined with the AndroMDA outputs, or the design patterns can be compared.
webServiceOutgoingAttachmentHandlerCallPattern(Back to Other)
Optional property
 No default value available
The pattern to use when constructing the call to the attachment handler (used for sending outgoing attachments when your service also represents a web service), for example:
  • Axis: org.andromda.webservice.AxisAttachmentHandler.saveAttachment(content, contentType, dime)
Attachments are good for sending large amounts of data over over the wire as it doesn't embed the data directly in the XML. NOTE: the handler call must have three parameters named content, contentType and dime.
webServiceIncomingAttachmentHandlerCallPattern(Back to Other)
Optional property
 No default value available
The pattern to use when constructing the call to the attachment handler (used for retrieving incoming attachments when your service also represents a web service), for example:
  • Axis: org.andromda.webservice.AxisAttachmentHandler.getAttachments()
Attachments are good for sending large amounts of data over over the wire as it doesn't embed the data directly in the XML.
daoInheritanceEnabled(Back to Other)
Optional property
 Default value: true
Whether or not the DAOs should make up an inheritance tree in the same way as their respective entities. This is enabled by default but you might want to disable it if you prefer not to have top-level DAO operations visible in child DAO classes, this is usually the case when using JDK5 generics, which can be enabled using the enableTemplating namespace property.
enableDaoPropertiesCreateMethod(Back to Other)
Optional property
 Default value: true
Whether or not the create methods on the DAOs taking properties from the entity shall be generated.
messageBundlePath(Back to Other)
Optional property
 Default value: messages
The path of the file representing the message bundle.
messageSourceBeanName(Back to Other)
Optional property
 Default value: messageSource
The name of the bean that stores the message source.
daoNamePattern(Back to Other)
Optional property
 Default value: {0}Dao
The pattern to use when constructing the DAO name. {0} is used to represent the entity name in the model, so if you specified a value of {0}Dao all the entities generated would have a suffix of "Dao".
daoBaseNamePattern(Back to Other)
Optional property
 Default value: {0}DaoBase
The pattern to use when constructing the base DAO's name. {0} is used to represent the entity name in the model, so if you specified a value of {0}DaoBase all the entities generated would have a suffix of "DaoBase".
daoImplementationNamePattern(Back to Other)
Optional property
 Default value: {0}DaoImpl
The pattern to use when constructing the DAO's implementation name. {0} is used to represent the entity name in the model, so if you specified a value of {0}DaoImpl all the entities generated would have a suffix of "DaoImpl".
ejbJndiNamePrefix(Back to Other)
Optional property
 No default value available
The prefix to give to the Session EJB JNDI names (this allows the same Session EJB to be deployed multiple times in the same container)
enableSpringTransactionsWhenEjbsEnabled(Back to Other)
Optional property
 Default value: true
Whether or not to enable Spring transaction support when EJBs are enabled. If this is set to false then only EJB transaction support is generated.
ejbTransactionsEnabled(Back to Other)
Optional property
 Default value: true
Whether or not EJB transactions should be enabled. This is sometimes useful to turn off when you're using EJB wrapped spring services but want to turn off EJB transaction management so that Spring alone handles the transactions (note that this property only make sense when EJBs are enabled).
ejbRemoteProxyFactoryBean(Back to Other)
Optional property
 Default value: org.springframework.ejb.access.SimpleRemoteStatelessSessionProxyFactoryBean
Full class name for proxy factory bean used in application context for remote EJB access applicationContextRemoteEjb.
ejbLocalProxyFactoryBean(Back to Other)
Optional property
 Default value: org.springframework.ejb.access.LocalStatelessSessionProxyFactoryBean
Full class name for proxy factory bean used in application context for local EJB access applicationContextLocalEjb.
ejbRemoteProviderUrl(Back to Other)
Optional property
 Default value: localhost:1099
The provider URL for remote EJB access.
ejbRemoteInitialContextFactory(Back to Other)
Optional property
 Default value: org.jnp.interfaces.NamingContextFactory
The initial context factory class for remote EJB access.
ejbRemoteUrlPackagePrefixes(Back to Other)
Optional property
 Default value: org.jboss.naming:org.jnp.interfaces
The URL package prefixes for remote EJB access.
ejbPackageNamePattern(Back to Other)
Optional property
 Default value: {0}.ejb
If EJBs are being used, this specifies the pattern to be used when constructing the EJB package name (this allows a Spring Service to be wrapped by a Session EJB and avoids name conflicts). The {0} character represents the service package name. This could be something like {0}.ejb which would create the Spring Session EJBs in the package ending in the ejb package.
implementationPackageNamePattern(Back to Other)
Optional property
 Default value: {0}
This specifies the pattern to be used for the package name of the spring service implementation class. You can use this to place the implementation class in a different package than the interface (e.g. in a OSGi runtime). The default {0} character represents the service package name.
defaultServiceExceptionNamePattern(Back to Other)
Optional property
 Default value: {0}Exception
The pattern to use when constructing the default service exception name. NOTE: This propety is only applicable when defaultServiceExceptions is true.
defaultServiceExceptions(Back to Other)
Optional property
 Default value: true
Whether or not to generate a default exception for each service. This exception will handle unexpected exceptions occurring within the implemented operations.
serviceInterceptors(Back to Other)
Optional property
 No default value available
Sets a list of default additional interceptors to be applied to service ProxyBeanFactory declarations. They will be listed after the serviceSecurityInterceptor, serviceTransactionInterceptor and hibernateInterceptor if present.
externalPrincipalStoreClass(Back to Other)
Optional property
 No default value available
If this is present, it will be assumed that an external principal store class will be used and non will be generated. Example: org.springframework.security.core.context.SecurityContextHolder
externalPrincipalStoreGetter(Back to Other)
Optional property
 Default value: get()
If externalPrincipalStoreClass is defined, externalPrincipalStoreGetter defines the method call on that class that will retrieve the principal.
externalPrincipalStoreGetterType(Back to Other)
Optional property
 Default value: java.security.Principal
If externalPrincipalStoreClass is defined, externalPrincipalStoreGetterType defines the type returned by the externalPrincipalStoreGetter method. Example: org.springframework.security.core.Authentication
entityNamePattern(Back to Other)
Optional property
 Default value: {0}
The pattern to use when constructing an entity name. {0} is used to represent the entity name in the model, so if you specified a value of {0}Entity all the entities generated would have a suffix of "Entity".
serviceOperationTransactionType(Back to Other)
Optional property
 Default value: PROPAGATION_REQUIRED
The default transaction type used for service operations (when not wrapping your services with EJBs). NOTE: Can be overridden on a per entity basis with the andromda_spring_transaction_type tagged value.
ejbServiceOperationTransactionType(Back to Other)
Optional property
 Default value: Required
The default transaction type definition used if EJB service operations.
    Permitted values are:
  • NotSupported
  • Supports
  • Required
  • RequiresNew
  • Mandatory
  • Never
ejbViewType(Back to Other)
Optional property
 Default value: local
If EJBs are being used, this specifies the view type for the EJB interfaces. Can be either local, remote or both.
ejbSessionBeanBaseInterfaceLocal(Back to Other)
Optional property
 Default value: javax.ejb.EJBLocalObject
Name of session bean local base interface for ejb wrapper.
ejbSessionBeanBaseInterfaceRemote(Back to Other)
Optional property
 Default value: javax.ejb.EJBObject
Name of session bean remote base interface for ejb wrapper.
ejbSessionBeanBaseClass(Back to Other)
Optional property
 Default value: org.springframework.ejb.support.AbstractStatelessSessionBean
Full name of session bean base class for ejb wrapper.
implementationOperationNamePattern(Back to Other)
Optional property
 Default value: handle{0}
The pattern used to the create the implementation operation name (i.e. the operations that actually perform the handling of the logic), where {0} represents the operation name
driver(Back to Other)
Optional property
 No default value available
JDBC Driver to make a database connection.
username(Back to Other)
Optional property
 No default value available
The database user login name.
password(Back to Other)
Optional property
 No default value available
The database user password.
connectionUrl(Back to Other)
Optional property
 No default value available
URL for the JDBC Driver to make the connection to the database.
dataSource(Back to Other)
Optional property
 No default value available
JNDI name of data source to use. (would be used instead of the connection properties, driver, username, password, etc).
testDriver(Back to Other)
Optional property
 No default value available
JDBC Driver to make a local in-memory unit test database connection.
testUsername(Back to Other)
Optional property
 No default value available
The local in-memory unit test database user login name.
testPassword(Back to Other)
Optional property
 No default value available
The local in-memory unit test database user password.
testConnectionUrl(Back to Other)
Optional property
 No default value available
URL for the JDBC Driver to make the connection to the local in-memory unit test database.
testDialect(Back to Other)
Optional property
 No default value available
Hibernate Dialect for the JDBC Driver to make the connection to the local in-memory unit test database.
applicationContext(Back to Other)
Optional property
 Default value: applicationContext.xml
The name given to the Spring application context file.
applicationContextManageable(Back to Other)
Optional property
 Default value: applicationContext-manageable.xml
The name given to the Spring CRUD application context file.
applicationContextDataSource(Back to Other)
Optional property
 Default value: applicationContext-dataSource.xml
The name given to the Spring datasource application context file
applicationContextLocalDataSource(Back to Other)
Optional property
 Default value: applicationContext-localDataSource.xml
The name given to the Spring local datasource application context file
applicationContextServer(Back to Other)
Optional property
 Default value: applicationContext-export-remoteServices.xml
The name given to the server side Spring configuration file used to export services for remote invocation.
applicationContextClient(Back to Other)
Optional property
 Default value: applicationContext-import-remoteServices.xml
The name given to the client side Spring configuration file used to import services invoked remotely.
applicationContextRemoteEjb(Back to Other)
Optional property
 Default value: applicationContext-remoteEjb.xml
The name/path of the application context resource file that contains the bean proxy definitions for accessing the ejb service wrappers (if generated with ejbViewType='remote' or 'both') via remote ejb interfaces (i.e. some/path/applicationContext-remoteejb.xml).
applicationContextLocalEjb(Back to Other)
Optional property
 Default value: applicationContext-localEjb.xml
The name/path of the application context resource file that contains the bean proxy definitions for accessing the ejb service wrappers (if generated with ejbViewType='local' or 'both') via local ejb interfaces (i.e. some/path/applicationContext-localejb.xml)
applicationContextOsgiExport(Back to Other)
Optional property
 Default value: applicationContext-osgi-export.xml
The name/path of the application context resource file that contains the spring osgi export definitions for all defined services.
applicationContextOsgiImport(Back to Other)
Optional property
 Default value: applicationContext-osgi-import.xml
The name/path of the application context resource file that contains the spring osgi import definitions for all defined services.
beanRefFactory(Back to Other)
Optional property
 Default value: beanRefFactory.xml
The name/path of the bean ref factory resource file (i.e. some/path/beanRefFactory.xml)
beanRefFactoryId(Back to Other)
Optional property
 Default value: beanRefFactory
The ID for the Spring bean reference factory (used to load the bean factory).
beanRefFactoryEjbId(Back to Other)
Optional property
 Default value: beanRefFactoryEjb
The ID for the Spring bean reference factory that holds the EJB references.
beanNamePrefix(Back to Other)
Optional property
 Default value:
The name prefix for all spring bean ids.
transactionManager(Back to Other)
Optional property
 Default value: org.springframework.transaction.jta.JtaTransactionManager
The transaction manager implementation used by Spring.
dataSourceEnabled(Back to Other)
Optional property
 Default value: true
Whether or not a data source will be defined. By default the data source configuration is always generated, however if this is set to false and no entities have been modeled, a data source will not be generated.
localTransactionManager(Back to Other)
Optional property
 Default value: org.springframework.orm.hibernate4.HibernateTransactionManager
The transaction manager implementation used by Spring for the local datasource (applicationContextLocalDataSource).
userTransactionName(Back to Other)
Optional property
 No default value available
The (JNDI-) user transaction manager of the J2EE container if using JTA transactions (via spring).
transactionManagerName(Back to Other)
Optional property
 No default value available
The (JNDI-) transaction manager of the J2EE container if using JTA transactions (via spring).
sessionFactory(Back to Other)
Optional property
 Default value: org.springframework.orm.hibernate4.LocalSessionFactoryBean
Factory bean that creates a local Hibernate SessionFactory instance within Spring. If using annotations with Spring3, specify org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean. Or use org.springframework.orm.hibernate4.LocalSessionFactoryBean.
springTypesPackage(Back to Other)
Optional property
 Default value: org.andromda.spring
The package to which extra types are generated (i.e. ServiceLocator).
springCommonTypesPackage(Back to Other)
Optional property
 Default value: org.andromda.spring
Optional definition of the package name where all common visible (to the client) extra types are to be generated (e.g. PaginationResult).
springPresentationTypesPackage(Back to Other)
Optional property
 Default value: org.andromda.spring.presentation
The package to which extra presentation types are generated (i.e. OpenSessionInViewFilter).
serviceLocatorName(Back to Other)
Optional property
 Default value: ServiceLocator
The name to give the service locator class.
serviceLocatorDefaultFactoryId(Back to Other)
Optional property
 No default value available
The default beanReafFactoryId to be used in the ServiceLocator. By default the beanRefFactoryId is used (if EJB is not activated). If EJB is activated the beanRefFactoryEjbId is used. With the serviceLocatorDefaultFactoryId this behavior can be explicitly overridden.
manageableServiceLocatorName(Back to Other)
Optional property
 Default value: ManageableServiceLocator
The name to give the CRUD service locator class.
clientServiceLocatorName(Back to Other)
Optional property
 Default value: RemoteServiceLocator
The name to give the service locator class used by remote clients.
clientServiceLocatorClassloaderSwitching(Back to Other)
Optional property
 Default value: off
Whether the client service locator should switch the thread context class loader during retrieval of the client application context xml file.
clientExceptionHandlingAdviceName(Back to Other)
Optional property
 Default value: ClientExceptionHandlingAdvice
The name for the client side exception handling advice
criteriaSearchBaseName(Back to Other)
Optional property
 Default value: CriteriaSearch
The base name for the hibernate criteria search utility classes.
principalStoreName(Back to Other)
Optional property
 Default value: PrincipalStore
The name of the principal store class.
openSessionInViewFilterName(Back to Other)
Optional property
 Default value: AndroMDAOpenSessionInViewFilter
The name of the OpenSessionInViewFilter (when using the open-session-in-view pattern).
securityRealm(Back to Other)
Optional property
 No default value available
The name of the security realm (i.e. animal-quiz, other, etc). NOTE:This enables EJB security if specified.
jndiDataSourceClass(Back to Other)
Optional property
 Default value: org.springframework.jndi.JndiObjectFactoryBean
The name of the class to use when using a JNDI data source for data access.
jndiDataSourceCaching(Back to Other)
Optional property
 No default value available
Enables to turn off the caching of the jndi datasource (value false) if using the default data source class org.springframework.jndi.JndiObjectFactoryBean. Usefull for allowing hot redeployment of JNDI objects. If not specified, no additional code is generated with default behavior cache enabled.
jdbcDataSourceClass(Back to Other)
Optional property
 Default value: org.springframework.jdbc.datasource.DriverManagerDataSource
The name of the class to use when using a JDBC data source for data access.
jdbcDataSourceDestroyMethod(Back to Other)
Optional property
 No default value available
The name of the method to use for destroying the JDBC datasource.
parameterRequiredCheck(Back to Other)
Optional property
 Default value: true
Whether or not parameters should be checked if they're required (on DAOs and services)
xmlEncoding(Back to Other)
Optional property
 Default value: UTF-8
The encoding for xml documents
crudValueObjectSuffix(Back to Other)
Optional property
 Default value: ValueObject
The suffix to append to the names of generated value objects used in CRUD (manageable entities).
implementationLanguage(Back to Other)
Optional property
 Default value: java
Indicates the programming language being used in classes generated to be completed by hand (service and dao implementation,for example).
jmsProviderUrl(Back to JMS)
Optional property
 Default value: localhost:1099
The provider URL for remote JMS access (if you're using ActiveMQ as your provider, you'll typically want to set the URL as something like 'reliable:tcp://localhost:61616'; changing the port as necessary of course).
jmsInitialContextFactory(Back to JMS)
Optional property
 Default value: org.jnp.interfaces.NamingContextFactory
The initial context factory class for JMS access.
jmsUrlPackagePrefixes(Back to JMS)
Optional property
 Default value: org.jnp.interfaces:org.jboss.naming
The URL package prefixes for remote JMS access.
jmsConnectionFactory(Back to JMS)
Optional property
 Default value: UIL2ConnectionFactory
The default JMS queue connection factory.
applicationContextJms(Back to JMS)
Optional property
 Default value: applicationContext-jms.xml
The name/path of the application context resource file that contains the bean proxy definitions for accessing the JMS related services (i.e. Queues).
jmsTopicNamePrefix(Back to JMS)
Optional property
 Default value: topic/
The prefix for topics names (i.e. a prefix of "topic/" would result in a topic named "Events" as "topic/Events"). Applies to the JNDI name (in case of JBossMQ), or physical name (in case of ActiveMQ).
jmsQueueNamePrefix(Back to JMS)
Optional property
 Default value: queue/
The prefix for queue names (i.e. a prefix of "queue/" would result in a topic named "Events" as "queue/Events"). Applies to the JNDI name (in case of JBossMQ), or physical name (in case of ActiveMQ).
jmsTemplateImplementation(Back to JMS)
Optional property
 Default value: org.springframework.jms.core.JmsTemplate
The implementation to use for the Spring JmsTemplate. org.springframework.jms.core.JmsTemplate102 is used for JMS 1.0.2 providers and org.springframework.jms.core.JmsTemplate is used for 1.1 providers.
jmsReceiveTimeout(Back to JMS)
Optional property
 Default value: 30000
The timeout at which the transmission of the JMS message will timeout.
jmsDestinationTemplatePattern(Back to JMS)
Optional property
 Default value: {0}JmsTemplate
The pattern used to create the JMS template used for accessing a destination (topic/queue).
jmsProvider(Back to JMS)
Optional property
 Default value: JBossMQ
The JMS provider implementation (valid values are "JBossMQ" and "ActiveMQ")
jmsMessageListenerAdapterImplementation(Back to JMS)
Optional property
 Default value: org.springframework.jms.listener.adapter.MessageListenerAdapter
The Spring message listener adaptor implementation. See API docs.
jmsMessageListenerContainerImplementation(Back to JMS)
Optional property
 Default value: org.springframework.jms.listener.DefaultMessageListenerContainer
The Spring message listener container implementation. See API docs.
jmsExplicitQosEnabled(Back to JMS)
Optional property
 Default value: true
If "true", then the values of deliveryMode, priority, and timeToLive will be used when sending a message.
jmsClientId(Back to JMS)
Optional property
 No default value available
Set the client identifier base name for JMS connections.
jmsDurableSubscriptions(Back to JMS)
Optional property
 Default value: true
Whether or not subscriptions should be durable by default. Only makes sense when listening to a topic (pub-sub domain).
jmsDurableSubscriptionName(Back to JMS)
Optional property
 No default value available
The name used to identify the durable subscription. To be applied in case of a topic (pub-sub domain) with subscription durability activated. The durable subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener.
jmsTransactionsEnabled(Back to JMS)
Optional property
 Default value: true
Whether or not JMS destinations should be transacted.
jmsCacheLevelName(Back to JMS)
Optional property
 Default value:
Sets the cache level name. See setCacheLevelName(java.lang.String)
jmsMaxIncomingMessagesPerReceive(Back to JMS)
Optional property
 Default value:
Sets the maxmium number of incoming messages to process at a time per receive.
jmsRecoveryInterval(Back to JMS)
Optional property
 Default value: 5000
The interval of recovery attempts in milliseconds.
jmsSessionTransacted(Back to JMS)
Optional property
 Default value: true
Set the transaction mode that is used when creating a JMS Session. See setSessionTransacted(boolean)
jmsActiveMqDurableTopicPrefetch(Back to JMS)
Optional property
 Default value: 100
Sets the default durable topic prefetch policy for ActiveMQ.
jmsActiveMqQueuePrefetch(Back to JMS)
Optional property
 Default value: 1000
Sets the default queue prefetch policy for ActiveMQ.
manageableSearchMatchMode(Back to JMS)
Optional property
 Default value: start
Specifies the match mode to be used in CRUD searches.
    Valid values are (string):
  • start
    • Start of the word
  • anywhere
    • Anywhere in the word
hibernateVersion(Back to Hibernate)
Optional property
 Default value: 4
The version of Hibernate to use when generating.
    Allowable values are:
  • 2 - Hibernate 2.x
  • 3 - Hibernate 3.x
  • 4 - Hibernate 4.x
hibernateEntityAnnotations(Back to Hibernate)
Optional property
 Default value: true
Set to true to enable Hibernate @Annotations on Entity classes for ORM properties, no hbm.xml files will be generated. The hibernateVersion namespace property must be set to 3 or 4.
hibernateMappingStrategy(Back to Hibernate)
Optional property
 Default value: hierarchy
Denotes whether or not subclasses should be mapped into the same .hbm.xml file or in a separate one.
  • Set this value to subclass when you want to have a mapping file per entity
  • The default is hierarchy which will render a mapping file per subclass
This information is important for the Spring cartridge because it needs to know which entities require a mapping file and which don't.
hibernateXMLPersistence(Back to Hibernate)
Optional property
 Default value: false
Set to TRUE to enable Hibernate's XML persistence support using dom4J. "hibernateVersion" must be set to 3 or 4
hibernateQueryUseNamedParameters(Back to Hibernate)
Optional property
 Default value: false
Whether or not named parameters (i.e. ':someParameter') or unnamed (i.e. '?') parameters should be used in the HQL queries embedded within the model. NOTE: Does not apply to queries written in OCL.
hibernateInheritanceStrategy(Back to Hibernate)
Optional property
 Default value: subclass
Defines the hibernate inheritance strategy (unless overridden on an entity level by the andromda_hibernate_inheritance tagged value, can be the following possible values:
  • class - table per hierarchy.
  • subclass - table per class in hierarchy.
  • concrete - Table per class.
  • interface - Root class is defined as an interface and the attributes remapped to the subclasses. This is useful in the concrete case because it has limitations in the associations.
serviceHibernateInterceptorEnabled(Back to Hibernate)
Optional property
 Default value: true
Whether or not the hibernate interceptor should be enabled on services.
hibernatePoolSize(Back to Hibernate)
Optional property
 No default value available
Hibernate connection pool size.
hibernateTransactionManagerStrategy(Back to Hibernate)
Optional property
 No default value available
Strategy for obtaining the JTA TransactionManager
hibernateUserTransactionName(Back to Hibernate)
Optional property
 No default value available
The JNDI name of the JTA UserTransaction object
hibernateTransactionManagerLookup(Back to Hibernate)
Optional property
 No default value available
The fully qualified class name of the Hibernate TransactionFactory implementation
hibernateTransactionFactoryClass(Back to Hibernate)
Optional property
 No default value available
The name of the hibernate transaction factory class to use.
hibernateUseOuterJoin(Back to Hibernate)
Optional property
 No default value available
Whether or not to use outer joins.
hibernateShowSql(Back to Hibernate)
Optional property
 No default value available
Whether or not to log SQL statements (true/false). By default this is off (within Hibernate).
hibernateJndiName(Back to Hibernate)
Optional property
 No default value available
JNDI name bound to the SessionFactory.
hibernateDialect(Back to Hibernate)
Optional property
 No default value available
SQL dialect of the database being used.
hibernateDefaultSchema(Back to Hibernate)
Optional property
 No default value available
Qualify unqualified tablenames with the given schema/tablespace in generated SQL.
hibernateMaxFetchDepth(Back to Hibernate)
Optional property
 No default value available
Sets a maximum "depth" for the outer join fetch tree. eg. recommended values between 0 and 3
hibernateJdbcFetchSize(Back to Hibernate)
Optional property
 No default value available
A non-zero value determines the JDBC fetch size.
hibernateDefaultBatchFetchSize(Back to Hibernate)
Optional property
 Default value: 16
hibernate.default_batch_fetch_size Set a default size for Hibernate batch fetching of associations. Recommended values: 4, 8, 16
hibernateJdbcBatchSize(Back to Hibernate)
Optional property
 No default value available
A nonzero value enables use of JDBC2 batch updates by Hibernate. ex: recommended values between 5 and 30
hibernateJdbcUseScrollableResultSet(Back to Hibernate)
Optional property
 No default value available
Whether or not to enable use of JDBC2 scrollable resultsets by Hibernate. This property is only necessary when using user supplied connections. Hibernate uses connection metadata otherwise.
hibernateJdbcUseStreamsForBinary(Back to Hibernate)
Optional property
 No default value available
Whether or not to use streams when writing / reading binary or serializable types to/from JDBC
hibernateHbm2DDLAuto(Back to Hibernate)
Optional property
 No default value available
Automatically export schema DDL to the database when the SessionFactory is created. With create-drop, the database schema will be dropped when the SessionFactory is closed explicitly. Permitted values are:
  1. update
  2. create
  3. create-drop
hibernateQuerySubstitutions(Back to Hibernate)
Optional property
 No default value available
Allows you to define new Hibernate query tokens. For example: giving this a value of true=1, false=0 would cause the tokens true and false to be translated to integer literals in the generated SQL.
hibernateEnableCache(Back to Hibernate)
Optional property
 Default value: false
Enable/disable hibernate's second level cache features when using Hibernate.
  • true
  • false
hibernateCacheProvider(Back to Hibernate)
Optional property
 Default value: net.sf.hibernate.cache.EhCacheProvider
Defines the Hibernate cache provider implementation class.
hibernateQueryCacheFactory(Back to Hibernate)
Optional property
 Default value: net.sf.hibernate.cache.StandardQueryCacheFactory
Defines Hibernate query cache factory implementation class
hibernateConnectionReleaseMode(Back to Hibernate)
Optional property
 No default value available
Specify when Hibernate should release JDBC connections. By default, a JDBC connection is held until the session is explicitly closed or disconnected. For an application server JTA datasource, you should use after_statement to aggressively release connections after every JDBC call. For a non-JTA connection, it often makes sense to release the connection at the end of each transaction, by using after_transaction. auto will choose after_statement for the JTA and CMT transaction strategies and after_transaction for the JDBC transaction strategy.
    Valid values are:
  • on_close
    • - default
  • after_transaction
  • after_statement
  • auto
javaTypeConversionIgnoreList(Back to Hibernate)
Optional property
 No default value available
A list of one or more fully qualified java types that should be ignored whenever a type conversion needs to be done. Currently, there is an issue with ValueObjects generated with the Java Axis mappings that causes Spring cartidge to generate DAO "entity to value object" type conversions incorrectly for all date types. By listing those date types here, the Spring cartridge will not attempt to auto-generate conversions for date/time related attributes.
hibernateInterceptorFlushMode(Back to Hibernate)
Optional property
 No default value available
Specifies the FLUSH_MODE for the Hibernate Interceptor (org.springframework.orm.hibernate.HibernateInterceptor). FLUSH_MODE determines the moment where all the generated SQL from a transaction should be flushed to the database.
    Valid values are (integer):
  • 0
    • FLUSH_NEVER
  • 1
    • FLUSH_AUTO - default
  • 2
    • FLUSH_EAGER
  • 3
    • FLUSH_COMMIT
serviceSecurity(Back to Spring Security)
Optional property
 Default value: false
Whether or not Spring security framework should be used for role based recurity handling for spring services.
serviceSecurityInterceptor(Back to Spring Security)
Optional property
 Default value: org.springframework.security.access.intercept.aopalliance.MethodSecurityInterceptor
The name of the class to use for the spring security interception.
serviceAccessDecisionManager(Back to Spring Security)
Optional property
 Default value: org.springframework.security.access.vote.AffirmativeBased
The name of the class to use for the security access decision manager.
serviceDecisionVoter(Back to Spring Security)
Optional property
 Default value: org.springframework.security.access.vote.RoleVoter
The name of the class to use for the security access decision voter.
securityRemoteAuthenticationManagerServiceInterface(Back to Spring Security)
Optional property
 Default value: org.springframework.security.authentication.rcp.RemoteAuthenticationManager
The name of the class to use for the security remote authentication manager (in the client remote context).
securityRolePrefix(Back to Spring Security)
Optional property
 Default value: ROLE_
The prefix for all roles defined in the model. This configures the securityServiceDecisionVoters rolePrefix attribute. As proposed by Spring for our default voter org.springframework.security.access.vote.RoleVoter, the default value is ROLE_. It can be overwritten with an empty string if no prefix is wanted/necessary at all. Please NOTE that AndroMDA will add this prefix to all role/actor names, which do not already have it defined in the model.
securityAuthenticationManager(Back to Spring Security)
Optional property
 No default value available
The bean name of the security authentication manager (defined in a separate applicationContext outside of the generated one).
securityRunAsManager(Back to Spring Security)
Optional property
 No default value available
The bean name of the security run as manager (defined in a separate applicationContext outside of the generated one).
richClient(Back to Rich Client)
Optional property
 Default value: false
Set to "true" if the cartridge is generating code for a rich client environment.
configPropertyPrefix(Back to Rich Client)
Optional property
 Default value:
A prefix to use for properties stored in configuration files. A typical setting for this is the application ID plus the "." character. Empty by default.
applicationContextServerAuthentication(Back to Rich Client)
Optional property
 Default value: applicationContext-server-authentication.xml
The name of the bean definition file used for server side declarations of user authentication beans when SpringSecurity is being used (i.e. serviceSecurity is true).
applicationContextClientAuthentication(Back to Rich Client)
Optional property
 Default value: applicationContext-client-authentication.xml
The name of the bean definition file used for client side declarations of user authentication beans when SpringSecurity is being used (i.e. serviceSecurity is true).
serverTestBeanRefFactory(Back to Rich Client)
Optional property
 Default value: applicationContext-test.xml
The name of the bean ref factory resource file used for unit testing the server code (i.e. application-test.xml)
serverTestContextDataSource(Back to Rich Client)
Optional property
 Default value: applicationContext-test-dataSource.xml
The name of the configuration file for the data source of the server test code (i.e. application-test-dataSource.xml)
serverTestContextAuthentication(Back to Rich Client)
Optional property
 Default value: applicationContext-test-authentication.xml
The name of the bean definition file used for server side declarations of user authentication beans when SpringSecurity is being used and unit tests are being performed.
clientHttpInvokerExecutor(Back to Rich Client)
Optional property
 No default value available
The name of the class to use if a specialized HttpInvokerExecutor is desired on the client side when HttpInvoker is used as the remote service protocol. One common use it to use org.springframework.security.remoting.httpinvoker.AuthenticationSimpleHttpInvokerRequestExecutor when remote services are protected with Basic Authentication using Spring security. Another use is to set this to org.springframework.remoting.httpinvoker.CommonsHttpInvokerRequestExecutor if you want to use Jakarta Commons HttpClient to execute requests.
authenticationManagerImplClass(Back to Rich Client)
Optional property
 No default value available
The class of the authentication manager bean named with the authenticationManager namespace property. If defined, an implementation definition will be added to the server side Spring configuration file named with the applicationContextServerAuthentication namespace property. Example: org.springframework.security.authentication.ProviderManager
daoAuthenticationProviderBeanName(Back to Rich Client)
Optional property
 Default value: daoAuthenticationProvider
The bean name of the security authentication Dao Provider used by the server side authentication manager implemented with the authenticationManagerImplClass namespace property.
daoAuthenticationProviderImplClass(Back to Rich Client)
Optional property
 No default value available
The class of the Dao Authentication Provider bean named with the daoAuthenticationProviderBeanName namespace property. If defined, an implementation definition will be added to the server side Spring configuration file named with the applicationContextServerAuthentication namespace property. Example: org.springframework.security.authentication.dao.DaoAuthenticationProvider
authenticationDaoBeanName(Back to Rich Client)
Optional property
 No default value available
The bean name of the security authentication Dao used by the default server side authentication implementation generated for rich client projects.
authenticationDaoImplClass(Back to Rich Client)
Optional property
 No default value available
The complete package name and class name of the class that implements user authentication. This property should be set if you want to manage user authentication yourself and you want AndroMDA to generate stub classes to get the process started. Example: ${application.package}.UserDetailsServiceImpl
securityDaoUserCacheBeanName(Back to Rich Client)
Optional property
 No default value available
The name of the bean that implements a cache for user information. If defined, it activate user caching in the Dao provider by setting the "userCache" property of the Dao provider defined with the securityDaoAuthenticationProviderClass namespace property.
securityDaoUserCacheImplClass(Back to Rich Client)
Optional property
 No default value available
The name of the class used to implement user caching in the Dao provider. If defined, a user cache implementation will be added to the server side Spring configuration file named with the applicationContextServerAuthentication namespace property. If defined, you must also define the securityUserCacheConfigLocation namespace property. Example: org.springframework.security.core.userdetails.cache.EhCacheBasedUserCache
securityUserCacheConfigLocation(Back to Rich Client)
Optional property
 No default value available
The location of the EhCache configuration file used by the securityDaoUserCacheImplClass. This name is used as the "configLocation" property in the configuration of the implementation of the securityDaoUserCacheImplClass namespace property. You should also define the securityUserCacheName namespace property so it matches the cache name of the cache to use that is defined in the EhCache configuration file. If "default" is used for this property, a "default implementation" will be generated in the server configuration outlet. The file will be named ehcache-server-authentication.xml.
securityUserCacheName(Back to Rich Client)
Optional property
 No default value available
The name of the cache configuration to use for caching user authentication information. This cache configuration should be found in the EhCache configuration file defined with the securityUserCacheConfigLocation namespace property.
passwordEncoderBeanName(Back to Rich Client)
Optional property
 No default value available
The name of the bean that implements a password encoder for user information. If defined, it activates user password encoding in the Dao provider by setting the "passwordEncoder" property of the Dao provider defined with the daoAuthenticationProviderClass namespace property.
passwordEncoderImplClass(Back to Rich Client)
Optional property
 No default value available
The name of the class used to implement user password encoder in the Dao provider. If defined, a password encoder implementation will be added to the server side Spring configuration file named with the applicationContextServerAuthentication namespace property. Example: org.springframework.security.authentication.encoding.Md5PasswordEncoder
passwordSaltSourceBeanName(Back to Rich Client)
Optional property
 No default value available
The name of the bean that implements a password encoder salt source for user information. If defined, it enhances user password encoding in the Dao provider by setting the "saltSource" property of the Dao provider defined with the daoAuthenticationProviderClass namespace property.
serviceRemotingType(Back to Remoting)
Optional property
 Default value: none
Determines the type of remoting to be used for Spring services. Can any one of
  • none
  • rmi
  • httpinvoker
  • burlap
  • hessian
  • lingo
Please note that in order to use Lingo remoting, you need to use Spring 2.0.
serviceRemotePort(Back to Remoting)
Optional property
 Default value: 8080
The port the exported services get published on.
serviceRemotePortJMS(Back to Remoting)
Optional property
 Default value: 61616
This port will be used if you export services using Lingo remoting.
serviceRemoteContext(Back to Remoting)
Optional property
 No default value available
The context the exported services get published on.
serviceRemoteUrlPattern(Back to Remoting)
Optional property
 Default value: /remoting
The url pattern associated to exported services. i.e. "/services".
serviceRemoteServer(Back to Remoting)
Optional property
 Default value: localhost
The remote server the Spring services get published on.
remoteHttpServiceScheme(Back to Remoting)
Optional property
 Default value: http
The scheme for any HTTP remotable services (i.e. http or https).
remoteRmiServiceScheme(Back to Remoting)
Optional property
 Default value: rmi
The scheme for any RMI remotable services.
remoteTcpServiceScheme(Back to Remoting)
Optional property
 Default value: tcp
The scheme for any TCP remotable services.
remoteDispatcherServletName(Back to Remoting)
Optional property
 Default value: RemoteDispatcherServlet
The name to give the remote dispatcher servlet.
remoteWebApplicationContextName(Back to Remoting)
Optional property
 Default value: RemoteWebApplicationContext
The name to give the remote web application context class.
remoteServiceUsername(Back to Remoting)
Optional property
 No default value available
The optional username to use for authenticating to the remotable services.
remoteServicePassword(Back to Remoting)
Optional property
 No default value available
The optional password to use for authenticating to the remotable services.
remoteAuthenticatingHttpInvokerRequestExecutorName(Back to Remoting)
Optional property
 Default value: AuthenticatingHttpInvokerRequestExecutor
The name to give the AuthenticatingHttpInvokerRequestExecutor class.
dateTimeGeneratedText(Back to Remoting)
Optional property
 Default value: true
Adds a comment with the current date and time to the generated file.