org.apache.ftpserver.ip
Class FileIpRestrictor

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.ftpserver.ip.AbstractIpRestrictor
          org.apache.ftpserver.ip.FileIpRestrictor

All Implemented Interfaces:

org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, IpRestrictorInterface

public class FileIpRestrictor
extends AbstractIpRestrictor

This class provides IP restriction functionality.

Author:

Rana Bhattacharyya

Field Summary

Fields inherited from class org.apache.ftpserver.ip.AbstractIpRestrictor

mbAllowIp, mConfig

Fields inherited from interface org.apache.ftpserver.ip.IpRestrictorInterface

ROLE

Constructor Summary

FileIpRestrictor()

Method Summary

void	addEntry(java.lang.String entry) Add a new entry.
void	clear() Remove all entries
void	contextualize(org.apache.avalon.framework.context.Context context) Set application context.
java.util.Collection	getAllEntries() Get all entries
java.io.File	getFile() Get IP resrictor file object.
boolean	hasPermission(java.net.InetAddress addr) Check IP permission.
void	reload() Read the list from the file.
void	removeEntry(java.lang.String entry) Remove entry
void	save() Save this IP restriction list.

Methods inherited from class org.apache.ftpserver.ip.AbstractIpRestrictor

configure, dispose, getBaseDirectory, getConfig, initialize, isAllowIp

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileIpRestrictor

public FileIpRestrictor()

Method Detail

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)
                   throws org.apache.avalon.framework.context.ContextException

Set application context.

Specified by:

contextualize in interface org.apache.avalon.framework.context.Contextualizable

Overrides:

contextualize in class AbstractIpRestrictor

Throws:

org.apache.avalon.framework.context.ContextException

reload

public void reload()
            throws java.io.IOException

Read the list from the file.

Specified by:

reload in interface IpRestrictorInterface

Overrides:

reload in class AbstractIpRestrictor

Throws:

java.io.IOException

getFile

public java.io.File getFile()

Get IP resrictor file object.

save

public void save()
          throws java.io.IOException

Save this IP restriction list.

Throws:

java.io.IOException

hasPermission

public boolean hasPermission(java.net.InetAddress addr)

Check IP permission. Compare it with all the entries in the list.

addEntry

public void addEntry(java.lang.String entry)

Add a new entry.

removeEntry

public void removeEntry(java.lang.String entry)

Remove entry

getAllEntries

public java.util.Collection getAllEntries()

Get all entries

clear

public void clear()

Remove all entries