com.alibaba.csp.sentinel

Interface Sph

All Superinterfaces:

SphResourceTypeSupport

All Known Implementing Classes:

CtSph

public interface Sph
extends SphResourceTypeSupport

Interface to get Entry for resource protection. If any block criteria is met, a BlockException or its subclasses will be thrown. Successfully getting a entry indicates permitting the invocation pass.

Author:

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

Method Summary

Modifier and Type	Method and Description
AsyncEntry	asyncEntry(String name, EntryType type, int count, Object... args) Create a protected asynchronous resource.
Entry	entry(Method method) Create a protected method.
Entry	entry(Method method, EntryType type) Create a protected method.
Entry	entry(Method method, EntryType type, int count) Create a protected method.
Entry	entry(Method method, EntryType type, int count, Object... args) Create a protected resource.
Entry	entry(Method method, int count) Create a protected method.
Entry	entry(String name) Create a protected resource.
Entry	entry(String name, EntryType type) Create a protected resource.
Entry	entry(String name, EntryType type, int count) Create a protected resource.
Entry	entry(String name, EntryType type, int count, Object... args) Create a protected resource.
Entry	entry(String name, int count) Create a protected resource.
Entry	entryWithPriority(String name, EntryType type, int count, boolean prioritized) Create a protected resource with priority.
Entry	entryWithPriority(String name, EntryType type, int count, 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

Create a protected resource.

Parameters:

name - the unique name of the protected resource

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method)
     throws BlockException

Create a protected method.

Parameters:

method - the protected method

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            int count)
     throws BlockException

Create a protected method.

Parameters:

method - the protected method

count - the count that the resource requires

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            int count)
     throws BlockException

Create a protected resource.

Parameters:

name - the unique string for the resource

count - the count that the resource requires

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType type)
     throws BlockException

Create a protected method.

Parameters:

method - the protected method

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType type)
     throws BlockException

Create a protected resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType type,
            int count)
     throws BlockException

Create a protected method.

Parameters:

method - the protected method

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType type,
            int count)
     throws BlockException

Create a protected resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(Method method,
            EntryType type,
            int count,
            Object... args)
     throws BlockException

Create a protected resource.

Parameters:

method - the protected method

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

args - the parameters of the method. It can also be counted by setting hot parameter rule

Returns:

entry get.

Throws:

BlockException - if the block criteria is met

entry

Entry entry(String name,
            EntryType type,
            int count,
            Object... args)
     throws BlockException

Create a protected resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

args - the parameters of the method. It can also be counted by setting hot parameter rule

Returns:

entry get

Throws:

BlockException - if the block criteria is met

asyncEntry

AsyncEntry asyncEntry(String name,
                      EntryType type,
                      int count,
                      Object... args)
               throws BlockException

Create a protected asynchronous resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

args - the parameters of the method. It can also be counted by setting hot parameter rule

Returns:

created asynchronous entry

Throws:

BlockException - if the block criteria is met

Since:

0.2.0

entryWithPriority

Entry entryWithPriority(String name,
                        EntryType type,
                        int count,
                        boolean prioritized)
                 throws BlockException

Create a protected resource with priority.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

prioritized - whether the entry is prioritized

Returns:

entry get

Throws:

BlockException - if the block criteria is met

Since:

1.4.0

entryWithPriority

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

Create a protected resource with priority.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable

count - the count that the resource requires

prioritized - whether the entry is prioritized

args - the parameters of the method. It can also be counted by setting hot parameter rule

Returns:

entry get

Throws:

BlockException - if the block criteria is met

Since:

1.5.0