org.gudy.azureus2.plugins.ipfilter
Interface IPFilter

All Known Implementing Classes:
IPFilterImpl, RPIPFilter

public interface IPFilter


Method Summary
 void addRange(IPRange range)
          Adds a range.
 void ban(java.lang.String IPAddress, java.lang.String text)
          Explicitly bans an address
 void block(java.lang.String IPAddress)
          Explicitly blocks an address
 IPRange createAndAddRange(java.lang.String description, java.lang.String start_ip, java.lang.String end_ip, boolean this_session_only)
          Creates, validates and adds a range
 IPRange createRange(boolean this_session_only)
          creates a new range but *doesn't* add it to the list.
 IPBanned[] getBannedIPs()
          Gets the current list of b addresses
 IPBlocked[] getBlockedIPs()
          Gets the current list of blocked addresses
 java.io.File getFile()
          Gets the file name used for persistent ranges
 boolean getInRangeAddressesAreAllowed()
          The filter either allows defined ranges to be allowed or denied access
 long getLastUpdateTime()
          Gets the last time the filter set was updated or marked as up to date
 int getNumberOfBannedIPs()
          returns length of banned ip list
 int getNumberOfBlockedIPs()
          returns length of blocked ip list
 int getNumberOfRanges()
          returns length of ranges list
 IPRange[] getRanges()
          Gets the current set of defined IP ranges
 boolean isEnabled()
          Test if ipfilter is enabled or not
 boolean isInRange(java.lang.String IPAddress)
          Checks an address to see if its in an allowed range
 void markAsUpToDate()
          Marks the IPFilter set as being uptodate
 void reload()
          Reloads the ip filter from the config file (obtainable using "getFile")
 void removeRange(IPRange range)
          Remove a range
 void save()
          saves current setting to file given by getFile
 void setEnabled(boolean enabled)
          change the enabled status
 void setInRangeAddressesAreAllowed(boolean b)
          Set the behaviour of the filter to either allow or deny access for defined ranges
 void unban(java.lang.String IPAddress)
          Removes a ban on an address
 

Method Detail

getFile

java.io.File getFile()
Gets the file name used for persistent ranges

Returns:

createRange

IPRange createRange(boolean this_session_only)
creates a new range but *doesn't* add it to the list. Use the add method to add it

Parameters:
this_session_only - // not persisted if "this_session_only" is true
Returns:

addRange

void addRange(IPRange range)
Adds a range. Only ranges created with "create" above can be added

Parameters:
range -

createAndAddRange

IPRange createAndAddRange(java.lang.String description,
                          java.lang.String start_ip,
                          java.lang.String end_ip,
                          boolean this_session_only)
Creates, validates and adds a range

Parameters:
description -
start_ip -
end_ip -
this_session_only - not persisted if true
Returns:
new range or null if invalid

removeRange

void removeRange(IPRange range)
Remove a range

Parameters:
range -

reload

void reload()
            throws IPFilterException
Reloads the ip filter from the config file (obtainable using "getFile")

Throws:
IPFilterException

getRanges

IPRange[] getRanges()
Gets the current set of defined IP ranges

Returns:

getNumberOfRanges

int getNumberOfRanges()
returns length of ranges list

Returns:

isInRange

boolean isInRange(java.lang.String IPAddress)
Checks an address to see if its in an allowed range

Parameters:
IPAddress -
Returns:

getBlockedIPs

IPBlocked[] getBlockedIPs()
Gets the current list of blocked addresses

Returns:

getNumberOfBlockedIPs

int getNumberOfBlockedIPs()
returns length of blocked ip list

Returns:

block

void block(java.lang.String IPAddress)
Explicitly blocks an address

Parameters:
IPAddress -

getBannedIPs

IPBanned[] getBannedIPs()
Gets the current list of b addresses

Returns:
Since:
2.5.0.2

getNumberOfBannedIPs

int getNumberOfBannedIPs()
returns length of banned ip list

Returns:
Since:
2.5.0.2

ban

void ban(java.lang.String IPAddress,
         java.lang.String text)
Explicitly bans an address

Parameters:
IPAddress -
Since:
2.5.0.2

unban

void unban(java.lang.String IPAddress)
Removes a ban on an address

Parameters:
IPAddress -
Since:
2.5.0.2

getInRangeAddressesAreAllowed

boolean getInRangeAddressesAreAllowed()
The filter either allows defined ranges to be allowed or denied access

Returns:

setInRangeAddressesAreAllowed

void setInRangeAddressesAreAllowed(boolean b)
Set the behaviour of the filter to either allow or deny access for defined ranges

Parameters:
b -

isEnabled

boolean isEnabled()
Test if ipfilter is enabled or not

Returns:

setEnabled

void setEnabled(boolean enabled)
change the enabled status

Parameters:
enabled -

save

void save()
          throws IPFilterException
saves current setting to file given by getFile

Throws:
IPFilterException

markAsUpToDate

void markAsUpToDate()
Marks the IPFilter set as being uptodate


getLastUpdateTime

long getLastUpdateTime()
Gets the last time the filter set was updated or marked as up to date

Returns: