gov.va.med.vistalink.security

Interface VistaLoginModuleSPI

public interface VistaLoginModuleSPI

A service provider interface (SPI) definition for implementing back-end services for Kernel/M-based logins. The class defines all the methods necessary to provide back-end Kernel services for the VistaLoginModule.

See Also:

VistaLoginModule

Method Summary

Modifier and Type	Method and Description
void	addSPISpecificInformationToPrincipal(VistaKernelPrincipalImpl principal) Adds any SPI-specific information to the JAAS / Kernel user principal.
SecurityVOChangeVc	changeVerifyCode(String oldVerifyCode, String newVerifyCode, String newVerifyCodeCheck) Performs the change verify code portion of login
SecurityVOLogon	doKernelLogon(String kernelCcowLogonToken) Performs the credential submission/verification portion of login
SecurityVOLogon	doKernelLogon(String accessCode, String verifyCode, boolean requestCvc) Performs the credential submission/verification portion of login
String	getKernelCcowToken() retrieves a Kernel login token for a particular user to place in the CCOW user context
String	getSecureCcowPasscode() retrieves the CCOW login passcode from the M system
Object	getSetupAndIntroTextInfo() Performs setup, retrieves setup-related information and system introductory test.
SecurityVOUserDemographics	getUserDemographicsData() retrieves user demographics from the Kernel system
void	initialize(Map jaasOptions, Map jaasSharedState) Perform any initialization needed for this class.
void	logout() Performs a logout, including any actions needed on the Kernel/M system necessary to log the user out.
SecurityVOSelectDivision	selectDivision(String selectedDivisionIen) Performs the select division portion of login

Method Detail

initialize

void initialize(Map jaasOptions,
                Map jaasSharedState)
         throws Exception

Perform any initialization needed for this class. Ideally all input information needed for initialization would be provided via options in the JAAS configuration.

Parameters:

jaasOptions - Map of JAAS options

Throws:

Exception - thrown for initialization errors

getSetupAndIntroTextInfo

Object getSetupAndIntroTextInfo()
                         throws Exception

Performs setup, retrieves setup-related information and system introductory test.

Returns:

can return either SecurityVOSetupAndIntroText (normal operation) or SecurityDataLogonResponse (if Kernel Auto-Signon is invoked).

Throws:

Exception - if error encountered

doKernelLogon

SecurityVOLogon doKernelLogon(String kernelCcowLogonToken)
                       throws Exception

Performs the credential submission/verification portion of login

Parameters:

kernelCcowLogonToken - Kernel CCOW login token (in lieu of access/verify code)

Returns:

@throws Exception if an error encountered

Throws:

Exception

doKernelLogon

SecurityVOLogon doKernelLogon(String accessCode,
                              String verifyCode,
                              boolean requestCvc)
                       throws Exception

Performs the credential submission/verification portion of login

Parameters:

accessCode - access code

verifyCode - verify code

requestCvc - true if user wants to change verify code, false if not

Returns:

@throws Exception if an error encountered

Throws:

Exception

changeVerifyCode

SecurityVOChangeVc changeVerifyCode(String oldVerifyCode,
                                    String newVerifyCode,
                                    String newVerifyCodeCheck)
                             throws Exception

Performs the change verify code portion of login

Parameters:

oldVerifyCode - old verify code

newVerifyCode - new verify code

newVerifyCodeCheck - new verify code check

Returns:

@throws VistaLoginModuleException if error encountered

Throws:

Exception

selectDivision

SecurityVOSelectDivision selectDivision(String selectedDivisionIen)
                                 throws Exception

Performs the select division portion of login

Parameters:

selectedDivisionIen - IEN of division selected by user

Returns:

@throws VistaLoginModuleException if an error encountered

Throws:

Exception

getUserDemographicsData

SecurityVOUserDemographics getUserDemographicsData()
                                            throws Exception

retrieves user demographics from the Kernel system

Returns:

@throws VistaLoginModuleException if an error encountered

Throws:

Exception

getSecureCcowPasscode

String getSecureCcowPasscode()
                      throws Exception

retrieves the CCOW login passcode from the M system

Returns:

@throws VistaLoginModuleException if an error encountered

Throws:

Exception

getKernelCcowToken

String getKernelCcowToken()
                   throws Exception

retrieves a Kernel login token for a particular user to place in the CCOW user context

Returns:

@throws VistaLoginModuleException if an error encountered

Throws:

Exception

addSPISpecificInformationToPrincipal

void addSPISpecificInformationToPrincipal(VistaKernelPrincipalImpl principal)
                                   throws Exception

Adds any SPI-specific information to the JAAS / Kernel user principal.

Parameters:

principal - JAAS principal

Throws:

Exception

logout

void logout()
     throws Exception

Performs a logout, including any actions needed on the Kernel/M system necessary to log the user out.

Throws:

Exception