java.lang.Object
- org.forgerock.openig.types.importer.RouteInstance

```
public class RouteInstance
extends Object
```
A RouteInstance describes a route with all of its internal components, all linked together.
It provides accessors to the main component instances of this route (handler, session, ...) plus give access to the route's model and internal supporting route component instance.

Constructor Summary

Constructors
Constructor Description

RouteInstance(org.forgerock.openig.model.component.Model model, String routeId)
Constructs a new RouteInstance with the given model.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.forgerock.openig.model.component.ComponentInstance`	`auditService()`	Returns the component instance of the AuditService of this route.
`RouteInstance`	`auditService(org.forgerock.openig.model.component.ComponentInstance auditService)`	Sets the component instance supporting the AuditService of this route.
`Expression<Boolean>`	`condition()`	Returns the condition expression of this route.
`RouteInstance`	`condition(Expression<Boolean> condition)`	Sets the condition expression that describes what requests are accepted by this route.
`org.forgerock.openig.model.component.ComponentInstance`	`handler()`	Returns the component instance of the main handler of this route.
`RouteInstance`	`handler(org.forgerock.openig.model.component.ComponentInstance handler)`	Sets the component instance supporting the main handler of this route.
`org.forgerock.openig.model.component.Model`	`model()`	Returns the underlying route's model.
`String`	`name()`	Returns the name of this route.
`RouteInstance`	`name(String name)`	Sets the name of this route.
`org.forgerock.openig.model.component.ComponentInstance`	`route()`	Returns the underlying route's component instance.
`RouteInstance`	`route(org.forgerock.openig.model.component.ComponentInstance route)`	Sets the component instance supporting this route.
`String`	`routeId()`	Returns the route identifier.
`org.forgerock.openig.model.component.ComponentInstance`	`session()`	Returns the component instance of the SessionManager of this route.
`RouteInstance`	`session(org.forgerock.openig.model.component.ComponentInstance session)`	Sets the component instance supporting the SessionManager of this route.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RouteInstance
```
public RouteInstance(org.forgerock.openig.model.component.Model model,
                     String routeId)
```
    Constructs a new RouteInstance with the given model.
    
    Parameters:
    
    model - underlying model (never null)
    
    routeId - route identifier (never null or blank)
- Method Detail
  - model
```
public org.forgerock.openig.model.component.Model model()
```
    Returns the underlying route's model.
    
    Returns:
    
    the underlying route's model (never null)
  - routeId
```
public String routeId()
```
    Returns the route identifier.
    
    Returns:
    
    the route identifier (never null or blank)
  - route
```
public RouteInstance route(org.forgerock.openig.model.component.ComponentInstance route)
```
    Sets the component instance supporting this route.
    
    Parameters:
    
    route - the component instance supporting this route (never {code null})
    
    Returns:
    
    this route model
  - route
```
public org.forgerock.openig.model.component.ComponentInstance route()
```
    Returns the underlying route's component instance.
    
    Returns:
    
    the underlying route's component instance (never null)
  - handler
```
public RouteInstance handler(org.forgerock.openig.model.component.ComponentInstance handler)
```
    Sets the component instance supporting the main handler of this route.
    
    Parameters:
    
    handler - the component instance supporting the main handler of this route (never {code null})
    
    Returns:
    
    this route model
  - handler
```
public org.forgerock.openig.model.component.ComponentInstance handler()
```
    Returns the component instance of the main handler of this route.
    
    Returns:
    
    the component instance of the main handler of this route (never null)
  - name
```
public RouteInstance name(String name)
```
    Sets the name of this route.
    
    Parameters:
    
    name - this route's name (cannot be null)
    
    Returns:
    
    this route model
  - name
```
public String name()
```
    Returns the name of this route.
    
    Returns:
    
    the name of this route (never null)
  - condition
```
public RouteInstance condition(Expression<Boolean> condition)
```
    Sets the condition expression that describes what requests are accepted by this route.
    
    Parameters:
    
    condition - this route's condition (cannot be null)
    
    Returns:
    
    this route model
  - condition
```
public Expression<Boolean> condition()
```
    Returns the condition expression of this route.
    
    Returns:
    
    the condition expression of this route (never null)
  - session
```
public RouteInstance session(org.forgerock.openig.model.component.ComponentInstance session)
```
    Sets the component instance supporting the SessionManager of this route.
    
    Parameters:
    
    session - the component instance supporting the SessionManager of this route
    
    Returns:
    
    this route model
  - session
```
public org.forgerock.openig.model.component.ComponentInstance session()
```
    Returns the component instance of the SessionManager of this route.
    
    Returns:
    
    the component instance of the SessionManager of this route
  - auditService
```
public RouteInstance auditService(org.forgerock.openig.model.component.ComponentInstance auditService)
```
    Sets the component instance supporting the AuditService of this route.
    
    Parameters:
    
    auditService - the component instance supporting the AuditService of this route
    
    Returns:
    
    this route model
  - auditService
```
public org.forgerock.openig.model.component.ComponentInstance auditService()
```
    Returns the component instance of the AuditService of this route.
    
    Returns:
    
    the component instance of the AuditService of this route

Class RouteInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouteInstance

Method Detail

model

routeId

route

route

handler

handler

name

name

condition

condition

session

session

auditService

auditService