PDFPDF

AndroMDA Spring Cartridge Namespace Components

  • cartridge
  • metafacades
  • profile

AndroMDA Spring Cartridge Namespace Properties

Acegi Security
Configures the declaritive role based security without EJB , which uses the Acegi Security System for Spring.
Hibernate
The properties for configuring Hibernate support generation.
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.

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)
Required 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)
Required 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 enties 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.
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 a Rich Client environment (i.e. the richClient namespace entry is "true").
client-config(Back to Outlets)
Optional property
No default value available
The location where client side configuration files are generated if using a Rich Client environment (i.e. the richClient namespace entry is "true").
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").
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").
merge-mappings(Back to Outlets)
Optional property
No default value available
The location where AndroMDA merge mapping stub files should be generated.
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.
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.
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 occuring 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.
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.
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).
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)
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.
transactionManager(Back to Other)
Optional property
Default value: org.springframework.transaction.jta.JtaTransactionManager
The transaction manager implementation used by Spring.
localTransactionManager(Back to Other)
Optional property
Default value: org.springframework.orm.hibernate.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.hibernate.LocalSessionFactoryBean
Factory bean that creates a local Hibernate SessionFactory instance within Spring.
springTypesPackage(Back to Other)
Optional property
Default value: org.andromda.spring
The package to which extra types are generated (i.e. ServiceLocator).
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 behaviour can be explicit 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.
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).
hibernateVersion(Back to Hibernate)
Optional property
Default value: 2
The version of Hibernate to use when generating.
    Allowable values are:
  • 2
  • 3
hibernateMappingStrategy(Back to Hibernate)