Table of Contents

Module: spi ./src/peak/naming/spi.py

Service Provider Interface

Core functions for implementing naming services. These are Pythonic equivalents to some of the static methods provided by NamingManager and DirectoryManager in the JNDI javax.naming.spi package. For Python, it makes more sense to have these as module-level functions than as static methods of classes.

Note that if you just want to use naming services, you don't need to worry about this. These are just a few simple "policy" methods that control how initial context and URL context objects are created, based on component properties. They simplify the implementation of context objects by allowing them to focus on their own issues instead of on framework-oriented concerns.

Imported modules   
from interfaces import *
from names import NNS_Reference
from peak.api import adapt, protocols
from peak.binding.interfaces import IComponentFactory
from peak.util.imports import importObject
Functions   
getInitialContext
getURLContext
  getInitialContext 
getInitialContext (
        parentComponent,
        componentName=None,
        **options,
        )

Create initial context for parent, w/component name and options

The type of initial context created is determined by asking the supplied parentComponent for its peak.naming.initialContextFactory property, which will be treated as an import string if it is of string type. (Note: the property name used is available as the constant naming.INIT_CTX_FACTORY, if you want to provide an attribute binding for it.)

Keyword options and the component name desired for the initial context are passed through to the actual factory, along with the parent component and component name. If a creationParent argument is not supplied, it will be defaulted to parentComponent, in order to establish the parent component for any newly created objects retrieved from the resulting context object.

  getURLContext 
getURLContext (
        parent,
        scheme,
        iface,
        componentName=None,
        **options,
        )

Return a context object for the given URL scheme and interface

This is done by looking up scheme in the peak.naming.schemes.* property namespace. (That is, the '"ldap:' URL scheme is retrieved from the peak.naming.schemes.ldap property. Per RFC 1738, the lowercase form of the scheme name is always used; note that the ';' should not be included in the scheme name.) The property value found, if a string, will be treated as an import specification, and the relevant object imported.

The property value or imported object must do one of the following:

  • Implement naming.IURLContextFactory, in which case its getURLContext() method will be called with the same arguments as supplied to this function.

  • Be a class whose instances implement the requested context interface (e.g. naming.IBasicContext), in which case an instance will be constructed and returned, using parent as its parent component, and componentName as its name. (Note that the class must also implement the binding.IComponentFactory constructor signature for this to work.)

  • Be a class whose instances implement naming.IAddress, in which case a generic AddressContext will be returned, with its schemeParser set to the appropriate address class.

If none of these conditions apply, or the property isn't found in the first place, this function returns None, as per the naming.IURLContextFactory interface.


Table of Contents

This document was automatically generated on Mon Jun 17 01:11:11 2019 by HappyDoc version 2.1