Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

DefaultOperationalContext Class Reference

#include <coherence/net/DefaultOperationalContext.hpp>

Inherits Object, and OperationalContext.

List of all members.


Detailed Description

The DefaultOperationalContext provides an OperationalContext with information obtained from XML in coherence.dtd format, system properties (as set through environment variables) and default values.

Author:
phf 2010.10.28
Since:
Coherence 3.7
 

Public Types

enum  ProductEdition
 Extend editions.
typedef spec::Handle Handle
 DefaultOperationalContext Handle definition.
typedef spec::View View
 DefaultOperationalContext View definition.
typedef spec::Holder Holder
 DefaultOperationalContext Holder definition.

Public Member Functions

virtual int32_t getEdition () const
 Get the product edition.

Returns:
the product edition
virtual String::View getEditionName () const
 Get the product edition in a formatted string.

Returns:
the product edition in a formatted string
virtual Member::View getLocalMember () const
 Return a Member object representing this process.

Returns:
the local Member
virtual Map::View getFilterMap () const
 Return a Map of network filter factories.

Returns:
a Map of WrapperStreamFactory instances keyed by filter name
virtual
IdentityAsserter::View 
getIdentityAsserter () const
 Return an IdentityAsserter that can be used to establish a user's identity.

Returns:
the IdentityAsserter
virtual
IdentityTransformer::View 
getIdentityTransformer () const
 Return an IdentityTransformer that can be used to transform a Subject into an identity assertion.

Returns:
the IdentityTransformer
virtual bool isSubjectScopingEnabled () const
 Indicates if Subject scoping is enabled.

Returns:
true if subject scoping is enabled
virtual int32_t getLogLevel () const
 Return the logging severity level.

Returns:
the logging severity level
virtual int32_t getLogCharacterLimit () const
 Return the maximum number of characters for a logger daemon to queue before truncating.

Returns:
the maximum number of characters for a logger daemon to queue before truncating
virtual String::View getLogMessageFormat () const
 Return the log message format.

Returns:
the log message format
virtual String::View getLogDestination () const
 Return the destination for log messages.

Returns:
the destination for log messages

Static Public Member Functions

static
XmlDocument::Handle 
getDefaultOperationalConfig ()
 The default XML configuration used when one isn't explicitly passed in the constructor for this class.

Protected Member Functions

 DefaultOperationalContext (XmlElement::View vXmlCoherence=NULL)
 Create a new DefaultOperationalContext.

Protected Attributes

int32_t m_nEdition
 The configured edition.
FinalView< Stringm_vsEdition
 The configured edition in a formatted string for use by the Logger.
FinalView< Mapm_vFilterMap
 The configured Filter map.
FinalView< Memberm_vMemberLocal
 The configured local member.
FinalView
< IdentityAsserter
m_vAsserter
 The configured IdentityAsserter that validates a token in order to establish a user's identity.
FinalView
< IdentityTransformer
m_vTransformer
 The configured IdentityTransformer that transforms a Subject into a token that asserts a user's identity.
bool m_fSubjectScoped
 True iff subject scope configuration is set to true.
int32_t m_nLogLevel
 The configured logging severity level.
int32_t m_nLogCharacterLimit
 The the maximum number of characters for a logger daemon to queue before truncating.
FinalView< Stringm_vsLogMessageFormat
 The configured log message format.
FinalView< Stringm_vsLogDestination
 The configured destination for log messages.

Constructor & Destructor Documentation

DefaultOperationalContext ( XmlElement::View  vXmlCoherence = NULL  )  [protected]

Create a new DefaultOperationalContext.

Parameters:
 vXmlCoherence an XML element corresponding to coherence.dtd


Member Function Documentation

static XmlDocument::Handle getDefaultOperationalConfig (  )  [static]

The default XML configuration used when one isn't explicitly passed in the constructor for this class.

Returns:
the default XML configuration


Member Data Documentation

FinalView<Map> m_vFilterMap [protected]

The configured Filter map.

See OperationalContext::getFilterMap() for a description of the keys and values.


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.