io.jmix.ui.sys

Class LinkHandler

java.lang.Object

io.jmix.ui.sys.LinkHandler

@Component(value="ui_LinkHandler")
 @Scope(value="prototype")
public class LinkHandler
extends java.lang.Object

Handles links from outside of the application.
This bean is used particularly when a request URL contains one of UiProperties.getLinkHandlerActions() actions.
The bean traverses all implementations of LinkHandlerProcessor by their priority and gives control to first possible to handle processor.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	action
protected App	app
protected java.util.List<LinkHandlerProcessor>	processors
protected java.util.Map<java.lang.String,java.lang.String>	requestParams

Constructor Summary

Constructors

Constructor and Description
LinkHandler(App app, java.lang.String action, java.util.Map<java.lang.String,java.lang.String> requestParams)

Method Summary

Modifier and Type	Method and Description
boolean	canHandleLink() Check state of LinkHandler and application.
void	handle() Called to handle the link.

Methods inherited from class java.lang.Object

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

Field Detail

processors

@Autowired
protected java.util.List<LinkHandlerProcessor> processors

app

protected App app

action

protected java.lang.String action

requestParams

protected java.util.Map<java.lang.String,java.lang.String> requestParams

Constructor Detail

LinkHandler

public LinkHandler(App app,
                   java.lang.String action,
                   java.util.Map<java.lang.String,java.lang.String> requestParams)

Method Detail

canHandleLink

public boolean canHandleLink()

Check state of LinkHandler and application.

Returns:

true if application and LinkHandler in an appropriate state.

handle

public void handle()

Called to handle the link.