io.knotx.knot

Class AbstractKnotProxy

java.lang.Object

io.knotx.knot.AbstractKnotProxy

All Implemented Interfaces:

KnotProxy

Direct Known Subclasses:

FragmentAssemblerKnotProxyImpl, FragmentSplitterKnotProxyImpl, GatewayKnotProxyImpl, ResponseProviderKnotProxyImpl

public abstract class AbstractKnotProxy
extends Object
implements KnotProxy

Abstract class that should be root for all custom knots

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_TRANSITION

Constructor Summary

Constructors

Constructor and Description
AbstractKnotProxy()

Method Summary

Modifier and Type	Method and Description
void	process(KnotContext knotContext, io.vertx.core.Handler<io.vertx.core.AsyncResult<KnotContext>> result)
protected abstract KnotContext	processError(KnotContext knotContext, Throwable error) Handles any Exception thrown during processing, and is responsible for preparing the proper KnotContext on such occasions, these will simply finish processing flows, as any error generated by a Knot will be immediately returned to the page visitor.
protected abstract io.reactivex.Single<KnotContext>	processRequest(KnotContext knotContext) Consumes a KnotContext messages from the Server and returns modified, processed context.
protected boolean	shouldProcess(Fragment fragment) Method lets you decide whether the Fragment should be processed by your Knot or not.
protected abstract boolean	shouldProcess(Set<String> knots) Method lets you decide whether the Fragment with a given set of Knots should be processed by your Knot or not

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.knotx.proxy.KnotProxy

createProxy, createProxyWithOptions

Field Detail

DEFAULT_TRANSITION

protected static final String DEFAULT_TRANSITION

See Also:

Constant Field Values

Constructor Detail

AbstractKnotProxy

public AbstractKnotProxy()

Method Detail

process

public void process(KnotContext knotContext,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<KnotContext>> result)

Specified by:

process in interface KnotProxy

processRequest

protected abstract io.reactivex.Single<KnotContext> processRequest(KnotContext knotContext)

Consumes a KnotContext messages from the Server and returns modified, processed context. Basically this method is responsible for the whole business logic that your Knot will be performing.

Parameters:

knotContext - message from the Server with processing context.

Returns:

a Single that emits a processed and modified KnotContext.

shouldProcess

protected boolean shouldProcess(Fragment fragment)

Method lets you decide whether the Fragment should be processed by your Knot or not.

Parameters:

fragment - Fragment to process - or skip Fragment.

Returns:

true if this Knot should process current Fragment.

shouldProcess

protected abstract boolean shouldProcess(Set<String> knots)

Method lets you decide whether the Fragment with a given set of Knots should be processed by your Knot or not

Parameters:

knots - set of all Knots names that occurred in the current KnotContext.

Returns:

true if this Knot should process current KnotContext.

processError

protected abstract KnotContext processError(KnotContext knotContext,
                                            Throwable error)

Handles any Exception thrown during processing, and is responsible for preparing the proper KnotContext on such occasions, these will simply finish processing flows, as any error generated by a Knot will be immediately returned to the page visitor.

Parameters:

knotContext - current context.

error - the error that just occurred.

Returns:

context prepared with proper content that notifies about the error and incorrect processing.