1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_NET_SERVICEFACTORY_HPP_INCLUDED
#define VMIME_NET_SERVICEFACTORY_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
#include <map>
#include "vmime/types.hpp"
#include "vmime/base.hpp"
#include "vmime/utility/stringUtils.hpp"
#include "vmime/utility/url.hpp"
#include "vmime/net/service.hpp"
#include "vmime/net/serviceInfos.hpp"
#include "vmime/net/timeoutHandler.hpp"
#include "vmime/security/authenticator.hpp"
#include "vmime/utility/progressListener.hpp"
namespace vmime {
namespace net {
class session;
/** A factory to create 'service' objects for a specified protocol.
*/
class VMIME_EXPORT serviceFactory {
private:
serviceFactory();
~serviceFactory();
public:
static shared_ptr <serviceFactory> getInstance();
/** Information about a registered service. */
class registeredService : public object {
friend class serviceFactory;
protected:
virtual ~registeredService() { }
public:
virtual shared_ptr <service> create(
const shared_ptr <session>& sess,
const shared_ptr <security::authenticator>& auth
) const = 0;
virtual int getType() const = 0;
virtual const string& getName() const = 0;
virtual const serviceInfos& getInfos() const = 0;
};
/** Register a new service by its protocol name.
*
* @param reg service registration infos
*/
void registerService(const shared_ptr <registeredService>& reg);
/** Create a new service instance from a protocol name.
*
* @param sess session
* @param protocol protocol name (eg. "pop3")
* @param auth authenticator used to provide credentials (can be NULL if not used)
* @return a new service instance for the specified protocol, or NULL if no service
* is registered for this protocol
*/
shared_ptr <service> create(
const shared_ptr <session>& sess,
const string& protocol,
const shared_ptr <security::authenticator>& auth = null
);
/** Create a new service instance from a URL.
*
* @param sess session
* @param u full URL with at least protocol and server (you can also specify
* port, username and password)
* @param auth authenticator used to provide credentials (can be NULL if not used)
* @return a new service instance for the specified protocol or NULL if no service
* is registered for this protocol
*/
shared_ptr <service> create(
const shared_ptr <session>& sess,
const utility::url& u,
const shared_ptr <security::authenticator>& auth = null
);
/** Return information about a registered protocol.
*
* @param protocol protocol name
* @return information about this protocol, or NULL if no service is registered
* for this protocol
*/
shared_ptr <const registeredService> getServiceByProtocol(const string& protocol) const;
/** Return the number of registered services.
*
* @return number of registered services
*/
size_t getServiceCount() const;
/** Return the registered service at the specified position.
*
* @param pos position of the registered service to return
* @return registered service at the specified position
*/
shared_ptr <const registeredService> getServiceAt(const size_t pos) const;
/** Return a list of all registered services.
*
* @return list of registered services
*/
const std::vector <shared_ptr <const registeredService> > getServiceList() const;
private:
std::vector <shared_ptr <registeredService> > m_services;
};
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES
#endif // VMIME_NET_SERVICEFACTORY_HPP_INCLUDED
|
