AdventNet WiFi Mediation API, v1.0

com.adventnet.wifi.mediation.beans
Class AuthenticationSettings

java.lang.Object
  extended bycom.adventnet.wifi.mediation.beans.AuthenticationSettings

public class AuthenticationSettings
extends java.lang.Object

Class holding all the authentication related details. Primarily used while fetching the authentication related details from the Access point or to configure the same.


Field Summary
static int DISABLE_NETWORK_EAP
          Constant to represent that network level EAP is disabled.
static int DISABLE_OPEN_AUTHENTICATION
          Constant to represent that open authentication is disabled.
static int DISABLE_SHARED_AUTHENTICATION
          Constant to represent that shared authentication is disabled.
static int NETWORK_EAP_NO_ADDITION
          Constant to represent network EAP without any addition.
static int NETWORK_EAP_WITH_MAC_AUTHENTICATION
          Constant to represent network EAP with MAC authentication.
static int OPEN_AUTHENTICATION_NO_ADDITION
          Constant to represent open authentication without any addition.
static int OPEN_AUTHENTICATION_WITH_EAP
          Constant to represent open authentication with EAP.
static int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION
          Constant to represent open authentication with MAC authentication.
static int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP
          Constant to represent open authentication with MAC authentication and EAP.
static int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_OR_EAP
          Constant to represent open authentication with MAC authentication or EAP.
static int SHARED_AUTHENTICATION_NO_ADDITION
          Constant to represent shared authentication without any addition.
static int SHARED_AUTHENTICATION_WITH_EAP
          Constant to represent shared authentication with EAP.
static int SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION
          Constant to represent shared authentication with MAC authentication.
static int SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP
          Constant to represent shared authentication with MAC authentication and EAP.
 
Constructor Summary
AuthenticationSettings()
          Creates a new instance of AuthenticationSettings
 
Method Summary
 java.lang.Object getData()
          Used for internal purposes.
 java.util.List getEAPRadiusServers()
          Fetches the list of Radius Servers that are used for MAC authentication.
 java.util.List getMACRadiusServers()
          Fetches the list of Radius Servers that are used for MAC authentication.
 int getNetworkEAPAuthType()
          Fetches the type of EAP authentication.
 int getOpenAuthenticationType()
          Fetches the type of open authentication.
 int getSharedAuthenticationType()
          Fetches the type of shared authentication.
 java.lang.String getWPAPSK()
          Returns the PreSharedKey which has been set using setWPAPSK(String).
 boolean isMACAuthEnabled()
          Says whether the MAC Authentication is enabled.
 boolean isNetworkEAPEnabled()
          Says whether the EAP Authentication is enabled.
 boolean isOpenAuthEnabled()
          Says whether the Open MAC Authentication is enabled.
 boolean isSharedAuthEnabled()
          Says whether the Shared Auth is enabled.
 boolean isWPAPSKEnabled()
          Says whether the WPA PSK is enabled or not.
 void setEAPRadiusServers(java.util.List list)
          Sets the list of Radius servers that are to be used for EAP.
 void setMACRadiusServers(java.util.List rsList)
          Sets the list of Radius servers that are to be used for MAC authentication.
 void setNetworkEAPType(int eapAuthType)
          Sets the type of EAP authentication
 void setOpenAuthenticationType(int openAuthType)
          Sets the type of open authentication
 void setSharedAuthenticationType(int sharedAuthType)
          Sets the type of shared authentication
 void setWPAPSK(java.lang.String key)
          Method to set the WPA PreShared Key.
 java.lang.String toString()
          Method that gives you the String transformation of this Object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DISABLE_OPEN_AUTHENTICATION

public static final int DISABLE_OPEN_AUTHENTICATION
Constant to represent that open authentication is disabled.

See Also:
Constant Field Values

OPEN_AUTHENTICATION_NO_ADDITION

public static final int OPEN_AUTHENTICATION_NO_ADDITION
Constant to represent open authentication without any addition.

See Also:
Constant Field Values

OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION

public static final int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION
Constant to represent open authentication with MAC authentication.

See Also:
Constant Field Values

OPEN_AUTHENTICATION_WITH_EAP

public static final int OPEN_AUTHENTICATION_WITH_EAP
Constant to represent open authentication with EAP.

See Also:
Constant Field Values

OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP

public static final int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP
Constant to represent open authentication with MAC authentication and EAP.

See Also:
Constant Field Values

OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_OR_EAP

public static final int OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_OR_EAP
Constant to represent open authentication with MAC authentication or EAP.

See Also:
Constant Field Values

DISABLE_SHARED_AUTHENTICATION

public static final int DISABLE_SHARED_AUTHENTICATION
Constant to represent that shared authentication is disabled.

See Also:
Constant Field Values

SHARED_AUTHENTICATION_NO_ADDITION

public static final int SHARED_AUTHENTICATION_NO_ADDITION
Constant to represent shared authentication without any addition.

See Also:
Constant Field Values

SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION

public static final int SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION
Constant to represent shared authentication with MAC authentication.

See Also:
Constant Field Values

SHARED_AUTHENTICATION_WITH_EAP

public static final int SHARED_AUTHENTICATION_WITH_EAP
Constant to represent shared authentication with EAP.

See Also:
Constant Field Values

SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP

public static final int SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP
Constant to represent shared authentication with MAC authentication and EAP.

See Also:
Constant Field Values

DISABLE_NETWORK_EAP

public static final int DISABLE_NETWORK_EAP
Constant to represent that network level EAP is disabled.

See Also:
Constant Field Values

NETWORK_EAP_NO_ADDITION

public static final int NETWORK_EAP_NO_ADDITION
Constant to represent network EAP without any addition.

See Also:
Constant Field Values

NETWORK_EAP_WITH_MAC_AUTHENTICATION

public static final int NETWORK_EAP_WITH_MAC_AUTHENTICATION
Constant to represent network EAP with MAC authentication.

See Also:
Constant Field Values
Constructor Detail

AuthenticationSettings

public AuthenticationSettings()
Creates a new instance of AuthenticationSettings

Method Detail

setOpenAuthenticationType

public void setOpenAuthenticationType(int openAuthType)
Sets the type of open authentication

Parameters:
openAuthType - the type of open authentication.
See Also:
DISABLE_OPEN_AUTHENTICATION, OPEN_AUTHENTICATION_NO_ADDITION, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION, OPEN_AUTHENTICATION_WITH_EAP, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_OR_EAP

getOpenAuthenticationType

public int getOpenAuthenticationType()
Fetches the type of open authentication.

Returns:
open authentication type.
See Also:
DISABLE_OPEN_AUTHENTICATION, OPEN_AUTHENTICATION_NO_ADDITION, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION, OPEN_AUTHENTICATION_WITH_EAP, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP, OPEN_AUTHENTICATION_WITH_MAC_AUTHENTICATION_OR_EAP

getSharedAuthenticationType

public int getSharedAuthenticationType()
Fetches the type of shared authentication.

Returns:
shared authentication type.
See Also:
DISABLE_SHARED_AUTHENTICATION, SHARED_AUTHENTICATION_NO_ADDITION, SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION, SHARED_AUTHENTICATION_WITH_EAP, SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP

setSharedAuthenticationType

public void setSharedAuthenticationType(int sharedAuthType)
Sets the type of shared authentication

Parameters:
sharedAuthType - the type of shared authentication.
See Also:
DISABLE_SHARED_AUTHENTICATION, SHARED_AUTHENTICATION_NO_ADDITION, SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION, SHARED_AUTHENTICATION_WITH_EAP, SHARED_AUTHENTICATION_WITH_MAC_AUTHENTICATION_AND_EAP

getNetworkEAPAuthType

public int getNetworkEAPAuthType()
Fetches the type of EAP authentication.

Returns:
EAP authentication type
See Also:
DISABLE_NETWORK_EAP, NETWORK_EAP_NO_ADDITION, NETWORK_EAP_WITH_MAC_AUTHENTICATION

setNetworkEAPType

public void setNetworkEAPType(int eapAuthType)
Sets the type of EAP authentication

Parameters:
eapAuthType - the type of EAP authentication.
See Also:
DISABLE_NETWORK_EAP, NETWORK_EAP_NO_ADDITION, NETWORK_EAP_WITH_MAC_AUTHENTICATION

getWPAPSK

public java.lang.String getWPAPSK()
Returns the PreSharedKey which has been set using setWPAPSK(String). Empty String will be returned while fetching the Authentication details from Access Points.Suppported only for Ericsson Devices as of now.


setWPAPSK

public void setWPAPSK(java.lang.String key)
Method to set the WPA PreShared Key. Suppported only for Ericsson Devices as of now.


setMACRadiusServers

public void setMACRadiusServers(java.util.List rsList)
Sets the list of Radius servers that are to be used for MAC authentication.

Parameters:
rsList - the list of radius servers

getMACRadiusServers

public java.util.List getMACRadiusServers()
Fetches the list of Radius Servers that are used for MAC authentication.

Returns:
the list of radius servers used for MAC authentication.

setEAPRadiusServers

public void setEAPRadiusServers(java.util.List list)
Sets the list of Radius servers that are to be used for EAP.

Parameters:
list - the list of radius servers

getEAPRadiusServers

public java.util.List getEAPRadiusServers()
Fetches the list of Radius Servers that are used for MAC authentication.

Returns:
the list of radius servers.

isMACAuthEnabled

public boolean isMACAuthEnabled()
Says whether the MAC Authentication is enabled.


isSharedAuthEnabled

public boolean isSharedAuthEnabled()
Says whether the Shared Auth is enabled.


isOpenAuthEnabled

public boolean isOpenAuthEnabled()
Says whether the Open MAC Authentication is enabled.


isNetworkEAPEnabled

public boolean isNetworkEAPEnabled()
Says whether the EAP Authentication is enabled.


isWPAPSKEnabled

public boolean isWPAPSKEnabled()
Says whether the WPA PSK is enabled or not. Supported only for Ericsson Devices as of now.


getData

public java.lang.Object getData()
Used for internal purposes.


toString

public java.lang.String toString()
Method that gives you the String transformation of this Object.


AdventNet WiFi Mediation API, v1.0

Copyright © 2005 AdventNet Inc. All Rights Reserved.