activemq-cpp-3.9.0
decaf::internal::security::SecurityRuntime Class Reference

Internal class used to manage Security related resources and hide platform dependent calls from the higher level API. More...

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

Public Member Functions

virtual ~SecurityRuntime ()
 
ServiceRegistrygetServiceRegistry ()
 Return the Security Framework's Service Registry. More...
 
decaf::util::concurrent::MutexgetRuntimeLock ()
 Gets a pointer to the Security Runtime's Lock object, this can be used by Security layer APIs to synchronize around certain actions such as adding a resource to the Security layer, etc. More...
 

Static Public Member Functions

static SecurityRuntimegetSecurityRuntime ()
 Gets the one and only instance of the Security class, if this is called before the Security layer has been initialized or after it has been shutdown then an IllegalStateException is thrown. More...
 
static void initializeSecurity ()
 Initialize the Security layer. More...
 
static void shutdownSecurity ()
 Shutdown the Security layer and free any associated resources, classes in the Decaf library that use the Security layer will now fail if used after calling the shutdown method. More...
 

Protected Member Functions

 SecurityRuntime ()
 

Detailed Description

Internal class used to manage Security related resources and hide platform dependent calls from the higher level API.

Since
1.0

Constructor & Destructor Documentation

decaf::internal::security::SecurityRuntime::SecurityRuntime ( )
protected
virtual decaf::internal::security::SecurityRuntime::~SecurityRuntime ( )
virtual

Member Function Documentation

decaf::util::concurrent::Mutex* decaf::internal::security::SecurityRuntime::getRuntimeLock ( )

Gets a pointer to the Security Runtime's Lock object, this can be used by Security layer APIs to synchronize around certain actions such as adding a resource to the Security layer, etc.

The pointer returned is owned by the Security runtime and should not be deleted or copied by the caller.

Returns
a pointer to the Security Runtime's single Lock instance.
static SecurityRuntime* decaf::internal::security::SecurityRuntime::getSecurityRuntime ( )
static

Gets the one and only instance of the Security class, if this is called before the Security layer has been initialized or after it has been shutdown then an IllegalStateException is thrown.

Returns
pointer to the Security runtime for the Decaf library.
ServiceRegistry* decaf::internal::security::SecurityRuntime::getServiceRegistry ( )

Return the Security Framework's Service Registry.

Returns
a pointer to the frameworks Service Registry.
static void decaf::internal::security::SecurityRuntime::initializeSecurity ( )
static

Initialize the Security layer.

static void decaf::internal::security::SecurityRuntime::shutdownSecurity ( )
static

Shutdown the Security layer and free any associated resources, classes in the Decaf library that use the Security layer will now fail if used after calling the shutdown method.


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