io.higgs.http.server

Class Transcription

java.lang.Object

io.higgs.http.server.Transcription

All Implemented Interfaces:

Sortable<Transcription>, Comparable<Transcription>

public class Transcription
extends Object
implements Sortable<Transcription>

A Transcription defines a set of actions that can be performed on a request given a predefined premise is true.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	priority

Constructor Summary

Constructors

Constructor and Description
Transcription(Pattern pattern, String replaceWith)
Transcription(Pattern regex, String replaceWith, boolean replaceEntirePath, boolean firstOccurrenceOnly) Convenience method which creates a Transcription with a Pattern criteria.
Transcription(String regex, String replaceWith) Replaces/re-writes the entire request path with the given replacement
Transcription(String regex, String replaceWith, boolean replaceEntirePath) Rewrites/replaced a request based on the provided options

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Transcription that)
boolean	equals(Object o)
long	getCreatedAt()
Pattern	getPattern()
String	getReplacementPath()
int	hashCode()
boolean	isReplaceFirstOccurrence()
boolean	isReplaceWholeRequest()
boolean	matches(String uri)
int	priority()
String	replaceAllMatches(String uri)
String	replaceFirstMatch(String uri)
void	setPattern(Pattern pattern)
int	setPriority(int value)
void	setReplaceFirstOccurrence(boolean firstOccurrenceOnly)
void	setReplacementPath(String replaceWith)
void	setReplaceWholeRequest(boolean replace)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

priority

protected int priority

Constructor Detail

Transcription

public Transcription(String regex,
             String replaceWith,
             boolean replaceEntirePath)

Rewrites/replaced a request based on the provided options

Parameters:

regex - a regex to match

replaceWith - a replacement string to be used to replace matches

replaceEntirePath - if true the request's entire path is replaced with the replacement string

Transcription

public Transcription(Pattern regex,
             String replaceWith,
             boolean replaceEntirePath,
             boolean firstOccurrenceOnly)

Convenience method which creates a Transcription with a Pattern criteria. if an HTTP request's path pattern the given regex, replace all occurrences with the provided alternative

Parameters:

regex - the regex to use for search

replaceWith - the string to replace it with if it begins with the startsWith param

replaceEntirePath - if true then the entire request path is replace, otherwise only the startWith portion is replaced from the start of the string

firstOccurrenceOnly - if true only the first occurrence of the pattern is replaced/re-written

Transcription

public Transcription(String regex,
             String replaceWith)

Replaces/re-writes the entire request path with the given replacement

Parameters:

regex - the regex to match

replaceWith - the string to replace with

Transcription

public Transcription(Pattern pattern,
             String replaceWith)

Method Detail

getCreatedAt

public long getCreatedAt()

getPattern

public Pattern getPattern()

setPattern

public void setPattern(Pattern pattern)

matches

public boolean matches(String uri)

isReplaceWholeRequest

public boolean isReplaceWholeRequest()

setReplaceWholeRequest

public void setReplaceWholeRequest(boolean replace)

replaceAllMatches

public String replaceAllMatches(String uri)

getReplacementPath

public String getReplacementPath()

setReplacementPath

public void setReplacementPath(String replaceWith)

replaceFirstMatch

public String replaceFirstMatch(String uri)

isReplaceFirstOccurrence

public boolean isReplaceFirstOccurrence()

setReplaceFirstOccurrence

public void setReplaceFirstOccurrence(boolean firstOccurrenceOnly)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

setPriority

public int setPriority(int value)

Specified by:

setPriority in interface Sortable<Transcription>

priority

public int priority()

Specified by:

priority in interface Sortable<Transcription>

compareTo

public int compareTo(Transcription that)

Specified by:

compareTo in interface Comparable<Transcription>