org.openhubframework.openhub.spi.throttling

Class ThrottleScope

java.lang.Object

org.openhubframework.openhub.spi.throttling.ThrottleScope

All Implemented Interfaces:

HumanReadable

public final class ThrottleScope
extends Object
implements HumanReadable

The class represents a throttling scope consisting of a source system and service name.

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_SERVICE Represents any service.
static String	ANY_SOURCE_SYSTEM Represents any source system.
static String	THROTTLE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ThrottleScope(String sourceSystem, String serviceName) Creates new throttle scope.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getServiceName() Gets service name.
String	getSourceSystem() Gets source system.
int	hashCode()
int	match(ThrottleScope that) Tests if the throttling scopes match.
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ANY_SOURCE_SYSTEM

public static final String ANY_SOURCE_SYSTEM

Represents any source system.

See Also:

Constant Field Values

ANY_SERVICE

public static final String ANY_SERVICE

Represents any service.

See Also:

Constant Field Values

THROTTLE_SEPARATOR

public static final String THROTTLE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ThrottleScope

public ThrottleScope(String sourceSystem,
             String serviceName)

Creates new throttle scope.

Parameters:

sourceSystem - the source system, can be used ANY_SOURCE_SYSTEM or '*'

serviceName - the service name, can be used ANY_SERVICE or '*'

Method Detail

getSourceSystem

public String getSourceSystem()

Gets source system.

Returns:

source system

getServiceName

public String getServiceName()

Gets service name.

Returns:

service name

match

public int match(ThrottleScope that)

Tests if the throttling scopes match.

Returns:

the match factor. Negative value signifies no match. Non-negative signifies a match. The greater the returned value the closer the match.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toHumanString

public String toHumanString()

Description copied from interface: HumanReadable

Returns human readable entity identification with start and end round brackets.

Specified by:

toHumanString in interface HumanReadable

Returns:

entity identification

toString

public String toString()

Overrides:

toString in class Object