com.adaptris.core.http.jetty

Class JettyRouteSpec

java.lang.Object

com.adaptris.core.http.jetty.JettyRouteSpec

All Implemented Interfaces:

ComponentLifecycle

public class JettyRouteSpec
extends java.lang.Object
implements ComponentLifecycle

Used with JettyRoutingService to help decide which branch to execute.

Since the URI itself may contain parameters that may need to be extracted as metadata, it is possible to do that as part of the matching process here. Given a URL of /record/zeus/apollo the following configuration will match provided the HTTP method is POST; the URL pattern will be parsed for capturing groups and the metadata parentId=zeus, childId=apollo will be set; the next service-id will be set to handleInsert.

   
      <jetty-route-spec>
        <condition>
          <url-pattern>^/record/(.*)/(.*)$</url-pattern>
          <method>POST</method>
          <metadata-key>parentId</metadata-key>
          <metadata-key>childId</metadata-key>
        </condition>
        <service-id>handleInsert</service-id>
      </jetty-route-spec>
   
 

You could achieve the same effect with a ExtractMetadataService as part of your normal service execution chain.

Constructor Summary

Constructors

Constructor and Description
JettyRouteSpec()
JettyRouteSpec(java.lang.String urlPattern, java.lang.String method, java.util.List<java.lang.String> keys, java.lang.String serviceId) Deprecated.

Method Summary

Modifier and Type	Method and Description
JettyRouteCondition.JettyRoute	build(java.lang.String method, java.lang.String uri)
void	close() Closes the component.
JettyRouteCondition	getCondition()
java.util.List<java.lang.String>	getMetadataKeys() Deprecated. since 3.9.0 use a condition instead
java.lang.String	getMethod() Deprecated. since 3.9.0 use a condition instead
java.lang.String	getServiceId()
java.lang.String	getUrlPattern() Deprecated. since 3.9.0 use a condition instead
void	init() Initialises the component.
void	setCondition(JettyRouteCondition condition) Specify the conditions for the route.
void	setMetadataKeys(java.util.List<java.lang.String> s) Deprecated. since 3.9.0 use a condition instead
void	setMethod(java.lang.String method) Deprecated. since 3.9.0 use a condition instead
void	setServiceId(java.lang.String serviceId) Set the service-id that will be used if the route matches.
void	setUrlPattern(java.lang.String urlPattern) Deprecated. since 3.9.0 use a condition instead
void	start() Starts the component.
void	stop() Stop the component
java.lang.String	toString()
JettyRouteSpec	withCondition(JettyRouteCondition condition)
JettyRouteSpec	withServiceId(java.lang.String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JettyRouteSpec

public JettyRouteSpec()

JettyRouteSpec

@Deprecated
public JettyRouteSpec(java.lang.String urlPattern,
                                  java.lang.String method,
                                  java.util.List<java.lang.String> keys,
                                  java.lang.String serviceId)

Deprecated.

Method Detail

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

Specified by:

close in interface ComponentLifecycle

getUrlPattern

@Deprecated
 @ConfigDeprecated(removalVersion="4.0.0",
                  message="Use a condition instead",
                  groups=java.lang.Deprecated.class)
public java.lang.String getUrlPattern()

Deprecated. since 3.9.0 use a condition instead

setUrlPattern

@Deprecated
 @Removal(version="4.0.0",
         message="Use a condition instead")
public void setUrlPattern(java.lang.String urlPattern)

Deprecated. since 3.9.0 use a condition instead

Set the URL pattern that you want to match against.

Parameters:

urlPattern - the pattern.

getMethod

@Deprecated
 @ConfigDeprecated(removalVersion="4.0.0",
                  message="Use a condition instead",
                  groups=java.lang.Deprecated.class)
public java.lang.String getMethod()

Deprecated. since 3.9.0 use a condition instead

setMethod

@Deprecated
 @Removal(version="4.0.0",
         message="Use a condition instead")
public void setMethod(java.lang.String method)

Deprecated. since 3.9.0 use a condition instead

Specify a method to match against (optional).

getMetadataKeys

@Deprecated
 @ConfigDeprecated(removalVersion="4.0.0",
                  message="Use a condition instead",
                  groups=java.lang.Deprecated.class)
public java.util.List<java.lang.String> getMetadataKeys()

Deprecated. since 3.9.0 use a condition instead

setMetadataKeys

@Deprecated
 @Removal(version="4.0.0",
         message="Use a condition instead")
public void setMetadataKeys(java.util.List<java.lang.String> s)

Deprecated. since 3.9.0 use a condition instead

Specify the metadata that should be populated based on any captured groups in your url pattern.

The list of keys is processed in order, against each capturing match group in order

Parameters:

s - list of keys.

getServiceId

public java.lang.String getServiceId()

setServiceId

public void setServiceId(java.lang.String serviceId)

Set the service-id that will be used if the route matches.

withServiceId

public JettyRouteSpec withServiceId(java.lang.String s)

getCondition

public JettyRouteCondition getCondition()

setCondition

public void setCondition(JettyRouteCondition condition)

Specify the conditions for the route.

Parameters:

condition - the condition.

withCondition

public JettyRouteSpec withCondition(JettyRouteCondition condition)

build

public JettyRouteCondition.JettyRoute build(java.lang.String method,
                                            java.lang.String uri)
                                     throws CoreException

Throws:

CoreException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object