io.knotx.server.configuration

Class RoutingEntry

java.lang.Object

io.knotx.server.configuration.RoutingEntry

public class RoutingEntry
extends Object

Describes a routing entry of Knot.x Server

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CSRF_ENABLED

Constructor Summary

Constructors

Constructor and Description
RoutingEntry() Default constructor
RoutingEntry(io.vertx.core.json.JsonObject json) Create an settings from JSON
RoutingEntry(RoutingEntry other) Copy constructor

Method Summary

Modifier and Type	Method and Description
String	getAddress()
Map<String,RoutingEntry>	getOnTransition()
String	getPath()
boolean	isCsrf()
RoutingEntry	setAddress(String address) Sets the event bus address of the Knot that should process the request for a given path
RoutingEntry	setCsrf(boolean csrfEnabled) Enables/Disabled CSRF support for a given routing entry
RoutingEntry	setOnTransition(Map<String,RoutingEntry> onTransition) Describes routing to addresses of other Knots based on the transition trigger returned from current Knot.
RoutingEntry	setPath(String path) Sets the Regular expression of HTTP Request path
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CSRF_ENABLED

public static final boolean DEFAULT_CSRF_ENABLED

See Also:

Constant Field Values

Constructor Detail

RoutingEntry

public RoutingEntry()

Default constructor

RoutingEntry

public RoutingEntry(RoutingEntry other)

Copy constructor

Parameters:

other - the instance to copy

RoutingEntry

public RoutingEntry(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

getPath

public String getPath()

Returns:

Regular expression of HTTP Request path

setPath

public RoutingEntry setPath(String path)

Sets the Regular expression of HTTP Request path

Parameters:

path - a string with Regexp

Returns:

a reference to this, so the API can be used fluently

isCsrf

public boolean isCsrf()

Returns:

true if CSRF is enabled for this entry

setCsrf

public RoutingEntry setCsrf(boolean csrfEnabled)

Enables/Disabled CSRF support for a given routing entry

Parameters:

csrfEnabled - true if enabled

Returns:

a reference to this, so the API can be used fluently

getAddress

public String getAddress()

Returns:

event bus address of the Knot that should process the request for a given path

setAddress

public RoutingEntry setAddress(String address)

Sets the event bus address of the Knot that should process the request for a given path

Parameters:

address - a string

Returns:

a reference to this, so the API can be used fluently

getOnTransition

public Map<String,RoutingEntry> getOnTransition()

Returns:

a transition mapping

setOnTransition

public RoutingEntry setOnTransition(Map<String,RoutingEntry> onTransition)

Describes routing to addresses of other Knots based on the transition trigger returned from current Knot. "onTransition": { "go-a": {}, "go-b": {} }

Parameters:

onTransition - a map of String-RoutingEntry

Returns:

a reference to this, so the API can be used fluently