## Uses of Class
org.apache.synapse.commons.throttle.core.CallerConfiguration

- Packages that use CallerConfiguration
  Package | Description
  --- | ---
  org.apache.synapse.commons.throttle.core |
  org.apache.synapse.commons.throttle.core.factory |
  org.apache.synapse.commons.throttle.core.impl.domainbase |
  org.apache.synapse.commons.throttle.core.impl.ipbase |
  org.apache.synapse.commons.throttle.core.impl.rolebase |
  org.apache.synapse.commons.throttle.core.internal |

- - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core

    Methods in org.apache.synapse.commons.throttle.core that return CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CallerConfiguration` | ThrottleConfiguration.`getCallerConfiguration​(String ID)` | To get a CallerConfiguration - The controlling policy for a caller

    Methods in org.apache.synapse.commons.throttle.core with parameters of type CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | ThrottleConfiguration.`addCallerConfiguration​(CallerConfiguration callerConfiguration)` | To add a CallerConfiguration - The controlling policy for a caller
    `boolean` | CallerContext.`canAccess​(ThrottleContext throttleContext, CallerConfiguration configuration, long currentTime)` | Check whether that caller can access or not ,based on current state and pre-defined policy
    `boolean` | CallerContext.`canAccess​(ThrottleContext throttleContext, CallerConfiguration configuration, long currentTime, Long eventCount)` | Check whether that caller can access or not, based on current state and pre-defined policy
    `void` | CallerContext.`cleanUpCallers​(CallerConfiguration configuration, ThrottleContext throttleContext, long currentTime)` | Clean up the callers - remove all callers that have expired their time window

  - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core.factory

    Methods in org.apache.synapse.commons.throttle.core.factory that return CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `static CallerConfiguration` | CallerConfigurationFactory.`createCallerConfiguration​(int throttletype)` | To create a CallerConfiguration instance for the given throttle type

  - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.domainbase

    Subclasses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.domainbase
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `DomainBaseCallerConfiguration` | Caller Configuration implementation for domain name based throttle

    Methods in org.apache.synapse.commons.throttle.core.impl.domainbase that return CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CallerConfiguration` | DomainBaseThrottleConfiguration.`getCallerConfiguration​(String ID)` | To get a DomainBaseCallerConfiguration - if a configuration for given key found ,it returns , other wise , the default configuration will return.

    Methods in org.apache.synapse.commons.throttle.core.impl.domainbase with parameters of type CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DomainBaseThrottleConfiguration.`addCallerConfiguration​(CallerConfiguration configuration)` | To add a DomainBaseCallerConfiguration

  - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.ipbase

    Subclasses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.ipbase
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `IPBaseCallerConfiguration` | Metadata for controls a caller(IP based) - static data -The data have built form processing policy

    Methods in org.apache.synapse.commons.throttle.core.impl.ipbase that return CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CallerConfiguration` | IPBaseThrottleConfiguration.`getCallerConfiguration​(String ID)` | To get a IPBaseCallerConfiguration - if a configuration for given key found ,it returns , other wise , the default configuration will return.

    Methods in org.apache.synapse.commons.throttle.core.impl.ipbase with parameters of type CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | IPBaseThrottleConfiguration.`addCallerConfiguration​(CallerConfiguration configuration)` | To add a IPBaseCallerConfiguration

  - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.rolebase

    Subclasses of CallerConfiguration in org.apache.synapse.commons.throttle.core.impl.rolebase
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `RoleBaseCallerConfiguration` |

    Methods in org.apache.synapse.commons.throttle.core.impl.rolebase that return CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CallerConfiguration` | RoleBaseThrottleConfiguration.`getCallerConfiguration​(String roleID)` |

    Methods in org.apache.synapse.commons.throttle.core.impl.rolebase with parameters of type CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | RoleBaseThrottleConfiguration.`addCallerConfiguration​(CallerConfiguration callerConfiguration)` |

  - ### Uses of CallerConfiguration in org.apache.synapse.commons.throttle.core.internal

    Methods in org.apache.synapse.commons.throttle.core.internal with parameters of type CallerConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | DistributedThrottleProcessor.`canAccessBasedOnUnitTime​(CallerContext callerContext, CallerConfiguration configuration, ThrottleContext throttleContext, RequestContext requestContext)` |
    `boolean` | DistributedThrottleProcessor.`canAccessIfUnitTimeNotOver​(CallerContext callerContext, CallerConfiguration configuration, ThrottleContext throttleContext, RequestContext requestContext)` |
    `boolean` | DistributedThrottleProcessor.`canAccessIfUnitTimeOver​(CallerContext callerContext, CallerConfiguration configuration, ThrottleContext throttleContext, RequestContext requestContext)` |