Package com.peterphi.std.guice.restclient.jaxb.webquery.plugin

Class WebQueryPresetPlugin

java.lang.Object

com.peterphi.std.guice.restclient.jaxb.webquery.plugin.WebQueryPresetPlugin

All Implemented Interfaces:

WebQueryDecodePlugin

public class WebQueryPresetPlugin
extends Object
implements WebQueryDecodePlugin

Simple WebQuery Decode Plugin that allows named presets for queries. Example usage:

new WebQueryPresetPlugin("preset")
                .withAllowMultiple(false) // Allow multiple presets to be specified in a single query
                .withFailIfUnsupported(true) // Throw an exception if an unsupported preset is used (the default)
                .withOption("running", q -> q.eq("state", "QUEUED", "RUNNING", "PAUSED"))
                .withOption("important", q -> q.ge("priority", "10"))
                .withOption("terminated", q -> q.eq("state", "FAILED", "SUCCESS", "CANCELLED"))

Nested Class Summary

Nested classes/interfaces inherited from interface com.peterphi.std.guice.restclient.jaxb.webquery.plugin.WebQueryDecodePlugin

WebQueryDecodePlugin.Builder

Constructor Summary

Constructors

Constructor	Description
WebQueryPresetPlugin(String keyName)

Method Summary

Modifier and Type	Method	Description
boolean	handles(String key)	Called before the native WebQuery.decode handles the provided key.
void	process(WebQuery query, String key, List<String> values)	Called to request that the plugin add the appropriate constraints to query
WebQueryPresetPlugin	withAllowMultiple(boolean value)
WebQueryPresetPlugin	withFailIfUnsupported(boolean value)
WebQueryPresetPlugin	withOption(String value, Consumer<WebQuery> handler)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.peterphi.std.guice.restclient.jaxb.webquery.plugin.WebQueryDecodePlugin

handles

Constructor Details

WebQueryPresetPlugin

public WebQueryPresetPlugin(String keyName)

Method Details

withFailIfUnsupported

public WebQueryPresetPlugin withFailIfUnsupported(boolean value)

withAllowMultiple

public WebQueryPresetPlugin withAllowMultiple(boolean value)

withOption

public WebQueryPresetPlugin withOption(String value,
 Consumer<WebQuery> handler)

handles

public boolean handles(String key)

Description copied from interface: WebQueryDecodePlugin

Called before the native WebQuery.decode handles the provided key. If this method returns true the plugin is responsible for decoding/processing the key. Simple convenience method so implementors do not need to implement WebQueryDecodePlugin.handles(String, List)

Specified by:

handles in interface WebQueryDecodePlugin

Parameters:

key - the query string key

Returns:

true if this plugin should handle the named key

process

public void process(WebQuery query,
 String key,
 List<String> values)

Description copied from interface: WebQueryDecodePlugin

Called to request that the plugin add the appropriate constraints to query

Specified by:

process in interface WebQueryDecodePlugin

Parameters:

query - the WebQuery being constructed

key - the key (which this object has previously indicated that it WebQueryDecodePlugin.handles(String))

values - the values provided at the query string