1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv=
"Content-Type" content=
"text/html;charset=UTF-8">
3 <title>Barry: ldifio.h Source File
</title>
4 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css">
5 <link href=
"tabs.css" rel=
"stylesheet" type=
"text/css">
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class=
"navigation" id=
"top">
11 <li><a href=
"index.html"><span>Main
Page
</span></a></li>
12 <li><a href=
"modules.html"><span>Modules
</span></a></li>
13 <li><a href=
"namespaces.html"><span>Namespaces
</span></a></li>
14 <li><a href=
"classes.html"><span>Classes
</span></a></li>
15 <li class=
"current"><a href=
"files.html"><span>Files
</span></a></li>
16 <li><a href=
"dirs.html"><span>Directories
</span></a></li>
19 <div class=
"navpath"><a class=
"el" href=
"dir_edc0f428e3eefcfdce9c25befd901c57.html">src
</a>
22 <div class=
"contents">
23 <h1>ldifio.h
</h1><a href=
"ldifio_8h.html">Go to the documentation of this file.
</a><div class=
"fragment"><pre class=
"fragment"><a name=
"l00001"></a>00001 <span class=
"comment">///
</span>
24 <a name=
"l00002"></a>00002 <span class=
"comment"></span><span class=
"comment">/// \file ldifio.h
</span>
25 <a name=
"l00003"></a>00003 <span class=
"comment"></span><span class=
"comment">/// Storage, parser, and builder classes for ldif operations.
</span>
26 <a name=
"l00004"></a>00004 <span class=
"comment"></span><span class=
"comment">///
</span>
27 <a name=
"l00005"></a>00005 <span class=
"comment"></span>
28 <a name=
"l00006"></a>00006 <span class=
"comment">/*
</span>
29 <a name=
"l00007"></a>00007 <span class=
"comment"> Copyright (C)
2010-
2011, Net Direct Inc. (http://www.netdirect.ca/)
</span>
30 <a name=
"l00008"></a>00008 <span class=
"comment"></span>
31 <a name=
"l00009"></a>00009 <span class=
"comment"> This program is free software; you can redistribute it and/or modify
</span>
32 <a name=
"l00010"></a>00010 <span class=
"comment"> it under the terms of the GNU General Public License as published by
</span>
33 <a name=
"l00011"></a>00011 <span class=
"comment"> the Free Software Foundation; either version
2 of the License, or
</span>
34 <a name=
"l00012"></a>00012 <span class=
"comment"> (at your option) any later version.
</span>
35 <a name=
"l00013"></a>00013 <span class=
"comment"></span>
36 <a name=
"l00014"></a>00014 <span class=
"comment"> This program is distributed in the hope that it will be useful,
</span>
37 <a name=
"l00015"></a>00015 <span class=
"comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of
</span>
38 <a name=
"l00016"></a>00016 <span class=
"comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</span>
39 <a name=
"l00017"></a>00017 <span class=
"comment"></span>
40 <a name=
"l00018"></a>00018 <span class=
"comment"> See the GNU General Public License in the COPYING file at the
</span>
41 <a name=
"l00019"></a>00019 <span class=
"comment"> root directory of this project for more details.
</span>
42 <a name=
"l00020"></a>00020 <span class=
"comment">*/
</span>
43 <a name=
"l00021"></a>00021
44 <a name=
"l00022"></a>00022 <span class=
"preprocessor">#ifndef __BARRY_LDIFIO_H__
</span>
45 <a name=
"l00023"></a>00023 <span class=
"preprocessor"></span><span class=
"preprocessor">#define __BARRY_LDIFIO_H__
</span>
46 <a name=
"l00024"></a>00024 <span class=
"preprocessor"></span>
47 <a name=
"l00025"></a>00025 <span class=
"preprocessor">#include
"<a class="code
" href="dll_8h.html
" title="Macros for handling DLL/library API visibility.
">dll.h</a>"</span>
48 <a name=
"l00026"></a>00026 <span class=
"preprocessor">#include
"<a class="code
" href="ldif_8h.html
" title="Routines for reading and writing LDAP LDIF data.
">ldif.h</a>"</span>
49 <a name=
"l00027"></a>00027 <span class=
"preprocessor">#include
<memory
></span>
50 <a name=
"l00028"></a>00028 <span class=
"preprocessor">#include
<iostream
></span>
51 <a name=
"l00029"></a>00029 <span class=
"preprocessor">#include
<fstream
></span>
52 <a name=
"l00030"></a>00030
53 <a name=
"l00031"></a>00031 <span class=
"keyword">namespace
</span>Barry {
54 <a name=
"l00032"></a>00032
55 <a name=
"l00033"></a>00033 <span class=
"keyword">class
</span>Builder;
56 <a name=
"l00034"></a>00034
57 <a name=
"l00035"></a>00035 <span class=
"comment">//
</span>
58 <a name=
"l00036"></a>00036 <span class=
"comment">// LdifStore
</span>
59 <a name=
"l00037"></a>00037 <span class=
"comment">//
</span><span class=
"comment"></span>
60 <a name=
"l00038"></a>00038 <span class=
"comment">/// Storage class suitable for use in a RecordParser
<> or RecordBuilder
<>.
</span>
61 <a name=
"l00039"></a>00039 <span class=
"comment">/// Be sure to use the input constructors for RecordBuilder
<> objects
</span>
62 <a name=
"l00040"></a>00040 <span class=
"comment">/// and output constructors for RecordParser
<> objects.
</span>
63 <a name=
"l00041"></a>00041 <span class=
"comment">///
</span>
64 <a name=
"l00042"></a>00042 <span class=
"comment">/// Examples:
</span>
65 <a name=
"l00043"></a>00043 <span class=
"comment">/// Read contacts from an ldif stream on stdin:
</span>
66 <a name=
"l00044"></a>00044 <span class=
"comment">/// new RecordBuilder
<Contact, LdifStore
>( new LdifStore(cin) );
</span>
67 <a name=
"l00045"></a>00045 <span class=
"comment">///
</span>
68 <a name=
"l00046"></a>00046 <span class=
"comment">/// Write contacts to an ldif stream on stdout:
</span>
69 <a name=
"l00047"></a>00047 <span class=
"comment">/// new RecordParser
<Contact, LdifStore
>(
</span>
70 <a name=
"l00048"></a>00048 <span class=
"comment">/// new LdifStore(cout, baseDN, dnAttr) );
</span>
71 <a name=
"l00049"></a>00049 <span class=
"comment">///
</span>
72 <a name=
"l00050"></a><a class=
"code" href=
"classBarry_1_1LdifStore.html">00050</a> <span class=
"comment"></span><span class=
"keyword">class
</span>BXEXPORT
<a class=
"code" href=
"classBarry_1_1LdifStore.html" title=
"Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt;...">LdifStore
</a>
73 <a name=
"l00051"></a>00051 {
74 <a name=
"l00052"></a>00052 std::auto_ptr
<std::ifstream
> m_ifs;
75 <a name=
"l00053"></a>00053 std::auto_ptr
<std::ofstream
> m_ofs;
76 <a name=
"l00054"></a>00054 std::istream
&m_is;
77 <a name=
"l00055"></a>00055 std::ostream
&m_os;
78 <a name=
"l00056"></a>00056 <span class=
"keywordtype">bool
</span> m_end_of_file;
79 <a name=
"l00057"></a>00057
80 <a name=
"l00058"></a>00058 <a class=
"code" href=
"classBarry_1_1ContactLdif.html" title=
"Class for generating LDIF output based on a Barry::Contact record object.">Barry::ContactLdif
</a> m_ldif;
81 <a name=
"l00059"></a>00059
82 <a name=
"l00060"></a>00060 <span class=
"keyword">public
</span>:
83 <a name=
"l00061"></a>00061 <span class=
"comment">// input constructors
</span>
84 <a name=
"l00062"></a>00062 <a class=
"code" href=
"classBarry_1_1LdifStore.html" title=
"Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt;...">LdifStore
</a>(
<span class=
"keyword">const
</span> std::string
&filename);
85 <a name=
"l00063"></a>00063 <a class=
"code" href=
"classBarry_1_1LdifStore.html" title=
"Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt;...">LdifStore
</a>(std::istream
&is);
86 <a name=
"l00064"></a>00064
87 <a name=
"l00065"></a>00065 <span class=
"comment">// output constructors
</span>
88 <a name=
"l00066"></a>00066 <a class=
"code" href=
"classBarry_1_1LdifStore.html" title=
"Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt;...">LdifStore
</a>(
<span class=
"keyword">const
</span> std::string
&filename,
<span class=
"keyword">const
</span> std::string
&baseDN,
89 <a name=
"l00067"></a>00067 <span class=
"keyword">const
</span> std::string
&dnattr);
90 <a name=
"l00068"></a>00068 <a class=
"code" href=
"classBarry_1_1LdifStore.html" title=
"Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt;...">LdifStore
</a>(std::ostream
&os,
<span class=
"keyword">const
</span> std::string
&baseDN,
91 <a name=
"l00069"></a>00069 <span class=
"keyword">const
</span> std::string
&dnattr);
92 <a name=
"l00070"></a>00070
93 <a name=
"l00071"></a>00071 <span class=
"comment">// storage operator
</span>
94 <a name=
"l00072"></a>00072 <span class=
"keywordtype">void
</span> operator() (
<span class=
"keyword">const
</span> <a class=
"code" href=
"classBarry_1_1Contact.html" title=
"Represents a single record in the Address Book Blackberry database.">Contact
</a> &rec);
95 <a name=
"l00073"></a>00073
96 <a name=
"l00074"></a>00074 <span class=
"comment">// retrieval operator
</span>
97 <a name=
"l00075"></a>00075 <span class=
"keywordtype">bool
</span> operator() (
<a class=
"code" href=
"classBarry_1_1Contact.html" title=
"Represents a single record in the Address Book Blackberry database.">Contact
</a> &rec,
<span class=
"keyword">const
</span> <a class=
"code" href=
"classBarry_1_1Builder.html" title=
"Base class for the builder functor hierarchy.">Builder
</a> &builder);
98 <a name=
"l00076"></a>00076 };
99 <a name=
"l00077"></a>00077
100 <a name=
"l00078"></a>00078 }
101 <a name=
"l00079"></a>00079
102 <a name=
"l00080"></a>00080 <span class=
"preprocessor">#endif
</span>
103 <a name=
"l00081"></a>00081 <span class=
"preprocessor"></span>
105 <hr size=
"1"><address style=
"text-align: right;"><small>Generated on Thu Feb
10 16:
13:
58 2011 for Barry by
106 <a href=
"http://www.doxygen.org/index.html">
107 <img src=
"doxygen.png" alt=
"doxygen" align=
"middle" border=
"0"></a> 1.5.6 </small></address>