icat.cgi — Common Gateway Interface support

This module provides tools for writing CGI scripts acting as ICAT clients.

class icat.cgi.SessionCookie

Bases: Cookie.SimpleCookie

A cookie to store an ICAT session id.

Extend Cookie.SimpleCookie by the attribute sessionId. Setting this attribute will set the session id in the cookie, getting it will retrieve its value from the cookie.

class icat.cgi.Session(url, cookieName='ICATSESSIONID', cookiePath='/', secure=True)

Bases: object

A persisting ICAT session.

Manage an ICAT session that persist over the life time of the script. The session id is stored in a icat.cgi.SessionCookie.

isActive()

Check whether there is an active session.

login(auth, username, password)

Log in with username and password and start a session.

logout()

Log out and terminate the session.