Class IPBaseCallerConfiguration
- java.lang.Object
-
- org.apache.synapse.commons.throttle.core.CallerConfiguration
-
- org.apache.synapse.commons.throttle.core.impl.ipbase.IPBaseCallerConfiguration
-
public class IPBaseCallerConfiguration extends CallerConfiguration
Metadata for controls a caller(IP based) - static data -The data have built form processing policy
-
-
Constructor Summary
Constructors Constructor Description IPBaseCallerConfiguration()
IPBaseCallerConfiguration(long unitTime, int maximumRequest, long prohibitTimePeriod, String ipRange)
The Constructor with all configuration data
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFirstPartOfIPRange()
To get First Part of IP RangeString
getID()
To get IP Range - Group IPString
getSecondPartOfIPRange()
To get Second Part of IP Rangeint
getType()
To get the type of the throttlevoid
setFirstPartOfIPRange(String firstPartOfIPRange)
To set First Part of IP Rangevoid
setID(String iprange)
To set IP Rangevoid
setSecondPartOfIPRange(String secondPartOfIPRange)
To set Second Part Of IP Range-
Methods inherited from class org.apache.synapse.commons.throttle.core.CallerConfiguration
getAccessState, getMaximumRequestPerUnitTime, getProhibitTimePeriod, getUnitTime, setAccessState, setMaximumRequestPerUnitTime, setProhibitTimePeriod, setUnitTime
-
-
-
-
Constructor Detail
-
IPBaseCallerConfiguration
public IPBaseCallerConfiguration()
-
IPBaseCallerConfiguration
public IPBaseCallerConfiguration(long unitTime, int maximumRequest, long prohibitTimePeriod, String ipRange)
The Constructor with all configuration data- Parameters:
unitTime
- - long value which represents Unit Time WindowmaximumRequest
- - int value which represents Maximum RequestprohibitTimePeriod
- - long value which represents Prohibit Time after Max request cameipRange
- - String value which represents IP Range
-
-
Method Detail
-
getID
public String getID()
To get IP Range - Group IP- Specified by:
getID
in classCallerConfiguration
- Returns:
- String value of IP Range
-
getFirstPartOfIPRange
public String getFirstPartOfIPRange()
To get First Part of IP Range- Returns:
- String value of First Part Of Ip Range
-
getSecondPartOfIPRange
public String getSecondPartOfIPRange()
To get Second Part of IP Range- Returns:
- String value of Second Part Of IP Range
-
setID
public void setID(String iprange)
To set IP Range- Specified by:
setID
in classCallerConfiguration
- Parameters:
iprange
- The string representation of ip (single or group)
-
getType
public int getType()
Description copied from class:CallerConfiguration
To get the type of the throttle- Specified by:
getType
in classCallerConfiguration
- Returns:
- the type of the throttle
-
setFirstPartOfIPRange
public void setFirstPartOfIPRange(String firstPartOfIPRange)
To set First Part of IP Range- Parameters:
firstPartOfIPRange
- - String value
-
setSecondPartOfIPRange
public void setSecondPartOfIPRange(String secondPartOfIPRange)
To set Second Part Of IP Range- Parameters:
secondPartOfIPRange
- - String value
-
-