IceSSL::Plugin Class Reference

Represents the IceSSL plug-in object. More...

#include <IceSSL/IceSSL.h>

Inheritance diagram for IceSSL::Plugin:

Collaboration diagram for IceSSL::Plugin:

Public Member Functions
virtual CertificatePtr	decode (const std::string &str) const =0
	Decode a certificate from a string that uses the PEM encoding format.
virtual CertificatePtr	load (const std::string &file) const =0
	Load the certificate from a file.
virtual void	setCertificateVerifier (std::function< bool(const std::shared_ptr< ConnectionInfo > &)> v)=0
	Establish the certificate verifier object.
virtual void	setPasswordPrompt (std::function< std::string()> p)=0
	Establish the password prompt object.
virtual	~Plugin ()
Public Member Functions inherited from Ice::Plugin
virtual void	destroy ()=0
	Called when the communicator is being destroyed.
virtual void	initialize ()=0
	Perform any necessary initialization steps.

Detailed Description

Represents the IceSSL plug-in object.

Constructor & Destructor Documentation

~Plugin()

virtual IceSSL::Plugin::~Plugin ( )

virtual

Reimplemented from Ice::Plugin.

Member Function Documentation

decode()

virtual CertificatePtr IceSSL::Plugin::decode ( const std::string & str ) const

pure virtual

Decode a certificate from a string that uses the PEM encoding format.

Parameters

str	A string containing the encoded certificate.

Exceptions

CertificateEncodingException

if an error occurs.

load()

virtual CertificatePtr IceSSL::Plugin::load ( const std::string & file ) const

pure virtual

Load the certificate from a file.

The certificate must use the PEM encoding format.

Parameters

file	The certificate file.

Exceptions

CertificateReadException

if the file cannot be read.

setCertificateVerifier()

virtual void IceSSL::Plugin::setCertificateVerifier ( std::function< bool(const std::shared_ptr< ConnectionInfo > &)> v )

pure virtual

Establish the certificate verifier object.

This should be done before any connections are established.

Parameters

v	The verifier.

setPasswordPrompt()

virtual void IceSSL::Plugin::setPasswordPrompt ( std::function< std::string()> p )

pure virtual

Establish the password prompt object.

This must be done before the plug-in is initialized.

Parameters

p	The password prompt.

---

The documentation for this class was generated from the following file:

• IceSSL/Plugin.h