fuseguard.components.ip.IPListManager

fuseguard.components.ip
Component IPListManager

ip.IPListManager

API for managing IP lists

Method Summary

public any init([any firewallInstance])
          Initialize the IPListManager

public void addIPListProvider([any ipListProvider])

public struct getIPList([string listID])
          Returns the ip list specified by the id

public array getIPListProviders()
          Returns an array of IP list providers that are registered with this list manager.

public array getIPLists()
          Returns an array of structs

public array getListIDForType([string type])
          Returns an array of list IDs matching the specified type.

public any getManagerEnabledProvider()
          Returns the first manager enabled provider if no providers exist throws exception

public any getProviderForList([string listID])

public boolean hasManagerEnabledProvider()
          Returns true if there is a list that can be managed by FuseGuard Manager

public boolean isValidListID([string listID])

Method Detail

addIPListProvider

public void addIPListProvider([any ipListProvider])

Parameters:: [any ipListProvider]

getIPList

public struct getIPList([string listID])

Returns the ip list specified by the id

Parameters:: [string listID]

getIPListProviders

public array getIPListProviders()

Returns an array of IP list providers that are registered with this list manager.

getIPLists

public array getIPLists()

Returns an array of structs

getListIDForType

public array getListIDForType([string type])

Returns an array of list IDs matching the specified type.

Parameters:: [string type] - For example ip_country

getManagerEnabledProvider

public any getManagerEnabledProvider()

Returns the first manager enabled provider if no providers exist throws exception

getProviderForList

public any getProviderForList([string listID])

Parameters:: [string listID]

hasManagerEnabledProvider

public boolean hasManagerEnabledProvider()

Returns true if there is a list that can be managed by FuseGuard Manager

init

public any init([any firewallInstance])

Initialize the IPListManager

Parameters:: [any firewallInstance]

isValidListID

public boolean isValidListID([string listID])

Parameters:: [string listID]

Method Summary
`public any`	`init([any firewallInstance])` Initialize the IPListManager
`public void`	`addIPListProvider([any ipListProvider])`
`public struct`	`getIPList([string listID])` Returns the ip list specified by the id
`public array`	`getIPListProviders()` Returns an array of IP list providers that are registered with this list manager.
`public array`	`getIPLists()` Returns an array of structs
`public array`	`getListIDForType([string type])` Returns an array of list IDs matching the specified type.
`public any`	`getManagerEnabledProvider()` Returns the first manager enabled provider if no providers exist throws exception
`public any`	`getProviderForList([string listID])`
`public boolean`	`hasManagerEnabledProvider()` Returns true if there is a list that can be managed by FuseGuard Manager
`public boolean`	`isValidListID([string listID])`

fuseguard.components.ip Component IPListManager