org.jboss.seam.jms.bridge
Interface Route


public interface Route

Routing configuration between CDI and JMS.

Author:
Jordan Ganoff

Method Summary
 Route addAnnotatedParameter(javax.enterprise.inject.spi.AnnotatedParameter<?> ap)
           
 Route addDestinationJndiName(String jndi)
           
 Route addDestinationQualifiers(Set<Annotation> qualifiers)
           
 Route addDestinations(Collection<javax.jms.Destination> d)
          Adds a collection of destinations to this route.
 Route addDestinations(javax.jms.Destination... d)
          Add multiple destinations to this route
 Route addQualifiers(Annotation... qualifiers)
          Apply the qualifiers listed to this route.
 Route addQualifiers(Collection<Annotation> q)
          Apply the collection of qualifiers to this route.
 void build(javax.enterprise.inject.spi.BeanManager beanManager)
           
<D extends javax.jms.Destination>
Route
connectTo(Class<D> d, D destination)
          Connect this route to a destination.
 void disableEgress()
          Disables egress routing for this route.
 void disableIngress()
          Disables ingress routing for this route.
 void enableEgress()
          Enables egress routing for this route.
 void enableIngress()
          Enables ingress routing for this route.
 Set<javax.enterprise.inject.spi.AnnotatedParameter<?>> getAnnotatedParameters()
           
 Set<String> getDestinationJndiNames()
           
 List<Set<Annotation>> getDestinationQualifiers()
           
 Set<? extends javax.jms.Destination> getDestinations()
           
 String getId()
           
 Type getPayloadType()
           
 Set<Annotation> getQualifiers()
           
 RouteType getType()
           
 Route id(String id)
           
 boolean isEgressEnabled()
          Determines if this route is enabled for Egress routes.
 boolean isIngressEnabled()
          Determines if this route is enabled for ingress routes.
 void setDestinations(Collection<javax.jms.Destination> destinations)
           
 Route setType(Type type)
           
 boolean validate()
           
 

Method Detail

connectTo

<D extends javax.jms.Destination> Route connectTo(Class<D> d,
                                                  D destination)
Connect this route to a destination. Multiple destinations may be defined.

Type Parameters:
D - Destination type
Parameters:
d - Destination type (e.g. javax.jms.Topic)
destination - Destination to connect this route to
Returns:
this

addDestinations

Route addDestinations(javax.jms.Destination... d)
Add multiple destinations to this route

Parameters:
d - destinations to be added.
Returns:
this

addDestinations

Route addDestinations(Collection<javax.jms.Destination> d)
Adds a collection of destinations to this route.

Parameters:
d - Destinations to be added
Returns:
this

addQualifiers

Route addQualifiers(Annotation... qualifiers)
Apply the qualifiers listed to this route.

Parameters:
qualifiers - Qualifiers for the payload type
Returns:
this

addQualifiers

Route addQualifiers(Collection<Annotation> q)
Apply the collection of qualifiers to this route.

Parameters:
q - qualifiers to be added
Returns:
this

getType

RouteType getType()
Returns:
the routing type

getPayloadType

Type getPayloadType()
Returns:
the type this route routes

getQualifiers

Set<Annotation> getQualifiers()
Returns:
the qualifiers

getDestinations

Set<? extends javax.jms.Destination> getDestinations()
Returns:
The destinations involved in this routing

getDestinationJndiNames

Set<String> getDestinationJndiNames()

setDestinations

void setDestinations(Collection<javax.jms.Destination> destinations)

getDestinationQualifiers

List<Set<Annotation>> getDestinationQualifiers()

addDestinationQualifiers

Route addDestinationQualifiers(Set<Annotation> qualifiers)

addAnnotatedParameter

Route addAnnotatedParameter(javax.enterprise.inject.spi.AnnotatedParameter<?> ap)

getAnnotatedParameters

Set<javax.enterprise.inject.spi.AnnotatedParameter<?>> getAnnotatedParameters()

addDestinationJndiName

Route addDestinationJndiName(String jndi)

setType

Route setType(Type type)

validate

boolean validate()

build

void build(javax.enterprise.inject.spi.BeanManager beanManager)

id

Route id(String id)

getId

String getId()

isEgressEnabled

boolean isEgressEnabled()
Determines if this route is enabled for Egress routes. If the route is ingress, this returns false always.

Returns:
true if enabled for egress routes, else false.

isIngressEnabled

boolean isIngressEnabled()
Determines if this route is enabled for ingress routes. If the route is egress, this returns false always.

Returns:
true if enabled for ingress routes, else false.

disableEgress

void disableEgress()
Disables egress routing for this route.


enableEgress

void enableEgress()
Enables egress routing for this route. Ineffective if the route is ingress.


disableIngress

void disableIngress()
Disables ingress routing for this route.


enableIngress

void enableIngress()
Enables ingress routing for this route. Ineffective if the route is egress.



Copyright © 2011 Seam Framework. All Rights Reserved.