io.warp10.script.ext.urlfetch

Class UrlFetchWarpScriptExtension

java.lang.Object

io.warp10.warp.sdk.WarpScriptExtension

io.warp10.script.ext.urlfetch.UrlFetchWarpScriptExtension

public class UrlFetchWarpScriptExtension
extends WarpScriptExtension

Extension for URLFETCH and the associated function to change limits: MAXURLFETCHCOUNT and MAXURLFETCHSIZE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_URLFETCH_COUNT Number of calls to URLFETCH so far in the sessions
static java.lang.String	ATTRIBUTE_URLFETCH_LIMIT Maximum number of calls to URLFETCH in a session
static java.lang.String	ATTRIBUTE_URLFETCH_LIMIT_HARD
static java.lang.String	ATTRIBUTE_URLFETCH_MAXSIZE Maximum cumulative size of content retrieved via calls to URLFETCH in a session
static java.lang.String	ATTRIBUTE_URLFETCH_MAXSIZE_HARD
static java.lang.String	ATTRIBUTE_URLFETCH_SIZE Current URLFETCH so far in the sessions
static long	DEFAULT_URLFETCH_LIMIT
static long	DEFAULT_URLFETCH_MAXSIZE
static java.lang.String	WARPSCRIPT_URLFETCH_HOST_PATTERNS Allowed and excluded host patterns.
static java.lang.String	WARPSCRIPT_URLFETCH_LIMIT Maximum number of calls to URLFETCH in a session
static java.lang.String	WARPSCRIPT_URLFETCH_LIMIT_HARD
static java.lang.String	WARPSCRIPT_URLFETCH_MAXSIZE Maximum cumulative size of content retrieved via calls to URLFETCH in a session
static java.lang.String	WARPSCRIPT_URLFETCH_MAXSIZE_HARD

Constructor Summary

Constructors

Constructor and Description
UrlFetchWarpScriptExtension()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getFunctions() Return a map of function name to actual function.
static java.lang.Long	getLongAttribute(WarpScriptStack stack, java.lang.String attribute) Get the value of the attribute in the stack, if not present get the value in the configuration and it not present either, get the default value.

Methods inherited from class io.warp10.warp.sdk.WarpScriptExtension

register, wrapMacro

Methods inherited from class java.lang.Object

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

Field Detail

WARPSCRIPT_URLFETCH_LIMIT

public static final java.lang.String WARPSCRIPT_URLFETCH_LIMIT

Maximum number of calls to URLFETCH in a session

See Also:

Constant Field Values

WARPSCRIPT_URLFETCH_LIMIT_HARD

public static final java.lang.String WARPSCRIPT_URLFETCH_LIMIT_HARD

See Also:

Constant Field Values

WARPSCRIPT_URLFETCH_MAXSIZE

public static final java.lang.String WARPSCRIPT_URLFETCH_MAXSIZE

Maximum cumulative size of content retrieved via calls to URLFETCH in a session

See Also:

Constant Field Values

WARPSCRIPT_URLFETCH_MAXSIZE_HARD

public static final java.lang.String WARPSCRIPT_URLFETCH_MAXSIZE_HARD

See Also:

Constant Field Values

WARPSCRIPT_URLFETCH_HOST_PATTERNS

public static final java.lang.String WARPSCRIPT_URLFETCH_HOST_PATTERNS

Allowed and excluded host patterns.

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_LIMIT

public static final java.lang.String ATTRIBUTE_URLFETCH_LIMIT

Maximum number of calls to URLFETCH in a session

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_LIMIT_HARD

public static final java.lang.String ATTRIBUTE_URLFETCH_LIMIT_HARD

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_COUNT

public static final java.lang.String ATTRIBUTE_URLFETCH_COUNT

Number of calls to URLFETCH so far in the sessions

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_MAXSIZE

public static final java.lang.String ATTRIBUTE_URLFETCH_MAXSIZE

Maximum cumulative size of content retrieved via calls to URLFETCH in a session

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_MAXSIZE_HARD

public static final java.lang.String ATTRIBUTE_URLFETCH_MAXSIZE_HARD

See Also:

Constant Field Values

ATTRIBUTE_URLFETCH_SIZE

public static final java.lang.String ATTRIBUTE_URLFETCH_SIZE

Current URLFETCH so far in the sessions

See Also:

Constant Field Values

DEFAULT_URLFETCH_LIMIT

public static final long DEFAULT_URLFETCH_LIMIT

See Also:

Constant Field Values

DEFAULT_URLFETCH_MAXSIZE

public static final long DEFAULT_URLFETCH_MAXSIZE

See Also:

Constant Field Values

Constructor Detail

UrlFetchWarpScriptExtension

public UrlFetchWarpScriptExtension()

Method Detail

getFunctions

public java.util.Map<java.lang.String,java.lang.Object> getFunctions()

Description copied from class: WarpScriptExtension

Return a map of function name to actual function. If a function should be removed from WarpScriptLib, simply associate null as the value.

Specified by:

getFunctions in class WarpScriptExtension

getLongAttribute

public static java.lang.Long getLongAttribute(WarpScriptStack stack,
                                              java.lang.String attribute)

Get the value of the attribute in the stack, if not present get the value in the configuration and it not present either, get the default value. Also set the attribute in the stack once the value is found.

Parameters:

stack - The stack the get the attribute from, if present.

attribute - The attribute name to get.

Returns:

The first available value in the list: attribute value, configuration value, default.