<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[14158] twext/trunk/twext/who</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/14158">14158</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2014-11-12 15:56:53 -0800 (Wed, 12 Nov 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Cleanup API changes.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhodirectorypy">twext/trunk/twext/who/directory.py</a></li>
<li><a href="#twexttrunktwextwhoidirectorypy">twext/trunk/twext/who/idirectory.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhodirectorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/directory.py (14157 => 14158)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/directory.py 2014-11-12 20:56:24 UTC (rev 14157)
+++ twext/trunk/twext/who/directory.py 2014-11-12 23:56:53 UTC (rev 14158)
</span><span class="lines">@@ -348,7 +348,11 @@
</span><span class="cx"> return succeed(None)
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def flush(self):
+ return succeed(None)
</ins><span class="cx">
</span><ins>+
+
</ins><span class="cx"> @implementer(IDirectoryRecord)
</span><span class="cx"> class DirectoryRecord(object):
</span><span class="cx"> """
</span></span></pre></div>
<a id="twexttrunktwextwhoidirectorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/idirectory.py (14157 => 14158)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/idirectory.py 2014-11-12 20:56:24 UTC (rev 14157)
+++ twext/trunk/twext/who/idirectory.py 2014-11-12 23:56:53 UTC (rev 14158)
</span><span class="lines">@@ -150,11 +150,11 @@
</span><span class="cx"> iterable of values (if it has a true C{multiValue} attribute).
</span><span class="cx">
</span><span class="cx"> Field values must be an instance of an expected type. The default expected
</span><del>- type for a field is L{unicode}, and may be overriden by a C{valueType}
</del><ins>+ type for a field is L{unicode}, and may be overridden by a C{valueType}
</ins><span class="cx"> attribute on the field name.
</span><span class="cx">
</span><del>- In the case where the expected type is a constant (eg. L{NamedConstant}),
- C{valueType} should be the container that contains the constant (eg. a
</del><ins>+ In the case where the expected type is a constant (e.g. L{NamedConstant}),
+ C{valueType} should be the container that contains the constant (e.g. a
</ins><span class="cx"> subclass of L{Names}).
</span><span class="cx">
</span><span class="cx"> @cvar uid: The primary unique identifier for a directory record.
</span><span class="lines">@@ -174,7 +174,7 @@
</span><span class="cx"> The associated values must be L{unicode}s.
</span><span class="cx">
</span><span class="cx"> @cvar emailAddresses: The email addresses for a directory record.
</span><del>- The associated values must be L{unicodes}.
</del><ins>+ The associated values must be L{unicode}s.
</ins><span class="cx">
</span><span class="cx"> @cvar password: The clear text password (oh no!) for a directory record.
</span><span class="cx"> The associated value must be a L{unicode} or C{None}.
</span><span class="lines">@@ -423,7 +423,7 @@
</span><span class="cx"> @param create: if true, create records if necessary
</span><span class="cx"> @type create: boolean
</span><span class="cx">
</span><del>- @return: unspecifiied
</del><ins>+ @return: unspecified
</ins><span class="cx"> @rtype: deferred object
</span><span class="cx">
</span><span class="cx"> @raises L{NotAllowedError}: if the update is not allowed by the
</span><span class="lines">@@ -437,21 +437,35 @@
</span><span class="cx"> @param uids: the UIDs of the records to remove
</span><span class="cx"> @type uids: iterable of L{unicode}
</span><span class="cx">
</span><del>- @return: unspecifiied
</del><ins>+ @return: unspecified
</ins><span class="cx"> @rtype: deferred object
</span><span class="cx">
</span><span class="cx"> @raises L{NotAllowedError}: if the removal is not allowed by the
</span><span class="cx"> directory service.
</span><span class="cx"> """
</span><span class="cx">
</span><ins>+ def flush():
+ """
+ Clear out any record information that the directory service has cached
+ from the underlying directory store. This is useful in testing scenarios
+ where we want a change to the underlying store to quickly propagate to
+ all directory services that use it.
</ins><span class="cx">
</span><ins>+ Each service that uses some form of record caching should implement this method
+ and make sure its caches are cleared.
</ins><span class="cx">
</span><ins>+ @return: unspecified
+ @rtype: deferred object
+ """
+
+
+
</ins><span class="cx"> class IDirectoryRecord(Interface):
</span><span class="cx"> """
</span><span class="cx"> Directory record.
</span><span class="cx">
</span><span class="cx"> A directory record corresponds to a principal, and contains
</span><del>- information about the principal such as idenfiers, names and
</del><ins>+ information about the principal such as identifiers, names and
</ins><span class="cx"> passwords.
</span><span class="cx">
</span><span class="cx"> This information is stored in a set of fields (a mapping of field
</span><span class="lines">@@ -526,14 +540,14 @@
</span><span class="cx">
</span><span class="cx"> class IPlaintextPasswordVerifier(Interface):
</span><span class="cx"> """
</span><del>- Provides a way to verify a plaintext password as provided by a client.
</del><ins>+ Provides a way to verify a plain text password as provided by a client.
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> def verifyPlaintextPassword(password):
</span><span class="cx"> """
</span><del>- Verifies that a given plaintext password authenticates the record.
</del><ins>+ Verifies that a given plain text password authenticates the record.
</ins><span class="cx">
</span><del>- @param password: A plaintext password.
</del><ins>+ @param password: A plain text password.
</ins><span class="cx"> @type password: L{unicode}
</span><span class="cx">
</span><span class="cx"> @return: L{True} if the password matches, L{False} otherwise.
</span><span class="lines">@@ -549,9 +563,9 @@
</span><span class="cx">
</span><span class="cx"> def verifyHTTPDigest(username, realm, nonce, algorithm, response, method):
</span><span class="cx"> """
</span><del>- Verifies that a given plaintext password authenticates the record.
</del><ins>+ Verifies that a given plain text password authenticates the record.
</ins><span class="cx">
</span><del>- @param password: A plaintext password.
</del><ins>+ @param password: A plain text password.
</ins><span class="cx"> @type password: L{unicode}
</span><span class="cx">
</span><span class="cx"> @return: L{True} if the password matches, L{False} otherwise.
</span></span></pre>
</div>
</div>
</body>
</html>