Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

xmltooling::XMLToolingInternalConfig Class Reference

OFF More...

#include <xmltooling/internal.h>

Inheritance diagram for xmltooling::XMLToolingInternalConfig:

xmltooling::XMLToolingConfig xmltooling::Lockable List of all members.

Public Member Functions

bool init ()
 Initializes library.
void term ()
 Shuts down library.
Lockable * lock ()
 Lock the associated object for exclusive access.
void unlock ()
 Unlock the associated object from exclusive access.
bool load_library (const char *path, void *context=NULL)
 Loads a shared/dynamic library extension.
bool log_config (const char *config=NULL)
 Configure logging system.
ParserPool & getParser () const
 Obtains a non-validating parser pool.
ParserPool & getValidatingParser () const
 Obtains a validating parser pool.
XSECCryptoX509CRL * X509CRL () const
 Returns an X.509 CRL implementation object.
std::pair< const char *, unsigned
int > 
mapXMLAlgorithmToKeyAlgorithm (const XMLCh *xmlAlgorithm) const
 Maps an XML Signature/Encryption algorithm identifier to a library-specific key algorithm and size for use in resolving credentials.
void registerXMLAlgorithm (const XMLCh *xmlAlgorithm, const char *keyAlgorithm, unsigned int size=0)
 Registers an XML Signature/Encryption algorithm identifier against a library-specific key algorithm and size for use in resolving credentials.
void registerXMLAlgorithms ()

Static Public Member Functions

XMLToolingInternalConfig & getInternalConfig ()

Public Attributes

XSECProvider * m_xsecProvider

Detailed Description

OFF


Member Function Documentation

ParserPool& xmltooling::XMLToolingInternalConfig::getParser (   )  const [inline, virtual]
 

Obtains a non-validating parser pool.

Library must be initialized first.

Returns:
reference to a non-validating parser pool.

Implements xmltooling::XMLToolingConfig.

ParserPool& xmltooling::XMLToolingInternalConfig::getValidatingParser (   )  const [inline, virtual]
 

Obtains a validating parser pool.

Library must be initialized first. Schema/catalog registration must be externally synchronized.

Returns:
reference to a validating parser pool.

Implements xmltooling::XMLToolingConfig.

bool xmltooling::XMLToolingInternalConfig::init (   )  [virtual]
 

Initializes library.

Each process using the library MUST call this function exactly once before using any library classes except for the LogConfig method.

Returns:
true iff initialization was successful

Implements xmltooling::XMLToolingConfig.

bool xmltooling::XMLToolingInternalConfig::load_library (  const char *  path,
void *  context = NULL
)  [virtual]
 

Loads a shared/dynamic library extension.

Extension libraries are managed using a pair of "C" linkage functions:
extern "C" int xmltooling_extension_init(void* context);
extern "C" void xmltooling_extension_term();

This method is internally synchronized.

Parameters:
path pathname of shared library to load into process
context arbitrary data to pass to library initialization hook
Returns:
true iff library was loaded successfully

Implements xmltooling::XMLToolingConfig.

Lockable* xmltooling::XMLToolingInternalConfig::lock (   )  [virtual]
 

Lock the associated object for exclusive access.

Returns:
a pointer to the object being locked

Implements xmltooling::Lockable.

bool xmltooling::XMLToolingInternalConfig::log_config (  const char *  config = NULL  )  [virtual]
 

Configure logging system.

May be called first, before initializing the library. Other calls to it must be externally synchronized.

Parameters:
config either a logging configuration file, or a level from the set (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
Returns:
true iff configuration was successful

Implements xmltooling::XMLToolingConfig.

std::pair<const char*,unsigned int> xmltooling::XMLToolingInternalConfig::mapXMLAlgorithmToKeyAlgorithm (  const XMLCh *  xmlAlgorithm  )  const [inline, virtual]
 

Maps an XML Signature/Encryption algorithm identifier to a library-specific key algorithm and size for use in resolving credentials.

Parameters:
xmlAlgorithm XML Signature/Encryption algorithm identifier
Returns:
a general key algorithm and key size (or 0 if the size is irrelevant)

Implements xmltooling::XMLToolingConfig.

void xmltooling::XMLToolingInternalConfig::registerXMLAlgorithm (  const XMLCh *  xmlAlgorithm,
const char *  keyAlgorithm,
unsigned int  size = 0
)  [inline, virtual]
 

Registers an XML Signature/Encryption algorithm identifier against a library-specific key algorithm and size for use in resolving credentials.

Parameters:
xmlAlgorithm XML Signature/Encryption algorithm identifier
keyAlgorithm a key algorithm
size a key size (or 0 if the size is irrelevant)

Implements xmltooling::XMLToolingConfig.

void xmltooling::XMLToolingInternalConfig::term (   )  [virtual]
 

Shuts down library.

Each process using the library SHOULD call this function exactly once before terminating itself

Implements xmltooling::XMLToolingConfig.


The documentation for this class was generated from the following file:
Generated on Wed Jun 17 16:50:44 2009 for xmltooling by  doxygen 1.3.9.1