Root Element

ElementDescriptionClass
serviceunitA deployable service unit containerorg.apache.servicemix.jbi.container.SpringServiceUnitContainer

Element Summary

ElementDescriptionClass
activationSpecThe Componentorg.apache.servicemix.jbi.container.ActivationSpec
adminReadWritePolicyPolicy implementation that grants read-write access to members of the 'admin' group and read-only access to all other users.org.apache.servicemix.jbi.jmx.AdminReadWritePolicy
authenticationServiceImplementation of the authentication service using JAAS.org.apache.servicemix.jbi.security.auth.impl.JAASAuthenticationService
authorizationEntryorg.apache.servicemix.jbi.security.acl.impl.AuthorizationEntry
authorizationMaporg.apache.servicemix.jbi.security.acl.impl.DefaultAuthorizationMap
clientA factory bean which creates a ServiceMixClient. It first try to use the configured ClientFactory, the ComponentContext then JBIContainer and at last, it tries to locate the ClientFactory in JNDI under the provided name.org.apache.servicemix.client.ClientFactoryBean
containerThe ServiceMix JBI Containerorg.apache.servicemix.jbi.container.SpringJBIContainer
deployServiceAssemblyDeploys a service assemblyorg.apache.servicemix.jbi.container.DeployServiceAssembly
dotViewEndpointListenerGenerates DOT visualisations of the components and endpoints available inside ServiceMixorg.apache.servicemix.jbi.view.DotViewEndpointListener
dotViewFlowListenerGenerates DOT visualisations of the exchanges flow inside ServiceMixorg.apache.servicemix.jbi.view.DotViewFlowListener
dotViewServiceorg.apache.servicemix.jbi.view.DotViewService
installComponentInstalls a shared libraryorg.apache.servicemix.jbi.container.InstallComponent
installSharedLibraryInstalls a shared libraryorg.apache.servicemix.jbi.container.InstallSharedLibrary
jcaFlowUse for message routing among a network of containers. All routing/registration happens automatically.org.apache.servicemix.jbi.nmr.flow.jca.JCAFlow
jmsFlowUse for message routing among a network of containers. All routing/registration happens automatically.org.apache.servicemix.jbi.nmr.flow.jms.JMSFlow
jmsFlowTibcoUse for message routing among a network of containers. All routing/registration happens automatically.org.apache.servicemix.jbi.nmr.flow.jms.JMSFlowTibco
jmxConnectorFactoryBean that creates a JSR-160 JMXConnectorServer, optionally registers it with the MBeanServer and then starts it.

The JMXConnectorServer can be started in a separate thread by setting the threaded property to true. You can configure this thread to be a daemon thread by setting the daemon property to true. This xbean-enabled factory is a wrapper on top of the existing Spring factory bean. It also logs the serviceUrl when starting.

org.apache.servicemix.jbi.jmx.ConnectorServerFactoryBean
jmxJaasAuthenticatororg.apache.servicemix.jbi.jmx.JaasAuthenticator
jmxPasswordAuthenticatororg.apache.servicemix.jbi.jmx.PasswordAuthenticatorFactoryBean
jmxServerorg.apache.servicemix.jbi.jmx.MBeanServerFactoryBean
keystoreorg.apache.servicemix.jbi.security.keystore.impl.FileKeystoreInstance
keystoreManagerorg.apache.servicemix.jbi.security.keystore.impl.BaseKeystoreManager
logServiceorg.apache.servicemix.jbi.logging.LogService
rmiRegistryorg.apache.servicemix.jbi.jmx.RmiRegistryFactoryBean
securedBrokerorg.apache.servicemix.jbi.security.SecuredBroker
sedaFlowThe SedaFlow introduces a simple event staging between the internal processes in the NMR Broker. A Seda flow (the default) is suited for general deployment, as the additional staging is well suited buffering exchanges between heavily routed to components (where state may be being used) for example.org.apache.servicemix.jbi.nmr.flow.seda.SedaFlow
serviceunitA deployable service unit containerorg.apache.servicemix.jbi.container.SpringServiceUnitContainer
stFlowA simple Straight through flow. A MessageExchange is routed straight to it's destination with no staging or buffering. A straight through flow is best suited for the cases where the ServiceMix JBIContainer is deployed with simple flows (no state) or embedding, or where latency needs to be as low as possible.org.apache.servicemix.jbi.nmr.flow.st.STFlow
statisticsorg.apache.servicemix.jbi.monitoring.StatisticsService
subscriptionSpecRepresents a subscription to a JBI endpoint.org.apache.servicemix.jbi.container.SubscriptionSpec
systemPropertiesSpring bean for initializing system properties.org.apache.servicemix.jbi.util.SystemProperties

Element Detail

Element: activationSpec

AttributeTypeDescription
componentNamexs:string
destinationEndpointxs:stringThe destination endpoint
destinationInterfacexs:QNameThe destination interface
destinationOperationxs:QNameThe destination operation name
destinationServicexs:QNameThe destination service name
destinationUrixs:string
endpointxs:stringReturns the endpoint name of this component
failIfNoDestinationEndpointxs:booleanSets whether or not there should be a failure if there is no matching endpoint for the service dispatch. It may be in a pure publish/subscribe model you want all available subscribes to receive the message but do not mind if there is not a single destination endpoint that can be found.
idxs:stringThe unique component ID
interfaceNamexs:QName
operationxs:QName
servicexs:QNameReturns the service of the component to register
ElementTypeDescription
component<spring:bean/>
destinationResolver<spring:bean/>Returns the destination resolver used to decide which destination the container should route this component to.
interfaceChooser<spring:bean/>
marshaler<spring:bean/>
persistent<spring:bean/>Set if message exchanges issued by the component should be persistent or not. This value will override the default one given on the {@link org.apache.servicemix.jbi.container.JBIContainer#persistent} attribute.
serviceChooser<spring:bean/>
subscriptions(subscriptionSpec)*

Element: adminReadWritePolicy

Element: authenticationService

Element: authorizationEntry

AttributeTypeDescription
endpointxs:string
operationxs:QName
rolesxs:string
servicexs:QName
typexs:string
ElementTypeDescription
acls(<spring:bean/>)*

Element: authorizationMap

ElementTypeDescription
authorizationEntries(<spring:bean/>)*
defaultEntryauthorizationEntry

Element: client

AttributeTypeDescription
namexs:string
ElementTypeDescription
containercontainer
context<spring:bean/>
factory<spring:bean/>

Element: container

AttributeTypeDescription
autoEnlistInTransactionxs:booleanRetrieve the value for automatic transaction enlistment.
createJmxConnectorxs:boolean
createMBeanServerxs:booleanSet the flag to create own MBeanServer if none supplied
deploymentDirPathxs:string
deploymentExtensionsxs:string
embeddedxs:boolean
flowNamexs:string
flowNamesxs:string
forceShutdownxs:longSet the timeout (in ms) before a shutdown is forced by cancelling all pending exchanges. The default value is 0 -- no forced shutdown
generateRootDirxs:booleanCreates an auto-generated rootDir which is useful for integration testing in JUnit test cases allowing installations of deployments inside an empty installation of ServiceMix
generatedRootDirPrefixxs:stringSets the prefix used when auto-creating a rootDir property value which is useful for integration testing inside JUnit test cases letting each test case create its own empty servicemix install
installationDirPathxs:stringSet the installationDir - rge default location is root//installation
monitorDeploymentDirectoryxs:boolean
monitorInstallationDirectoryxs:boolean
monitorIntervalxs:integer
namexs:string
notifyStatisticsxs:boolean
optimizedDeliveryxs:boolean
persistentxs:booleanSet the new default value for exchange persistence. This value will be the default if none is configured on the activation spec of the component or on the message.
rmiPortxs:integer
rootDirxs:stringSet the workspace root
subscriptionFlowNamexs:stringSet the subscription flow name
useMBeanServerxs:boolean
useNewTransactionModelxs:booleanSets whether the new transaction model should be used.
useShutdownHookxs:booleanSets whether or not we should use a shutdown handler to close down the broker cleanly if the JVM is terminated. It is recommended you leave this enabled.
ElementTypeDescription
MBeanServer<spring:bean/>Set the MBeanServer
activationSpecs(activationSpec)*
brokersecuredBrokerSet the Broker to use
componentNames(<spring:bean/>)*
components<spring:bean/>
deployArchives(<spring:bean/>)*
deployments(deployServiceAssembly | installComponent | installSharedLibrary)*
endpoints<spring:bean/>
executorFactory<spring:bean/>
flowjcaFlow | jmsFlow | jmsFlowTibco | sedaFlow | stFlowSet the broker message flow
flows(jcaFlow | jmsFlow | jmsFlowTibco | sedaFlow | stFlow)*Set the broker message flows
listeners(<spring:bean/>)*
namingContext<spring:bean/>Set the naming context
services(dotViewService | logService | securedBroker | statistics)*
transactionManager<spring:bean/>Set the transaction manager

Element: deployServiceAssembly

AttributeTypeDescription
artifactIdxs:string
deferExceptionxs:boolean
filexs:string
groupIdxs:string
homeDirxs:string
repositoryDirxs:string
serviceAssemblyNamexs:string
typexs:string
versionxs:string
ElementTypeDescription
commandsService<spring:bean/>
jbiContainercontainer

Element: dotViewEndpointListener

AttributeTypeDescription
filexs:string
rerenderOnChangexs:boolean
ElementTypeDescription
containercontainer

Element: dotViewFlowListener

AttributeTypeDescription
displayComponentsxs:boolean
filexs:string
rerenderOnChangexs:boolean
ElementTypeDescription
containercontainer

Element: dotViewService

AttributeTypeDescription
autoStartxs:boolean
ElementTypeDescription
containercontainer

Element: installComponent

AttributeTypeDescription
artifactIdxs:string
componentNamexs:string
deferExceptionxs:boolean
filexs:string
groupIdxs:string
homeDirxs:string
repositoryDirxs:string
typexs:string
versionxs:string
ElementTypeDescription
commandsService<spring:bean/>
jbiContainercontainer
properties<spring:bean/>

Element: installSharedLibrary

AttributeTypeDescription
artifactIdxs:string
deferExceptionxs:boolean
filexs:string
groupIdxs:string
homeDirxs:string
repositoryDirxs:string
typexs:string
versionxs:string
ElementTypeDescription
commandsService<spring:bean/>
jbiContainercontainer

Element: jcaFlow

AttributeTypeDescription
broadcastDestinationNamexs:stringReturns the Broadcast Destination Name for this flow
jmsURLxs:stringReturns the JMS URL for this flow
namexs:stringGet the name of the item
passwordxs:stringSet the password to use in JMS connections.
userNamexs:stringSets the userName to use in JMS connections.
ElementTypeDescription
connectionFactory<spring:bean/>Returns the ConnectionFactory for this flow
connectionManager<spring:bean/>

Element: jmsFlow

AttributeTypeDescription
broadcastDestinationNamexs:string
jmsURLxs:string
namexs:stringGet the name of the item
passwordxs:string
userNamexs:string
ElementTypeDescription
connectionFactory<spring:bean/>

Element: jmsFlowTibco

AttributeTypeDescription
broadcastDestinationNamexs:string
jmsURLxs:string
namexs:stringGet the name of the item
passwordxs:string
userNamexs:string
ElementTypeDescription
connectionFactory<spring:bean/>

Element: jmxConnector

AttributeTypeDescription
daemonxs:booleanSet whether any threads started for the JMXConnectorServer should be started as daemon threads.
objectNamexs:stringSet the ObjectName used to register the JMXConnectorServer itself with the MBeanServer.
registrationBehaviorxs:integerSpecify what action should be taken when attempting to register an MBean under an {@link javax.management.ObjectName} that already exists.

Default is REGISTRATION_FAIL_ON_EXISTING.

registrationBehaviorNamexs:stringSet the registration behavior by the name of the corresponding constant, e.g. "REGISTRATION_IGNORE_EXISTING".
serviceUrlxs:stringSet the service URL for the JMXConnectorServer.
threadedxs:booleanSet whether the JMXConnectorServer should be started in a separate thread.
ElementTypeDescription
environment<spring:bean/>Set the environment properties used to construct the JMXConnector as a Map of String keys and arbitrary Object values.
policyadminReadWritePolicy
server<spring:bean/>Specify the MBeanServer instance with which all beans should be registered. The MBeanExporter will attempt to locate an existing MBeanServer if none is supplied.

Element: jmxJaasAuthenticator

AttributeTypeDescription
domainxs:string
ElementTypeDescription
authenticationServiceauthenticationServiceThe authentication service can be used to customize the authentication mechanism used by this authenticator. It defaults to a JAASAuthenticationService which delegates calls to the JAAS layer.

Element: jmxPasswordAuthenticator

AttributeTypeDescription
passwordsxs:string

Element: jmxServer

AttributeTypeDescription
agentIdxs:string
defaultDomainxs:string
locateExistingServerIfPossiblexs:boolean
registerWithFactoryxs:boolean

Element: keystore

AttributeTypeDescription
keyPasswordsxs:string
keystorePasswordxs:string
namexs:string
pathxs:string

Element: keystoreManager

ElementTypeDescription
keystores(keystore)*

Element: logService

AttributeTypeDescription
autoStartxs:boolean
configUrlxs:stringset new location for log4j config
refreshPeriodxs:integer
ElementTypeDescription
containercontainer

Element: rmiRegistry

AttributeTypeDescription
createxs:boolean
locatexs:boolean
portxs:integer

Element: securedBroker

AttributeTypeDescription
flowNamesxs:string
subscriptionFlowNamexs:stringSet the subscription flow name
ElementTypeDescription
authorizationMapauthorizationMap
defaultFlowChooser<spring:bean/>
defaultInterfaceChooser<spring:bean/>Set the default EndpointChooser
defaultServiceChooser<spring:bean/>Set default EndpointChooser
flows(jcaFlow | jmsFlow | jmsFlowTibco | sedaFlow | stFlow)*Set the flow
subscriptionManager<spring:bean/>Sets the subscription manager

Element: sedaFlow

AttributeTypeDescription
namexs:stringGet the name of the item

Element: serviceunit

ElementTypeDescription
activationSpecs(activationSpec)*
components<spring:bean/>
endpoints<spring:bean/>
listeners(<spring:bean/>)*
services(dotViewService | logService | securedBroker | statistics)*

Element: stFlow

AttributeTypeDescription
namexs:stringGet the name of the item

Element: statistics

AttributeTypeDescription
dumpStatsxs:boolean
statsIntervalxs:long

Element: subscriptionSpec

AttributeTypeDescription
endpointxs:string
interfaceNamexs:QName
operationxs:QName
servicexs:QName
ElementTypeDescription
filter<spring:bean/>
name<spring:bean/>

Element: systemProperties

ElementTypeDescription
properties<spring:bean/>