Package com.sun.identity.authentication.modules.msisdn

Class MSISDN

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.msisdn.MSISDN

All Implemented Interfaces:

LoginModule

public class MSISDN
extends AMLoginModule

MSISDN Authentication module retrieves the device's msisdn number and the Wireless gateway sending the request from the ServletRequest. If the values cannot be retrieved then callbacks to get msisdn number and wap gateway are sent back to the client. The WAP Gateway is validated against a list of valid gateways in the gateway list attribute. If the gateway list attribute is empty then all gateways will trusted , if it is "none" then no gateways will be trusted and if specific values are specified only those gateways will be trusted. Once the gateway is validated the msisdn number is searched for in the repository. This module is written to lookup the msisdn number in LDAP and return the user ID which has the msisdn number.

Field Summary

Fields inherited from class com.sun.identity.authentication.spi.AMLoginModule

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor	Description
MSISDN()

Method Summary

Modifier and Type	Method	Description
void	destroyModuleState()	Cleans up module state.
Principal	getPrincipal()	Returns the User Principal.
void	init(Subject subject, Map sharedState, Map options)	Retrieves the service schema attributes for the module and initializes the configuration, including locale and getting the resource bundle.
void	nullifyUsedVars()	TODO-JAVADOC
int	process(Callback[] callbacks, int state)	Validates the authentication credentials.

Methods inherited from class com.sun.identity.authentication.spi.AMLoginModule

abort, clearInfoText, commit, createIdentity, forceCallbacksInit, getAMIdentityRepository, getAttribute, getAuditEntryDetail, getAuthenticatedPrincipals, getAuthLevel, getCallback, getCallback, getCallbackHandler, getCurrentState, getFailCount, getHttpServletRequest, getHttpServletResponse, getInfoText, getLocale, getLoginLocale, getLoginState, getMaximumFailCount, getNewUserIDs, getNumberOfStates, getOrgProfile, getOrgServiceTemplate, getPwdKey, getRequestOrg, getServiceConfig, getSessionId, getSSOSession, getUserAliasList, getUserKey, getUserProfile, getUserSessionProperty, getUserSessions, incrementFailCount, initialize, isAccountLocked, isDynamicProfileCreationEnabled, isRequired, isSessionQuotaReached, isSharedStateEnabled, isSuperAdmin, isUseFirstPassEnabled, isValidUserEntry, login, logout, replaceCallback, replaceHeader, resetCallback, resetCurrentState, setAuthLevel, setFailureID, setForceCallbacksRead, setLoginFailureURL, setLoginSuccessURL, setModuleErrorTemplate, setOrg, setSharedStateEnabled, setUserAttributes, setUserSessionProperty, storeUsername, storeUsernamePasswd, substituteHeader, substituteInfoText, validatePassword, validateUserName

Methods inherited from class java.lang.Object

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

Constructor Detail

MSISDN

public MSISDN()

Method Detail

init

public void init(Subject subject,
                 Map sharedState,
                 Map options)

Retrieves the service schema attributes for the module and initializes the configuration, including locale and getting the resource bundle.

Specified by:

init in class AMLoginModule

Parameters:

subject - Subject to be authenticated.

sharedState - State shared with other configured LoginModules.

options - Options specified in the login Configuration for this particular LoginModule.

process

public int process(Callback[] callbacks,
                   int state)
            throws AuthLoginException

Validates the authentication credentials.

Specified by:

process in class AMLoginModule

Parameters:

callbacks -

state -

Returns:

ISAuthConstants.LOGIN_SUCCEED on login success

Throws:

AuthLoginException

getPrincipal

public Principal getPrincipal()

Returns the User Principal.

Specified by:

getPrincipal in class AMLoginModule

Returns:

MSISDN Principal.

destroyModuleState

public void destroyModuleState()

Cleans up module state.

Overrides:

destroyModuleState in class AMLoginModule

nullifyUsedVars

public void nullifyUsedVars()

TODO-JAVADOC

Overrides:

nullifyUsedVars in class AMLoginModule