Module io.avaje.jex

Package io.avaje.jex

Interface Routing

public interface Routing

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Routing.Entry	A routing entry.
static interface	Routing.Group	A group of routing entries prefixed by a common path.
static interface	Routing.Service	Adds to the Routing.
static class	Routing.Type	The type of route entry.

Method Summary

Modifier and Type	Method	Description
Routing	add(Routing.Service routes)	Add the routes provided by the Routing Service.
Routing	addAll(Collection<Routing.Service> routes)	Add all the routes provided by the Routing Services.
Routing	after(Handler handler)	Add an after filter for all requests.
Routing	after(String path, Handler handler)	Add a after filter for the given path.
List<Routing.Entry>	all()	Return all the registered handlers.
Routing	before(Handler handler)	Add a before filter for all requests.
Routing	before(String path, Handler handler)	Add a before filter for the given path.
Routing	delete(Handler handler)	Add a DELETE handler for "/".
Routing	delete(String path, Handler handler)	Add a DELETE handler.
Routing	get(Handler handler)	Add a GET handler for "/".
Routing	get(String path, Handler handler)	Add a GET handler.
Routing	head(Handler handler)	Add a HEAD handler for "/".
Routing	head(String path, Handler handler)	Add a HEAD handler.
Routing	patch(Handler handler)	Add a PATCH handler for "/".
Routing	patch(String path, Handler handler)	Add a PATCH handler.
Routing	path(String path, Routing.Group group)	Add a group of route handlers with a common path prefix.
Routing	post(Handler handler)	Add a POST handler for "/".
Routing	post(String path, Handler handler)	Add a POST handler.
Routing	put(Handler handler)	Add a PUT handler for "/".
Routing	put(String path, Handler handler)	Add a PUT handler.
Routing	trace(Handler handler)	Add a TRACE handler for "/".
Routing	trace(String path, Handler handler)	Add a TRACE handler.
Routing	withRoles(Role... permittedRoles)	Specify permittedRoles for the last added handler using varargs.
Routing	withRoles(Set<Role> permittedRoles)	Specify permittedRoles for the last added handler.

Method Details

add

Routing add(Routing.Service routes)

Add the routes provided by the Routing Service.

addAll

Routing addAll(Collection<Routing.Service> routes)

Add all the routes provided by the Routing Services.

withRoles

Routing withRoles(Set<Role> permittedRoles)

Specify permittedRoles for the last added handler.

  routing
  .get("/customers", getHandler).withRoles(readRoles)
  .post("/customers", postHandler).withRoles(writeRoles)
  ...

 

Parameters:

permittedRoles - The permitted roles required for the last handler

withRoles

Routing withRoles(Role... permittedRoles)

Specify permittedRoles for the last added handler using varargs.

  routing
  .get("/customers", getHandler).withRoles(ADMIN, USER)
  .post("/customers", postHandler).withRoles(ADMIN)
  ...

 

Parameters:

permittedRoles - The permitted roles required for the last handler

path

Routing path(String path,
Routing.Group group)

Add a group of route handlers with a common path prefix.

head

Routing head(String path,
Handler handler)

Add a HEAD handler.

head

Routing head(Handler handler)

Add a HEAD handler for "/".

get

Routing get(String path,
Handler handler)

Add a GET handler.

get

Routing get(Handler handler)

Add a GET handler for "/".

post

Routing post(String path,
Handler handler)

Add a POST handler.

post

Routing post(Handler handler)

Add a POST handler for "/".

put

Routing put(String path,
Handler handler)

Add a PUT handler.

put

Routing put(Handler handler)

Add a PUT handler for "/".

patch

Routing patch(String path,
Handler handler)

Add a PATCH handler.

patch

Routing patch(Handler handler)

Add a PATCH handler for "/".

delete

Routing delete(String path,
Handler handler)

Add a DELETE handler.

delete

Routing delete(Handler handler)

Add a DELETE handler for "/".

trace

Routing trace(String path,
Handler handler)

Add a TRACE handler.

trace

Routing trace(Handler handler)

Add a TRACE handler for "/".

before

Routing before(String path,
Handler handler)

Add a before filter for the given path.

before

Routing before(Handler handler)

Add a before filter for all requests.

after

Routing after(String path,
Handler handler)

Add a after filter for the given path.

after

Routing after(Handler handler)

Add an after filter for all requests.

all

List<Routing.Entry> all()

Return all the registered handlers.