Package com.helixframework.rules.rule.rest

Class RestRule

java.lang.Object

com.helixframework.rules.rule.BaseRule

com.helixframework.rules.rule.rest.RestRule

All Implemented Interfaces:

Rule

public class RestRule
extends BaseRule

Rule that invokes a restful endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RestRule.Builder	Builds an instance of RestRule.

Field Summary

Fields inherited from interface com.helixframework.rules.rule.Rule

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
protected void	applyInternal(RuleContext ctx)	Applies the logic of the implementing rule and modifies the root object in the context.
protected <T> T	applyInternal(RuleContext<?> ctx, Class<T> outputType)	Applies the logic of the implementing rule and returns the result.
static RestRule.Builder	builder(String name, String url)	Builder for creating new instances of RestRule.
RuleType	getType()	Gets the type of rule.
String	getUrl()	Gets the url of the endpoint to call for the rule.
String	toString()

Methods inherited from class com.helixframework.rules.rule.BaseRule

apply, apply, apply, apply, getClassification, getDependencies, getDescription, getMaxRetries, getName, getTags, getTimeout

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RestRule.Builder builder(String name,
 String url)

Builder for creating new instances of RestRule.

Parameters:

name - rule name

url - rule endpoint url

Returns:

a RestRule.Builder

applyInternal

protected void applyInternal(RuleContext ctx)

Description copied from class: BaseRule

Applies the logic of the implementing rule and modifies the root object in the context.

Specified by:

applyInternal in class BaseRule

Parameters:

ctx - rule context

applyInternal

protected <T> T applyInternal(RuleContext<?> ctx,
 Class<T> outputType)

Description copied from class: BaseRule

Applies the logic of the implementing rule and returns the result.

Specified by:

applyInternal in class BaseRule

Type Parameters:

T - type of rule output

Parameters:

ctx - rule context

outputType - type of rule output

Returns:

rule result

getType

public RuleType getType()

Description copied from interface: Rule

Gets the type of rule.

Returns:

rule type

getUrl

public String getUrl()

Gets the url of the endpoint to call for the rule.

Returns:

rule url

toString

public String toString()

Overrides:

toString in class Object