com.alibaba.csp.sentinel

Interface Sph

All Superinterfaces:

SphResourceTypeSupport

All Known Implementing Classes:

CtSph

public interface Sph
extends SphResourceTypeSupport

The basic interface for recording statistics and performing rule checking for resources.

Author:

qinan.qn, jialiang.linjl, leyou, Eric Zhao

Method Summary

Modifier and Type	Method and Description
AsyncEntry	asyncEntry(String name, EntryType trafficType, int batchCount, Object... args) Create a protected asynchronous resource.
Entry	entry(Method method) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType trafficType) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType trafficType, int batchCount) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType trafficType, int batchCount, Object... args) Record statistics and perform rule checking for the given resource.
Entry	entry(Method method, int batchCount) Record statistics and perform rule checking for the given method.
Entry	entry(String name) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType trafficType) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType trafficType, int batchCount) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType trafficType, int batchCount, Object... args) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, int batchCount) Record statistics and perform rule checking for the given resource.
Entry	entryWithPriority(String name, EntryType trafficType, int batchCount, boolean prioritized) Create a protected resource with priority.
Entry	entryWithPriority(String name, EntryType trafficType, int batchCount, boolean prioritized, Object... args) Create a protected resource with priority.

Methods inherited from interface com.alibaba.csp.sentinel.SphResourceTypeSupport

asyncEntryWithType, entryWithType, entryWithType

Method Detail

entry

Entry entry(String name)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name of the protected resource

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method)
     throws BlockException

Record statistics and perform rule checking for the given method.

Parameters:

method - the protected method

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            int batchCount)
     throws BlockException

Record statistics and perform rule checking for the given method.

Parameters:

method - the protected method

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            int batchCount)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique string for the resource

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType trafficType)
     throws BlockException

Record statistics and perform rule checking for the given method.

Parameters:

method - the protected method

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType trafficType)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType trafficType,
            int batchCount)
     throws BlockException

Record statistics and perform rule checking for the given method.

Parameters:

method - the protected method

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType trafficType,
            int batchCount)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType trafficType,
            int batchCount,
            Object... args)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

method - the protected method

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

args - parameters of the method for flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType trafficType,
            int batchCount,
            Object... args)
     throws BlockException

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

args - args for parameter flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

asyncEntry

AsyncEntry asyncEntry(String name,
                      EntryType trafficType,
                      int batchCount,
                      Object... args)
               throws BlockException

Create a protected asynchronous resource.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

args - args for parameter flow control or customized slots

Returns:

created asynchronous entry

Throws:

BlockException - if the block criteria is met

Since:

0.2.0

entryWithPriority

Entry entryWithPriority(String name,
                        EntryType trafficType,
                        int batchCount,
                        boolean prioritized)
                 throws BlockException

Create a protected resource with priority.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

prioritized - whether the entry is prioritized

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

Since:

1.4.0

entryWithPriority

Entry entryWithPriority(String name,
                        EntryType trafficType,
                        int batchCount,
                        boolean prioritized,
                        Object... args)
                 throws BlockException

Create a protected resource with priority.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

prioritized - whether the entry is prioritized

args - args for parameter flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

Since:

1.5.0