| Overview | Package | Class | Deprecated | Help |
A separate route manager must be created for each application. This allows for separate sets of managed routes for different applications. JMS events may be filtered by application.
The OSS application is responsible for creating the route manager
using the regular generic.GenericObject.configureChildInstance
method using the topology.TopologyManager singleton as the
parent.
The route manager and its set of managed routes are persisted. The paths of the managed route are not persisted.
| Properties | |
|---|---|
| applicationName |
The system-wide unique application name used to
identify a specific OSS application.
Only the characters a-z, A-Z, 0-9, and _ are allowed in the name.
type=string access=read-create minimum=1 maximum=32 Mandatory on create Displayed(tab/group)=Application Name |
| managedRoutes |
The set of topology.RouteSet that are currently
being managed for this application.
type=Set (topology.RouteKey)access=read-only |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
topology.RouteKey).
Changes to the managed routes are then no longer notified.
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
routeKeySet
: Set (topology.RouteKey) - The set of route keys to deregister.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: falsetopology.RouteKey) to be rebuilt.
Changes to the managed routes are then notified as they happen.
Note only registered routes will be rebuilt. An unregistered route
keys passed in will simply be ignored.
instanceFullName
: string - the full name of the object.
routeKeySet
: Set (topology.RouteKey) - The set of route keys to rebuild.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: falsetopology.RouteKey).
Changes to the managed routes are then notified as they happen.
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
routeKeySet
: Set (topology.RouteKey) - The set of route keys to register.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
instanceFullName
: string - the full name of the object.
routeKeySet
: Set (topology.RouteKey) - The set of routes, managed by this application, whose
current paths must be retrieved.
resultFilter
: ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
result
: Map (topology.RouteKey to topology.RouteResult) - A map of the topology.RouteKey to a
RouteResult.