twisted.web.woven.guard.UsernamePasswordWrapper : API documentation

I bring a twisted.cred Portal to the web. Use me to provide different Resources (usually entire pages) based on a user's authentication details.

A UsernamePasswordWrapper is a Resource, and is usually wrapped in a SessionWrapper before being inserted into the site tree.

The Realm associated with your Portal should be prepared to accept a request for an avatar that implements the twisted.web.resource.IResource interface. This avatar should probably be something like a Woven Page. That is, it should represent a whole web page. Once you return this avatar, requests for it's children do not go through guard.

If you want to determine what unauthenticated users see, make sure your Portal has a checker associated that allows anonymous access. (See twisted.cred.checkers.AllowAnonymousAccess)

Method	__init__	Constructs a UsernamePasswordWrapper around the given portal.
Method	getChild	Retrieve a 'child' resource from me.
Method	_ebFilter	Undocumented

Inherited from Resource:

Method	listStaticNames	Undocumented
Method	listStaticEntities	Undocumented
Method	listNames	Undocumented
Method	listEntities	Undocumented
Method	listDynamicNames	Undocumented
Method	listDynamicEntities	Undocumented
Method	getStaticEntity	Undocumented
Method	getDynamicEntity	Undocumented
Method	delEntity	Undocumented
Method	reallyPutEntity	Undocumented
Method	getChildWithDefault	Retrieve a static or dynamically generated child resource from me.
Method	getChildForRequest	Undocumented
Method	putChild	Register a static child.
Method	render	Render a given resource. See `IResource`'s render method.
Method	render_HEAD	Default handling of HEAD method.

def __init__(self, portal, callback=None, errback=None): (source)

overrides twisted.web.resource.Resource.__init__

Constructs a UsernamePasswordWrapper around the given portal.

Parameters	portal	A cred portal for your web application. The checkers associated with this portal must be able to accept username/password credentials. (type: `twisted.cred.portal.Portal` )
	callback	Gets called after a successful login attempt. A resource that redirects to "." will display the avatar resource. If this parameter isn't provided, defaults to a standard Woven "Thank You" page. (type: A callable that accepts a Woven `model` and returns a `IResource`. )
	errback	Gets called after a failed login attempt. If this parameter is not provided, defaults to a the standard Woven form error (i.e. The original form on a page of its own, with errors noted.) (type: A callable that accepts a Woven `model` and returns a `IResource`. )

def getChild(self, path, request): (source)

overrides twisted.web.resource.Resource.getChild

Retrieve a 'child' resource from me.

Implement this to create dynamic resource generation -- resources which are always available may be registered with self.putChild().

This will not be called if the class-level variable 'isLeaf' is set in your subclass; instead, the 'postpath' attribute of the request will be left as a list of the remaining path elements.

For example, the URL /foo/bar/baz will normally be:

 | site.resource.getChild('foo').getChild('bar').getChild('baz').

However, if the resource returned by 'bar' has isLeaf set to true, then the getChild call will never be made on it.

Parameters	path	a string, describing the child
	request	a twisted.web.server.Request specifying meta-information about the request that is being made for this child.

t.w.w.g.UsernamePasswordWrapper(Resource) : class documentation