io.toro.martini

Class ThrottlingMethods

java.lang.Object

io.toro.martini.ThrottlingMethods

public final class ThrottlingMethods
extends Object

This class provides one-liner methods for managing and listing Throttling Rules.

Method Summary

Modifier and Type	Method and Description
static void	deleteThrottlingRule(String name) Deletes the Throttling Rule with a given name.
static void	disableThrottlingRule(String name) Disables the Throttling Rule with a given name.
static void	enableThrottlingRule(String name) Enables the Throttling Rule with a given name.
static io.toro.gloop.object.property.GloopModel	getThrottlingRule(String name) Gets the Throttling Rule with a given name.
static io.toro.gloop.object.property.GloopModel	getThrottlingRules() Gets the list of all the Throttling Rules.
static io.toro.gloop.object.property.GloopModel	getThrottlingRules(boolean enabled) Gets the list of all the Throttling Rules.
static io.toro.gloop.object.property.GloopModel	getThrottlingRules(int page, int size, Boolean enabled) Gets the list of matching Throttling Rules.
static void	saveThrottlingRule(io.toro.gloop.object.property.GloopModel rule) Saves the given Throttling Rule.

Methods inherited from class java.lang.Object

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

Method Detail

getThrottlingRule

@GloopObjectParameter(value="throttlingRuleMetadata{\nthrottlingRuleMetadata#io.toro.martini.throttling.ThrottlingRuleMetadata{\n}\n}")
public static io.toro.gloop.object.property.GloopModel getThrottlingRule(@GloopParameter(allowNull=false)
                                                                                                                                                                                                                 String name)

Gets the Throttling Rule with a given name.

Parameters:

name - the Throttling Rule's name

Returns:

the Throttling Rule

getThrottlingRules

@GloopObjectParameter(value="throttlingRulesMetadata{\n  throttlingRulesMetadata#io.toro.martini.throttling.ThrottlingRuleMetadata[]{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel getThrottlingRules()

Gets the list of all the Throttling Rules.

Returns:

the list of Throttling Rules

getThrottlingRules

@GloopObjectParameter(value="throttlingRulesMetadata{\n  throttlingRulesMetadata#io.toro.martini.throttling.ThrottlingRuleMetadata[]{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel getThrottlingRules(boolean enabled)

Gets the list of all the Throttling Rules.

Parameters:

enabled - if true then it will get all enabled throttling rules only

Returns:

the list of Throttling Rules

getThrottlingRules

@GloopObjectParameter(value="throttlingRulesMetadata{\n  throttlingRulesMetadata#io.toro.martini.throttling.ThrottlingRuleMetadata[]{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel getThrottlingRules(@GloopParameter(defaultValue="1")
                                                                                                                                                                                                                          int page,
                                                                                                                                                                                                                          @GloopParameter(defaultValue="25")
                                                                                                                                                                                                                          int size,
                                                                                                                                                                                                                          Boolean enabled)

Gets the list of matching Throttling Rules.

Parameters:

page - the starting page

size - the maximum number of Throttling Rules per page

enabled - if set to null it will attempt to get all rules regardless whether it's enabled or disabled. If set to true then all enabled rules are returned

Returns:

the list of Throttling Rules

enableThrottlingRule

public static void enableThrottlingRule(@GloopParameter(allowNull=false)
                                        String name)

Enables the Throttling Rule with a given name.

Parameters:

name - the name of the Throttling Rule enable

disableThrottlingRule

public static void disableThrottlingRule(@GloopParameter(allowNull=false)
                                         String name)

Disables the Throttling Rule with a given name.

Parameters:

name - the name of the Throttling Rule to disable

saveThrottlingRule

public static void saveThrottlingRule(@GloopObjectParameter(value="throttlingRuleMetadata#io.toro.martini.throttling.ThrottlingRuleMetadata{\n}") @GloopParameter(allowNull=false)
                                      io.toro.gloop.object.property.GloopModel rule)

Saves the given Throttling Rule.

Parameters:

rule - the Throttling Rule to save

deleteThrottlingRule

public static void deleteThrottlingRule(@GloopParameter(allowNull=false)
                                        String name)

Deletes the Throttling Rule with a given name.

Parameters:

name - the name of the Throttling Rule to delete