Package org.spincast.plugins.routing

Class RedirectRuleBuilderDefault<R extends RequestContext<?>,W extends WebsocketContext<?>>

java.lang.Object

org.spincast.plugins.routing.RedirectRuleBuilderDefault<R,W>

All Implemented Interfaces:

RedirectRuleBuilder<R,W>

public class RedirectRuleBuilderDefault<R extends RequestContext<?>,W extends WebsocketContext<?>>
extends Object
implements RedirectRuleBuilder<R,W>

Default implementation for the RedirectRuleBuilder interface.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
RedirectRuleBuilderDefault(Router<R,W> router, String oldPath, SpincastRouterConfig spincastRouterConfig, SpincastRoutingUtils spincastRoutingUtils)

Method Summary

Modifier and Type	Method	Description
protected void	addRedirectHandler(Handler<R> handler)
protected String	getOldPath()
protected int	getPosition()
protected Router<R,W>	getRouter()
protected SpincastRouterConfig	getSpincastRouterConfig()
protected SpincastRoutingUtils	getSpincastRoutingUtils()
protected boolean	isPermanently()
RedirectRuleBuilder<R,W>	permanently()	The redirection will be permanent (301).
RedirectRuleBuilder<R,W>	pos(int position)	The position where the filter will be run.
RedirectRuleBuilder<R,W>	temporarily()	The redirection will be temporarily (302).
protected void	throwRedirect(R context, String newPathOrFullUrl)
void	to(String newPathOrFullUrl)	The new path or full URL to redirect to.
void	to(RedirectHandler<R,W> handler)	Will called the specified RedirectHandler to generate the path to redirect to.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected static final org.slf4j.Logger logger

Constructor Details

RedirectRuleBuilderDefault

public RedirectRuleBuilderDefault(Router<R,W> router,
 String oldPath,
 SpincastRouterConfig spincastRouterConfig,
 SpincastRoutingUtils spincastRoutingUtils)

Method Details

getRouter

protected Router<R,W> getRouter()

getOldPath

protected String getOldPath()

getSpincastRouterConfig

protected SpincastRouterConfig getSpincastRouterConfig()

getSpincastRoutingUtils

protected SpincastRoutingUtils getSpincastRoutingUtils()

isPermanently

protected boolean isPermanently()

getPosition

protected int getPosition()

permanently

public RedirectRuleBuilder<R,W> permanently()

Description copied from interface: RedirectRuleBuilder

The redirection will be permanent (301).

This is the default.

Specified by:

permanently in interface RedirectRuleBuilder<R extends RequestContext<?>,W extends WebsocketContext<?>>

temporarily

public RedirectRuleBuilder<R,W> temporarily()

Description copied from interface: RedirectRuleBuilder

The redirection will be temporarily (302).

Specified by:

temporarily in interface RedirectRuleBuilder<R extends RequestContext<?>,W extends WebsocketContext<?>>

to

public void to(String newPathOrFullUrl)

Description copied from interface: RedirectRuleBuilder

The new path or full URL to redirect to.

This ends the creation of the redirection rule and save it to the router.

Specified by:

to in interface RedirectRuleBuilder<R extends RequestContext<?>,W extends WebsocketContext<?>>

to

public void to(RedirectHandler<R,W> handler)

Description copied from interface: RedirectRuleBuilder

Will called the specified RedirectHandler to generate the path to redirect to.

This ends the creation of the redirection rule and save it to the router.

Specified by:

to in interface RedirectRuleBuilder<R extends RequestContext<?>,W extends WebsocketContext<?>>

pos

public RedirectRuleBuilder<R,W> pos(int position)

Description copied from interface: RedirectRuleBuilder

The position where the filter will be run.

By using a position below 0, the redirection will occures even if a main handler would be found.

Defaults to -1000.

Specified by:

pos in interface RedirectRuleBuilder<R extends RequestContext<?>,W extends WebsocketContext<?>>

addRedirectHandler

protected void addRedirectHandler(Handler<R> handler)

throwRedirect

protected void throwRedirect(R context,
 String newPathOrFullUrl)