com.adaptris.core.services.routing

Interface SyntaxIdentifier

All Known Implementing Classes:

AlwaysMatchSyntaxIdentifier, RegexpSyntaxIdentifier, SyntaxIdentifierImpl, XmlSyntaxIdentifierImpl, XpathNodeIdentifier, XpathSyntaxIdentifier

public interface SyntaxIdentifier

Interface used by SyntaxRoutingService.

The contract for this interface is such that isThisSyntax(String) should only return true, if and only if ALL the configured patterns are matched within the document.

See Also:

SyntaxRoutingService

Method Summary

Modifier and Type	Method and Description
void	addPattern(java.lang.String pattern) Add a pattern to the list of configured patterns used to match a document.
java.lang.String	getDestination() Get the configured destination.
java.util.List<java.lang.String>	getPatterns() Get a list of configured patterns.
boolean	isThisSyntax(java.lang.String message) Determine if this SyntaxIdentifer considers the message to match all the configured patterns.
void	setDestination(java.lang.String dest) Set the configured destination.
void	setPatterns(java.util.List<java.lang.String> l) Set a list of configured patterns.

Method Detail

setDestination

void setDestination(java.lang.String dest)

Set the configured destination.

This is the value that will be stored against the metadata key specified by SyntaxRoutingService.

Parameters:

dest - the destination.

getDestination

java.lang.String getDestination()

Get the configured destination.

Returns:

the destination.

addPattern

void addPattern(java.lang.String pattern)
         throws ServiceException

Add a pattern to the list of configured patterns used to match a document.

Parameters:

pattern - a pattern.

Throws:

ServiceException - if the pattern could not be added.

getPatterns

java.util.List<java.lang.String> getPatterns()

Get a list of configured patterns.

Returns:

the list.

setPatterns

void setPatterns(java.util.List<java.lang.String> l)

Set a list of configured patterns.

Parameters:

l - the list.

isThisSyntax

boolean isThisSyntax(java.lang.String message)
              throws ServiceException

Determine if this SyntaxIdentifer considers the message to match all the configured patterns.

Parameters:

message - the message to identify against.

Returns:

true if it matches.

Throws:

ServiceException - if there was an error with the pattern.