t.w.c.OldRequestAdapter(pb.Copyable, components.Componentized, object) : class documentation

Part of twisted.web2.compat View Source View In Hierarchy

Implements interfaces: twisted.web.iweb.IRequest

Adapt old requests to new request
Method __init__ Undocumented
Method getStateToCopyFor Gather state to send when I am serialized for a particular perspective.
Method getTypeToCopy Determine what type tag to send for me.
Method registerProducer Undocumented
Method unregisterProducer Undocumented
Method finish Indicate that the response to this request is complete.
Method write Write some data to the body of the response to this request. Response headers are written the first time this method is called, after which new response headers may not be added.
Method getHeader Get an HTTP request header.
Method setHeader Set an outgoing HTTP header.
Method setResponseCode Set the HTTP response code.
Method setLastModified Set the Last-Modified time for the response to this request.
Method setETag Set an entity tag for the outgoing response.
Method getAllHeaders Return dictionary mapping the names of all received headers to the last value received for each.
Method getRequestHostname Get the hostname that the user passed in to the request.
Method getCookie Get a cookie that was sent from the network.
Method addCookie Set an outgoing HTTP cookie.
Method notifyFinish Undocumented
Method getHost Get my originally requesting transport's host.
Method setHost Change the host and port the request thinks it's using.
Method isSecure Return True if this request is using a secure transport.
Method getClientIP Return the IP address of the client who submitted this request.
Method getClient Return the hostname of the IP address of the client who submitted this request, if possible.
Method getUser Return the HTTP user sent with this request, if any.
Method getPassword Return the HTTP password sent with this request, if any.
Method sibLink Return the text that links to a sibling of the requested resource.
Method childLink Return the text that links to a child of the requested resource.
Method redirect Utility function that does a redirect.
Method prePathURL
Method URLPath
Method rememberRootURL Remember the currently-processed part of the URL for later recalling.
Method getRootURL Get a previously-remembered URL.
Method getSession Look up the session associated with this request or create a new one if there is not one.
Method _getFrom Undocumented
Method _getsetFrom Undocumented
Method _getsetHeaders Undocumented
Method _getClientproto Undocumented
Method _getClient Undocumented
Method _getHost Undocumented

Inherited from Copyable:

Method getStateToCopy Gather state to send when I am serialized for a peer.
Method getTypeToCopyFor Determine what type tag to send for me.
Method jellyFor Assemble type tag and state to copy for this broker.

Inherited from Serializable (via Copyable):

Method processUniqueID Return an ID which uniquely represents this object for this process.

Inherited from Jellyable (via Copyable, Serializable):

Method getStateFor Undocumented

Inherited from Componentized:

Method locateAdapterClass Undocumented
Method setAdapter Undocumented
Method addAdapter Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method setComponent Undocumented
Method addComponent Add a component to me, for all appropriate interfaces.
Method unsetComponent Remove my component specified by the given interface class.
Method removeComponent Remove the given component from me entirely, for all interfaces for which it has been registered.
Method getComponent Create or retrieve an adapter for the given interface.
Method __conform__ Undocumented

Inherited from Versioned (via Componentized):

Method __setstate__ Undocumented
Method __getstate__ Get state, adding a version number to it on its way out.
Method versionUpgrade (internal) Do a version upgrade.
def _getFrom(where, name): (source)
Undocumented
def _getsetFrom(where, name): (source)
Undocumented
def _getsetHeaders(where): (source)
Undocumented
def _getClientproto(self): (source)
Undocumented
def _getClient(self): (source)
Undocumented
def _getHost(self): (source)
Undocumented
def __init__(self, request): (source)
Undocumented
def getStateToCopyFor(self, issuer): (source)

Gather state to send when I am serialized for a particular perspective.

I will default to calling getStateToCopy. Override this to customize this behavior.
def getTypeToCopy(self): (source)

Determine what type tag to send for me.

By default, send the string representation of my class (package.module.Class); normally this is adequate, but you may override this to change it.
def registerProducer(self, producer, streaming): (source)
Undocumented
def unregisterProducer(self): (source)
Undocumented
def finish(self): (source)
Indicate that the response to this request is complete.
def write(self, data): (source)
Write some data to the body of the response to this request. Response headers are written the first time this method is called, after which new response headers may not be added.
def getHeader(self, name): (source)
Get an HTTP request header.
ParameterskeyThe name of the header to get the value of. (type: str )
ReturnsThe value of the specified header, or None if that header was not present in the request. (type: str or NoneType )
def setHeader(self, name, value): (source)
Set an outgoing HTTP header.
def setResponseCode(self, code, message=None): (source)
Set the HTTP response code.
def setLastModified(self, when): (source)

Set the Last-Modified time for the response to this request.

If I am called more than once, I ignore attempts to set Last-Modified earlier, only replacing the Last-Modified time if it is to a later value.

If I am a conditional request, I may modify my response code to NOT_MODIFIED if appropriate for the time given.
ParameterswhenThe last time the resource being returned was modified, in seconds since the epoch. (type: int, long or float )
ReturnsIf I am a If-Modified-Since conditional request and the time given is not newer than the condition, I return http.CACHED to indicate that you should write no body. Otherwise, I return a false value.
def setETag(self, etag): (source)

Set an entity tag for the outgoing response.

That's "entity tag" as in the HTTP/1.1 ETag header, "used for comparing two or more entities from the same requested resource."

If I am a conditional request, I may modify my response code to NOT_MODIFIED or PRECONDITION_FAILED, if appropriate for the tag given.
ParametersetagThe entity tag for the resource being returned. (type: str )
ReturnsIf I am a If-None-Match conditional request and the tag matches one in the request, I return http.CACHED to indicate that you should write no body. Otherwise, I return a false value.
def getAllHeaders(self): (source)

Return dictionary mapping the names of all received headers to the last value received for each.

Since this method does not return all header information, requestHeaders.getAllRawHeaders() may be preferred.
def getRequestHostname(self): (source)

Get the hostname that the user passed in to the request.

This will either use the Host: header (if it is available) or the host we are listening on if the header is unavailable.
Returnsthe requested hostname (type: str )
def getCookie(self, key): (source)
Get a cookie that was sent from the network.
def addCookie(self, k, v, expires=None, domain=None, path=None, max_age=None, comment=None, secure=None): (source)

Set an outgoing HTTP cookie.

In general, you should consider using sessions instead of cookies, see twisted.web.server.Request.getSession and the twisted.web.server.Session class for details.
def notifyFinish(self): (source)
Undocumented
def getHost(self): (source)
Get my originally requesting transport's host.
ReturnsAn IAddress.
def setHost(self, host, port, ssl=0): (source)

Change the host and port the request thinks it's using.

This method is useful for working with reverse HTTP proxies (e.g. both Squid and Apache's mod_proxy can do this), when the address the HTTP client is using is different than the one we're listening on.

For example, Apache may be listening on https://www.example.com, and then forwarding requests to http://localhost:8080, but we don't want HTML produced by Twisted to say 'http://localhost:8080', they should say 'https://www.example.com', so we do:
  request.setHost('www.example.com', 443, ssl=1)
def isSecure(self): (source)

Return True if this request is using a secure transport.

Normally this method returns True if this request's HTTPChannel instance is using a transport that implements ISSLTransport.

This will also return True if setHost() has been called with ssl=True.
ReturnsTrue if this request is secure (type: bool )
def getClientIP(self): (source)
Return the IP address of the client who submitted this request.
Returnsthe client IP address or None if the request was submitted over a transport where IP addresses do not make sense. (type: str or NoneType )
def getClient(self): (source)

Return the hostname of the IP address of the client who submitted this request, if possible.

This method is deprecated. See getClientIP instead.
ReturnsThe canonical hostname of the client, as determined by performing a name lookup on the IP address of the client. (type: NoneType or str )
def getUser(self): (source)

Return the HTTP user sent with this request, if any.

If no user was supplied, return the empty string.
Returnsthe HTTP user, if any (type: str )
def getPassword(self): (source)

Return the HTTP password sent with this request, if any.

If no password was supplied, return the empty string.
Returnsthe HTTP password, if any (type: str )
def sibLink(self, name): (source)
Return the text that links to a sibling of the requested resource.
def childLink(self, name): (source)
Return the text that links to a child of the requested resource.
def redirect(self, url): (source)

Utility function that does a redirect.

The request should have finish() called after this.
def prePathURL(self): (source)
ReturnsAt any time during resource traversal, a str giving an absolute URL to the most nested resource which has yet been reached.
def URLPath(self): (source)
ReturnsA URLPath instance which identifies the URL for which this request is.
def rememberRootURL(self, url=None): (source)
Remember the currently-processed part of the URL for later recalling.
def getRootURL(self): (source)
Get a previously-remembered URL.
def getSession(self, sessionInterface=None): (source)
Look up the session associated with this request or create a new one if there is not one.
ReturnsThe Session instance identified by the session cookie in the request, or the sessionInterface component of that session if sessionInterface is specified.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.