com.esf.device.wifi.ubiquiti.ministation2.service
Interface IUbiquitiMinistationService


public interface IUbiquitiMinistationService

Defines UbiquitiMinistationService interface

Author:
ilya.binshtok

Field Summary
static int MINISTATION_2_MODE_AP_BRIDGE
           
static int MINISTATION_2_MODE_STATION_DHCP_BRIDGE
           
static int MINISTATION_2_MODE_STATION_STATIC_BRIDGE
           
static int MINISTATION_CONFIG_TOUT
          Ministation configuration timeout in msec.
static java.lang.String SERVICE_NAME
          Reports the class name representing this interface.
 
Method Summary
 java.lang.String getBindIface()
          Reports name of ministation bind interface.
 IUbiquitiMinistationManagement getMinistationManagement()
          Reports ministation management interface.
 IUbiquitiMinistationManagement getMinistationManagement(long tout)
          Reports ministation management interface.
 java.util.Properties getRunningConfiguration()
          Obtains Ministation runtime configuration by sending the GET /cfg.cgi request to the station.
 java.util.Properties getStartupConfiguration()
          Obtains configuration that has been submitted to ministation and temporarily stored in the /tmp/.esf/config directory.
 boolean isReachable()
          Reports if ministation is reachable
 boolean isReachable(long tout)
          Reports if ministation is reachable
 void setBindIface(java.lang.String iface)
          Sets ministation bind interface
 void setToAccessPoint(java.lang.String essid, int channel, int txPower, int securityType, java.lang.String password, java.lang.String bridgeIpAddress, java.lang.String wifiNetmask, java.lang.String gateway)
          Sets ministation to operate in the 'master' (Access Point bridge) mode.
 void setToDhcpBridge(java.lang.String essid, int txPower, int securityType, java.lang.String password)
          Sets ministattion to operate in the 'managed' (DHCP bridge) mode.
 void setToStaticBridge(java.lang.String essid, int txPower, int securityType, java.lang.String password, java.lang.String wifiIpAddress, java.lang.String wifiNetmask, java.lang.String gateway, java.lang.String primaryDns, java.lang.String secondaryDns)
          Sets ministation to operate in the 'managed' (Static bridge) mode.
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Reports the class name representing this interface.


MINISTATION_2_MODE_AP_BRIDGE

static final int MINISTATION_2_MODE_AP_BRIDGE
See Also:
Constant Field Values

MINISTATION_2_MODE_STATION_STATIC_BRIDGE

static final int MINISTATION_2_MODE_STATION_STATIC_BRIDGE
See Also:
Constant Field Values

MINISTATION_2_MODE_STATION_DHCP_BRIDGE

static final int MINISTATION_2_MODE_STATION_DHCP_BRIDGE
See Also:
Constant Field Values

MINISTATION_CONFIG_TOUT

static final int MINISTATION_CONFIG_TOUT
Ministation configuration timeout in msec.

See Also:
Constant Field Values
Method Detail

getMinistationManagement

IUbiquitiMinistationManagement getMinistationManagement()
                                                        throws java.lang.Exception
Reports ministation management interface.

Returns:
ministation management interface as IUbiquitiMinistationManagement
Throws:
java.lang.Exception

getMinistationManagement

IUbiquitiMinistationManagement getMinistationManagement(long tout)
                                                        throws java.lang.Exception
Reports ministation management interface.

Parameters:
tout - - timeout in msec as long
Returns:
ministation management interface as IUbiquitiMinistationManagement
Throws:
java.lang.Exception

isReachable

boolean isReachable()
                    throws java.lang.Exception
Reports if ministation is reachable

Returns:
boolean
Throws:
java.lang.Exception

isReachable

boolean isReachable(long tout)
                    throws java.lang.Exception
Reports if ministation is reachable

Parameters:
tout - - configuration timeout in msec as long
Returns:
boolean
Throws:
java.lang.Exception

getBindIface

java.lang.String getBindIface()
Reports name of ministation bind interface.

Returns:
bind interface as String

setBindIface

void setBindIface(java.lang.String iface)
Sets ministation bind interface

Parameters:
iface - - name of the bind interface as String

setToAccessPoint

void setToAccessPoint(java.lang.String essid,
                      int channel,
                      int txPower,
                      int securityType,
                      java.lang.String password,
                      java.lang.String bridgeIpAddress,
                      java.lang.String wifiNetmask,
                      java.lang.String gateway)
                      throws java.lang.Exception
Sets ministation to operate in the 'master' (Access Point bridge) mode.

Parameters:
essid - - service set ID as String
channel - - 802.11 channel as int
txPower - - output power in dBm as int
securityType - - security type as int
password - - password as String
bridgeIpAddress - - bridge IP address as String
wifiNetmask - - netmask as String
gateway - - default gateway as String
Throws:
java.lang.Exception

setToDhcpBridge

void setToDhcpBridge(java.lang.String essid,
                     int txPower,
                     int securityType,
                     java.lang.String password)
                     throws java.lang.Exception
Sets ministattion to operate in the 'managed' (DHCP bridge) mode.

Parameters:
essid - - service set ID as String
txPower - - output power in dBm as int
securityType - - security type as int
password - - password as String
Throws:
java.lang.Exception

setToStaticBridge

void setToStaticBridge(java.lang.String essid,
                       int txPower,
                       int securityType,
                       java.lang.String password,
                       java.lang.String wifiIpAddress,
                       java.lang.String wifiNetmask,
                       java.lang.String gateway,
                       java.lang.String primaryDns,
                       java.lang.String secondaryDns)
                       throws java.lang.Exception
Sets ministation to operate in the 'managed' (Static bridge) mode.

Parameters:
essid - - service set ID as String
txPower - - output power in dBm as int
securityType - - security type as int
password - - password as String
wifiIpAddress - - IP address as String
wifiNetmask - - netmask as String
gateway - - default gateway as String
primaryDns - - primary DNS as String
secondaryDns - - secondary DNS as String
Throws:
java.lang.Exception

getRunningConfiguration

java.util.Properties getRunningConfiguration()
                                             throws java.lang.Exception
Obtains Ministation runtime configuration by sending the GET /cfg.cgi request to the station.

Returns:
running configuration as Properties
Throws:
java.lang.Exception

getStartupConfiguration

java.util.Properties getStartupConfiguration()
                                             throws java.lang.Exception
Obtains configuration that has been submitted to ministation and temporarily stored in the /tmp/.esf/config directory.

Returns:
startup configuration as Properties
Throws:
java.lang.Exception