#include <GUIClientImpl.h>

Public Member Functions
	GUIClientImpl (MainDialog *parent)

bool	connect (tstring host)

void	setUserData (ConnectPromptInfo &ConnectPrompt)

Public Member Functions inherited from ClientIfc
bool	attach (ClientType clientType=ClientType_GUI, bool requestFullCapabilities=true, bool suppressAutoConnect=true)

void	detach ()

void	ProcessEvents ()

bool	hasFullCapabilities ()

bool	isConnected (bool bSilent=false)

bool	isAvailable ()

bool	isVPNServiceAvailable ()

bool	isOperatingMode (OperatingMode opMode)

std::list< tstring >	getHostNames ()

tstring	getDefaultHostName ()

bool	connect (tstring host)

bool	connect (tstring host, unsigned int origin)

bool	setNewTunnelGroup (const tstring &group)

void	disconnect ()

void	cancel ()

void	getState ()

void	getStats ()

void	resetStats ()

void	startStats ()

void	stopStats ()

void	exportStats (const tstring &tstrFilePath)

void	setBannerResponse (bool bAccepted)

void	setPreConnectReminderResponse ()

void	setCertBlockedResponse (bool bUnblock)

void	setCertWarningResponse (bool bConnect, bool bImportCert)

void	UserSubmit ()

std::shared_ptr< PreferenceInfo >	getPreferences ()

unsigned int	getPreferencesCount ()

bool	savePreferences (const std::shared_ptr< PreferenceInfo > &spPreferenceInfo)

tstring	getConnectHost ()

void	setLastVpnError (VPNError vpnError)

VPNError	getLastVpnError ()

bool	isConnectRequestActive ()

Public Attributes
tstring	ms_user

tstring	ms_pswd

tstring	ms_group

Protected Member Functions
void	StatsCB (IN VPNStats &stats)

void	StateCB (IN const VPNState state, IN const VPNSubState subState, IN const tstring stateString)

void	BannerCB (IN const tstring &banner)

void	PreConnectReminderCB (const tstring &rtstrPreConnectReminder)

void	NoticeCB (IN const tstring &notice, IN const MessageType type, IN const bool bSensitive=false)

void	ExitNoticeCB (IN const tstring &notice, const int returnCode)

void	ServiceReadyCB ()

void	UserPromptCB (IN ConnectPromptInfo &ConnectPrompt)

void	CertBlockedCB (IN const tstring &rtstrUntrustedServer)

void	CertWarningCB (IN const tstring &rtstrUntrustedServer, IN const std::list< tstring > &rltstrCertErrors, IN bool bAllowImport)

void	EventAvailable ()

Protected Member Functions inherited from ClientIfcBase
virtual void	StatsCB (VPNStats &stats)=0

virtual void	StateCB (const VPNState state, const VPNSubState subState, const tstring stateString)=0

virtual void	BannerCB (const tstring &banner)=0

virtual void	NoticeCB (const tstring &notice, const MessageType type, const bool bSensitive=false)=0

virtual void	ExitNoticeCB (const tstring &tstrNotice, const int returnCode)

virtual void	UserPromptCB (ConnectPromptInfo &ConnectPrompt)=0

virtual void	WMHintCB (const WMHint hint, const WMHintReason reason)

virtual void	deliverWebLaunchHostCB (const tstring &activeHost)

virtual void	CertBlockedCB (const tstring &rtstrUntrustedServer)=0

virtual void	CertWarningCB (const tstring &rtstrUntrustedServer, const std::list< tstring > &rltstrCertErrors, bool bAllowImport)=0

void	ResetQuarantinedReconnect ()

void	ClientIfcTransmigration ()

bool	attach (const ClientType clientType=ClientType_GUI, const bool requestFullCapabilities=true, const bool suppressAutoConnect=true, const bool bSuppressEventAvailableCB=false)

void	detach ()

void	ProcessEvents ()

bool	hasFullCapabilities ()

bool	isConnected (bool bSilent=false)

bool	isAvailable ()

std::list< tstring >	getHostNames ()

std::list< HostEntry >	getHostEntries ()

tstring	getDefaultHostName ()

bool	connect (tstring host)

bool	connect (tstring host, unsigned int origin)

bool	setNewTunnelGroup (const tstring &group)

void	disconnect ()

void	cancel ()

void	resetStats ()

void	getState ()

VPNState	getCurrentVPNState ()

VPNSubState	getCurrentVPNSubState ()

VPNSubState	getPreviousVPNSubState ()

STATE	getCurrentState ()

tstring	getStateText ()

void	setNetworkStates (NETENV_STATE netEnvState, NETCTRL_STATE netCtrlState, NETWORK_TYPE netType, bool bACBrowserForCPRemediation, bool bUpdateUI)

void	refreshOperatingModeForCurrentNetStates ()

NETENV_STATE	getCurrentNetEnvState ()

NETENV_STATE	getPreviousNetEnvState ()

NETCTRL_STATE	getCurrentNetCtrlState ()

NETWORK_TYPE	getCurrentNetType ()

bool	isACBrowserForCPRemediation ()

tstring	getNetworkStatusText (const VPNState state, const VPNSubState subState, const NETENV_STATE netEnvState, const NETCTRL_STATE netCtrlState)

PreferenceInfo &	getPreferences ()

bool	savePreferences ()

void	startStats ()

void	stopStats ()

void	UserSubmit ()

void	setBanner (const tstring &banner)

void	setBannerResponse (bool bResponse)

void	setPreConnectReminder (const tstring &tstrPreConnectReminder)

void	setPreConnectReminderResponse ()

bool	getUserResponse ()

bool	isUserResponseSet ()

void	setCertBlocked (const tstring &tstrUntrustedServer)

void	setCertWarning (const tstring &rtstrUntrustedServer, const std::list< tstring > &rltstrCertErrors, bool bAllowImport)

bool	getCertImportResponse ()

void	setUserPrompt (ConnectPromptInfo &ConnectPrompt)

void	setCertBlockedResponse (bool bUnlock)

void	setCertWarningResponse (bool bConnect, bool bImportCert)

void	insertStateToConnectPrompt (ConnectPromptInfo &ConnectPrompt)

void	ExitNotice (const tstring &tstrNotice, const int code=0)

void	notice (const tstring &tstrNotice, const MessageType type=MsgType_Info, bool bClearLastMsg=false, bool bForce=false, bool bStateMsg=false, bool bSensitiveMsg=false)

void	notice (MsgWithArg &notice, const MessageType type=MsgType_Info, bool bClearLastMsg=false, bool bForce=false, bool bStateMsg=false, bool bSensitiveMsg=false)

void	getStats (void)

void	setStats (VPNStats &stats)

void	exportStats (const tstring &tstrFilePath)

void	initState (VPNState state, VPNState previousState, VPNSubState subState)

void	setState (VPNState state, VPNState previousState, VPNSubState subState=VPNSS_NORMAL, bool bUpdateStateMsg=true, bool bOnlyUpdateUI=false)

void	setWMHint (WMHint hint, WMHintReason reason)

bool	isLastConnectType (const ConnectPromptType connPromptType)

bool	isOperatingMode (OperatingMode opMode)

void	setOperatingMode (OperatingMode opMode)

void	unsetOperatingMode (OperatingMode opMode)

bool	CanRemediateCaptivePortal ()

bool	policyAllowsCaptivePortalRemediation ()

bool	isEventShutdown ()

bool	isUsingEventModel ()

time_t	getLastDisconnectTime ()

ConnectPromptInfo	getConnectPromptInfo ()

void	resetConnectPromptPasswordData ()

void	setStandaloneConnection (bool isStandalone)

void	deliverActiveHost (const tstring &activeHost, ConnectProtocolType vpnProtocol=PROTOCOL_TYPE_UNKNOWN, bool bActiveHostFriendlyName=false)

bool	isVPNServiceReady ()

void	resetLastDisconnectTime (time_t time=1)

void	processMinimize ()

void	setEnrollClientCert (CertObj *pCert)

void	linuxCertImportWarnUser ()

void	linuxCertImportWarnUserResponse (bool bAccept)

void	setDefaultHost (tstring &host)

void	setLastVpnError (VPNError vpnError)

VPNError	getLastVpnError ()

bool	requestImportLocalization (const tstring tstrLocale, const std::vector< unsigned char > &MoFileData)

void	startAHS (const unsigned int uiReason, const ProxyIfc &proxy)

void	AHSSelectedHost (const unsigned int uiReason, const std::vector< tstring > &headendList, const long statusReturnCode, const tstring &extraInfo)

std::vector< tstring >	getAHSHostList ()

unsigned int	getAHSState ()

bool	isAHSHasRun ()

bool	IsAHSCachingRestricted ()

bool	suppressConnectionErrorPopups ()

tstring	getCaptivePortalDetectedMsg ()

void	setProxyAuthPrompts (ProxyIfc *pProxy, const tstring &promptMsg)

bool	handleIpcMessage (CIpcMessage *pIpcMessage)

void	signalDisconnectedToEventNtfctnThread ()

bool	IsCsdTokenVerified () const

void	activateConnectMgrTunnelInitiationCompletionEvent ()

bool	isConnectRequestActive ()

bool	isConnectRequestCleanup ()

bool	syncProfileChange (const tstring &profileName)

tstring	getConnectHost ()

tstring	getMgmtTunnelHostname ()

VPN_TUNNEL_SCOPE	getVpnTunnelScope ()

bool	isStandaloneConnection ()

void	sendSSoLogoutPrompt (ConnectPromptInfo &cpi)

void	setExternalSSOLogoutUrlFromAgent (const tstring &logoutUrl)

Protected Attributes
ConnectPromptInfo *	m_pConnectPrompt

MainDialog *	parentWindow

Additional Inherited Members
Static Protected Member Functions inherited from ClientIfcBase
static tstring	getNoticeTypeText (MessageType msgType)

static tstring	getStateText (VPNState state, VPNSubState subState=VPNSS_NORMAL, NETENV_STATE netEnvState=NES_NETWORK_ACCESSIBLE, const tstring &tstrConnectedHost=tstring())

static tstring	getNetCtrlText (NETCTRL_STATE netCtrlState)

static tstring	getNetEnvText (NETENV_STATE netEnvState, bool bSimple=false)

static tstring	getNetTypeText (NETWORK_TYPE netType)

static tstring	getQuarantinedStatusText ()

static tstring	getNetworkStatusSimpleText (const NETENV_STATE netEnvState, const NETCTRL_STATE netCtrlState)

Detailed Description

This is an example application demonstrating the implementation of the AnyConnect API

Constructor & Destructor Documentation

◆ GUIClientImpl()

GUIClientImpl::GUIClientImpl ( MainDialog * parent )

               : m_pConnectPrompt(NULL) 
{
    parentWindow = parent;
}

◆ ~GUIClientImpl()

GUIClientImpl::~GUIClientImpl ( )

virtual

30{ }

Member Function Documentation

◆ BannerCB()

void GUIClientImpl::BannerCB ( IN const tstring & banner )

protected

{
    bool bBannerAccepted = true;
    setBannerResponse(bBannerAccepted);
}

◆ CertBlockedCB()

void GUIClientImpl::CertBlockedCB ( IN const tstring & rtstrUntrustedServer )

protected

{
    setCertBlockedResponse(false);
}

◆ CertWarningCB()

void GUIClientImpl::CertWarningCB	(	IN const tstring &	rtstrUntrustedServer,
		IN const std::list< tstring > &	rltstrCertErrors,
		IN bool	bAllowImport )

protected

{
    setCertWarningResponse(false, false);
}

◆ connect()

bool GUIClientImpl::connect ( tstring host )

{
    me_RequestType = REQ_CONNECT;
 
    // This is the main method for initiating a VPN connection.
    // The method can be found in ClientIfc.
    //
    bool bSuccess = ClientIfc::connect(host);
    if (!bSuccess)
    {
        return false;        
    }
 
    return true;
}

◆ EventAvailable()

void GUIClientImpl::EventAvailable ( )

protectedvirtual

The implementation of this method and subsequent call on MainDialog::HandleEventAvailable demonstrates the posting of an event.

Reimplemented from ClientIfcBase.

{
    parentWindow->HandleEventAvailable();
}

◆ ExitNoticeCB()

void GUIClientImpl::ExitNoticeCB	(	IN const tstring &	notice,
		const int	returnCode )

protected

{
    parentWindow->showStatusbarText(notice.c_str());
}

◆ NoticeCB()

void GUIClientImpl::NoticeCB	(	IN const tstring &	notice,
		IN const MessageType	type,
		IN const bool	bSensitive = false )

protected

{
    parentWindow->showStatusbarText(notice);
}

◆ PreConnectReminderCB()

void GUIClientImpl::PreConnectReminderCB ( const tstring & rtstrPreConnectReminder )

protectedvirtual

If a pre-connect reminder needs to be acknowledged, this CB delivers the pre-connect reminder to the client.

NOTE: Connection establishment will block until the method setPreConnectReminderResponse() is called.

In a GUI, a pre-connect reminder would typically be displayed in a modal dialog with an OK button selection.

See also: setPreConnectReminderResponse() to set the user acknowledgement to the pre-connect reminder message.

Reimplemented from ClientIfcBase.

{
    setPreConnectReminderResponse();
}

◆ ServiceReadyCB()

void GUIClientImpl::ServiceReadyCB ( )

protectedvirtual

Under normal operating conditions, this CB is called as soon as the attach method completes. In case the service (vpn agent) is not ready, this CB is not called until it is.

Any API calls made prior to this CB being called will result in a NoticeCB error message.

Implements ClientIfcBase.

107{ }

◆ setUserData()

void GUIClientImpl::setUserData ( ConnectPromptInfo & ConnectPrompt )

{
    parentWindow->showStatusbarText(ConnectPrompt.getMessage().c_str());
   
    std::list<tstring> promptNames;
    // get the list of PromptEntry received.
    //
    ConnectPrompt.getListPromptNames(promptNames);
 
    std::list<tstring> :: iterator name_iter;
    for (name_iter = promptNames.begin();
                     name_iter != promptNames.end(); ++name_iter)
    {
        PromptEntry *entry = ConnectPrompt.getPromptEntry(*name_iter);
 
        // For this demo program, we'll assume any combo box is for
        // group selection.
        //
        if (entry->getPromptType() == Prompt_Combo)
        {
            entry->setValue(ms_group);
        }
 
        tstring promptName = entry->getPromptName();
        if (promptName == L"username")
        {
            entry->setValue(ms_user);
        }
        else if (promptName == L"password")
        {
            entry->setValue(ms_pswd);
        }
    }
}

◆ StateCB()

void GUIClientImpl::StateCB	(	IN const VPNState	state,
		IN const VPNSubState	subState,
		IN const tstring	stateString )

protected

{
    parentWindow->showStatusbarText(stateString);
}

◆ StatsCB()

void GUIClientImpl::StatsCB ( IN VPNStats & stats )

protected

51{ }

◆ UserPromptCB()

void GUIClientImpl::UserPromptCB ( IN ConnectPromptInfo & ConnectPrompt )

protected

{
    parentWindow->HandlePromptCB(ConnectPrompt);
 
     if (me_RequestType == REQ_CONNECT)
     {
        // for example purposes, only allow one try at setting user data
        //
        me_RequestType = REQ_END;
 
        // look for requested user input fields and fill in previously
        // stored values.
        //
        setUserData(ConnectPrompt);
 
        // now that the user data has been entered, submit the response.
        //
        UserSubmit();
    }
}

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIClientImpl()

◆ ~GUIClientImpl()

Member Function Documentation

◆ BannerCB()

◆ CertBlockedCB()

◆ CertWarningCB()

◆ connect()

◆ EventAvailable()

◆ ExitNoticeCB()

◆ NoticeCB()

◆ PreConnectReminderCB()

◆ ServiceReadyCB()

◆ setUserData()

◆ StateCB()

◆ StatsCB()

◆ UserPromptCB()