decaf::internal::security::Engine Class Reference

The Engine class serves as a convenience class for classes in the Decaf Security package. More...

#include <src/main/decaf/internal/security/Engine.h>

Public Member Functions
	Engine (const std::string &serviceName)
virtual	~Engine ()
std::string	getServiceName () const
	Returns the name of the service type that this Engine will be a builder of SecuritySpi instances for.
const decaf::security::Provider *	getProvider () const
	Returns the Provider associated with this Engine.
decaf::security::SecuritySpi *	newInstance (const std::string &algorithmName)
	Return a new instance of the SercuritySpi implementation that is named by this engine's serviceName and the passed algorithmName.

---

Detailed Description

The Engine class serves as a convenience class for classes in the Decaf Security package.

An engine can be created for a given service type, "MessageDigest" for instance and reused to create different algorithms for that type. The Engine class takes care of the details of looking up a ProviderService in the Security Runtime, using correct locking and exception handling so that the higher level classes don't need to implement that logic over again.

---

Constructor & Destructor Documentation

decaf::internal::security::Engine::Engine

(

const std::string &

serviceName

)

virtual decaf::internal::security::Engine::~Engine

(

)

[virtual]

---

Member Function Documentation

const decaf::security::Provider* decaf::internal::security::Engine::getProvider

(

)

const [inline]

Returns the Provider associated with this Engine.

The pointer returned by this method remains the property of the Security framework and should be deleted by the calling application at any time.

Returns:

the provider associated with this MessageDigest.

std::string decaf::internal::security::Engine::getServiceName

(

)

const [inline]

Returns the name of the service type that this Engine will be a builder of SecuritySpi instances for.

Returns:

the service class name of this engine, e.g. MessageDigest.

decaf::security::SecuritySpi* decaf::internal::security::Engine::newInstance

(

const std::string &

algorithmName

)

Return a new instance of the SercuritySpi implementation that is named by this engine's serviceName and the passed algorithmName.

Returns:

a new instance of the SecuritySpi provided by serviceName.algorithmName

---

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

• src/main/decaf/internal/security/Engine.h