com.esf.net.firewall.service
Interface ILinuxFirewallService


public interface ILinuxFirewallService

The ILinuxFirewallservice is used to set up firewall settings . To setup the firewall settings setup the respective parameter using the add methods and then use the method writefile. Also use writefile after you use the delete calls. CONFIGURATION Rule specific configuration parameters are detailed in the documentation of each rule class. Firewall configurations will consist of one or more rule configurations.


Field Summary
static java.lang.String SERVICE_NAME
          service name of this interface for the bundle activator (com.esf.networking.firewall.service)
 
Method Summary
 void addLocalRule(int port, java.lang.String protocol, java.lang.String permittedNetwork, java.lang.String permittedMAC, java.lang.String sourcePortRange, int persistence)
          Adds a new Local Port rule to the firewall, to allow incoming port connections.
 void addNatRule(java.lang.String sourceNetwork, java.lang.String sourceInterface, java.lang.String destinationInterface, boolean masquerade, int persistence)
          Adds a new Network Address Translation rule to the firewall.
 void addPortForwardRule(java.lang.String iface, java.lang.String address, java.lang.String protocol, int inPort, int outPort, java.lang.String permittedNetwork, java.lang.String permittedMAC, java.lang.String sourcePortRange, int persistence)
          Adds a new Port Forwarding rule to firewall.
 void blockAllPorts(int persistence)
          blocks all ports in the firewall configuration.
 void deleteAllLocalRules(int persistence)
          Removes all Local Port rules from this firewall configuration.
 void deleteAllNatRules(int persistence)
          Removes all Network Address Translation rules from this firewall configuration.
 void deleteAllPortForwardRules(int persistence)
          Removes all Port Forwarding rules from this firewall configuration.
 void deleteLocalRule(int index, int persistence)
          Deletes a Local Rule from this firewall configuration.
 void deleteNatRule(int index, int persistence)
          Deletes a Network Address Translation rule from this firewall configuration.
 void deletePortForwardRule(int index, int persistence)
          Deletes a Port Forwarding rule from this firewall configuration.
 java.util.ArrayList getLocalRules(int persistence)
          Gets a list of all Local Port rules from this firewall configuration.
 java.util.ArrayList getNatRules(int persistence)
          Gets a list of all Network Address Translation rules from this firewall configuration.
 java.util.ArrayList getPortForwardRules(int persistence)
          Gets a list of all Port Forwarding rules from this firewall configuration.
 void unblockAllPorts(int persistence)
          unblocks all ports in the firewall configuration.
 void writeFile(int persistence)
          Writes a new firewall configuration file.
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
service name of this interface for the bundle activator (com.esf.networking.firewall.service)

Method Detail

writeFile

public void writeFile(int persistence)
               throws java.lang.Exception
Writes a new firewall configuration file.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If any access errors occur.

addLocalRule

public void addLocalRule(int port,
                         java.lang.String protocol,
                         java.lang.String permittedNetwork,
                         java.lang.String permittedMAC,
                         java.lang.String sourcePortRange,
                         int persistence)
                  throws java.lang.Exception
Adds a new Local Port rule to the firewall, to allow incoming port connections.

Parameters:
persistence - = persistence definition
port - local port number for the incoming connection
protocol - network protocol, as String
permittedNetwork - permitted source IP address or network, as String
permittedMAC - permitted source MAC address, as String
sourcePortRange - permitted source port range for incoming connection, as String
Throws:
java.lang.Exception - If rule cannot be added

addPortForwardRule

public void addPortForwardRule(java.lang.String iface,
                               java.lang.String address,
                               java.lang.String protocol,
                               int inPort,
                               int outPort,
                               java.lang.String permittedNetwork,
                               java.lang.String permittedMAC,
                               java.lang.String sourcePortRange,
                               int persistence)
                        throws java.lang.Exception
Adds a new Port Forwarding rule to firewall.

Parameters:
persistence - = persistence definition
iface - source interface name, as String
address - destination IP address to forward to, as String
protocol - network protocol, as String
inPort - incoming IP port
outPort - forwarded destination IP port
permittedNetwork - permitted source IP address or network, as String
permittedMAC - permitted source MAC address, as String
sourcePortRange - permitted source port range for incoming connection, as String
Throws:
java.lang.Exception - If rule cannot be added

addNatRule

public void addNatRule(java.lang.String sourceNetwork,
                       java.lang.String sourceInterface,
                       java.lang.String destinationInterface,
                       boolean masquerade,
                       int persistence)
                throws java.lang.Exception
Adds a new Network Address Translation rule to the firewall.

Parameters:
persistence - = persistence definition
sourceNetwork - source IP address or network, as String
sourceInterface - source interface name, as String
destinationInterface - destination interface name, as String
masquerade - add masquerade entry, as boolean
Throws:
java.lang.Exception - If rule cannot be added

getLocalRules

public java.util.ArrayList getLocalRules(int persistence)
                                  throws java.lang.Exception
Gets a list of all Local Port rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Returns:
ArrayList of Local Port rules
Throws:
java.lang.Exception - If unable to get Local Port rules

getPortForwardRules

public java.util.ArrayList getPortForwardRules(int persistence)
                                        throws java.lang.Exception
Gets a list of all Port Forwarding rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Returns:
ArrayList of Port Forwarding rules
Throws:
java.lang.Exception - If unable to get Port Forwarding rules

getNatRules

public java.util.ArrayList getNatRules(int persistence)
                                throws java.lang.Exception
Gets a list of all Network Address Translation rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Returns:
ArrayList of NAT rules
Throws:
java.lang.Exception - If unable to get NAT rules

deleteLocalRule

public void deleteLocalRule(int index,
                            int persistence)
                     throws java.lang.Exception
Deletes a Local Rule from this firewall configuration.

Parameters:
index - index in the ArrayList of the Local Rule to be deleted
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete Local Rule

deletePortForwardRule

public void deletePortForwardRule(int index,
                                  int persistence)
                           throws java.lang.Exception
Deletes a Port Forwarding rule from this firewall configuration.

Parameters:
index - index in the ArrayList of the Port Forwarding rule to be deleted
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete Port Forwarding rule

deleteNatRule

public void deleteNatRule(int index,
                          int persistence)
                   throws java.lang.Exception
Deletes a Network Address Translation rule from this firewall configuration.

Parameters:
index - index in the ArrayList of the NAT rule to be deleted
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete NAT rule

deleteAllLocalRules

public void deleteAllLocalRules(int persistence)
                         throws java.lang.Exception
Removes all Local Port rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete all Local Port rules

deleteAllPortForwardRules

public void deleteAllPortForwardRules(int persistence)
                               throws java.lang.Exception
Removes all Port Forwarding rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete all Port Forwarding rules

deleteAllNatRules

public void deleteAllNatRules(int persistence)
                       throws java.lang.Exception
Removes all Network Address Translation rules from this firewall configuration.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to delete all NAT rules

blockAllPorts

public void blockAllPorts(int persistence)
                   throws java.lang.Exception
blocks all ports in the firewall configuration.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to block all ports

unblockAllPorts

public void unblockAllPorts(int persistence)
                     throws java.lang.Exception
unblocks all ports in the firewall configuration.

Parameters:
persistence - = persistence definition
Throws:
java.lang.Exception - If unable to unblock all ports


Copyright © 2009 Eurotech Inc. All rights reserved.