com.aspc.cms.rest

Interface RestPluginThrottling

All Known Implementing Classes:

RestDefinition, RestDefinitionSQL

public interface RestPluginThrottling

Author:

CORP\lei

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCounterKey(WebClient client, RestDefinition restDefinition) get the key of the throttling counter, the key has to be shorter than 255 characters
int	getPeriod(WebClient client, RestDefinition rd) get the throttling period in seconds
int	getRequestLimit(WebClient client, RestDefinition rd) -1 is no limit 0 is always reject n is allow n requests in each throttling period

Method Detail

getCounterKey

@CheckReturnValue
 @Nullable
java.lang.String getCounterKey(@Nonnull
                                                            WebClient client,
                                                            @Nonnull
                                                            RestDefinition restDefinition)
                                                     throws java.lang.UnsupportedOperationException,
                                                            java.lang.Exception,
                                                            java.lang.IllegalArgumentException

get the key of the throttling counter, the key has to be shorter than 255 characters

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

Returns:

The throttling counter key. Does NOT throttling if this method return null or empty string

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

java.lang.Exception - an error has occurred.

java.lang.IllegalArgumentException

getRequestLimit

int getRequestLimit(@Nonnull
                    WebClient client,
                    @Nonnull
                    RestDefinition rd)
             throws java.lang.UnsupportedOperationException,
                    java.lang.Exception

-1 is no limit 0 is always reject n is allow n requests in each throttling period

Parameters:

client - the client. Null means check only of ops

rd - the definition

Returns:

Throws:

java.lang.UnsupportedOperationException - use default throttling settings configured in RestDefinition record

java.lang.Exception

getPeriod

int getPeriod(@Nonnull
              WebClient client,
              @Nonnull
              RestDefinition rd)
       throws java.lang.UnsupportedOperationException,
              java.lang.Exception

get the throttling period in seconds

Parameters:

client - the client. Null means check only of ops

rd - the definition

Returns:

Throws:

java.lang.UnsupportedOperationException - use default throttling settings configured in RestDefinition record

java.lang.Exception