summaryrefslogtreecommitdiff
path: root/src/libedataserver/e-source-credentials-provider-impl.h
blob: 4902c45f7d0cd115478d6bdfcddbfc77bf162941 (plain)
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
/*
 * Copyright (C) 2015 Red Hat, Inc. (www.redhat.com)
 *
 * This library is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation.
 *
 * This library 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#if !defined (__LIBEDATASERVER_H_INSIDE__) && !defined (LIBEDATASERVER_COMPILATION)
#error "Only <libedataserver/libedataserver.h> should be included directly."
#endif

#ifndef E_SOURCE_CREDENTIALS_PROVIDER_IMPL_H
#define E_SOURCE_CREDENTIALS_PROVIDER_IMPL_H

#include <glib.h>
#include <glib-object.h>

#include <libedataserver/e-extension.h>
#include <libedataserver/e-named-parameters.h>
#include <libedataserver/e-source.h>

/* Standard GObject macros */
#define E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL \
	(e_source_credentials_provider_impl_get_type ())
#define E_SOURCE_CREDENTIALS_PROVIDER_IMPL(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL, ESourceCredentialsProviderImpl))
#define E_SOURCE_CREDENTIALS_PROVIDER_IMPL_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL, ESourceCredentialsProviderImplClass))
#define E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL))
#define E_IS_SOURCE_CREDENTIALS_PROVIDER_IMPL_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL))
#define E_SOURCE_CREDENTIALS_PROVIDER_IMPL_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), E_TYPE_SOURCE_CREDENTIALS_PROVIDER_IMPL, ESourceCredentialsProviderImplClass))

G_BEGIN_DECLS

typedef struct _ESourceCredentialsProviderImpl ESourceCredentialsProviderImpl;
typedef struct _ESourceCredentialsProviderImplClass ESourceCredentialsProviderImplClass;
typedef struct _ESourceCredentialsProviderImplPrivate ESourceCredentialsProviderImplPrivate;

struct _ESourceCredentialsProvider;

/**
 * ESourceCredentialsProviderImpl:
 *
 * Credentials provider implementation base structure. The descendants
 * implement the virtual methods. The descendants are automatically
 * registered into an #ESourceCredentialsProvider.
 *
 * Since: 3.16
 **/
struct _ESourceCredentialsProviderImpl {
	/*< private >*/
	EExtension parent;
	ESourceCredentialsProviderImplPrivate *priv;
};

struct _ESourceCredentialsProviderImplClass {
	EExtensionClass parent_class;

	gboolean	(*can_process)		(ESourceCredentialsProviderImpl *provider_impl,
						 ESource *source);
	gboolean	(*can_store)		(ESourceCredentialsProviderImpl *provider_impl);
	gboolean	(*can_prompt)		(ESourceCredentialsProviderImpl *provider_impl);
	gboolean	(*lookup_sync)		(ESourceCredentialsProviderImpl *provider_impl,
						 ESource *source,
						 GCancellable *cancellable,
						 ENamedParameters **out_credentials,
						 GError **error);
	gboolean	(*store_sync)		(ESourceCredentialsProviderImpl *provider_impl,
						 ESource *source,
						 const ENamedParameters *credentials,
						 gboolean permanently,
						 GCancellable *cancellable,
						 GError **error);
	gboolean	(*delete_sync)		(ESourceCredentialsProviderImpl *provider_impl,
						 ESource *source,
						 GCancellable *cancellable,
						 GError **error);
};

GType		e_source_credentials_provider_impl_get_type	(void);
struct _ESourceCredentialsProvider *
		e_source_credentials_provider_impl_get_provider
							(ESourceCredentialsProviderImpl *provider_impl);
gboolean	e_source_credentials_provider_impl_can_process
							(ESourceCredentialsProviderImpl *provider_impl,
							 ESource *source);
gboolean	e_source_credentials_provider_impl_can_store
							(ESourceCredentialsProviderImpl *provider_impl);
gboolean	e_source_credentials_provider_impl_can_prompt
							(ESourceCredentialsProviderImpl *provider_impl);
gboolean	e_source_credentials_provider_impl_lookup_sync
							(ESourceCredentialsProviderImpl *provider_impl,
							 ESource *source,
							 GCancellable *cancellable,
							 ENamedParameters **out_credentials,
							 GError **error);
gboolean	e_source_credentials_provider_impl_store_sync
							(ESourceCredentialsProviderImpl *provider_impl,
							 ESource *source,
							 const ENamedParameters *credentials,
							 gboolean permanently,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_source_credentials_provider_impl_delete_sync
							(ESourceCredentialsProviderImpl *provider_impl,
							 ESource *source,
							 GCancellable *cancellable,
							 GError **error);

G_END_DECLS

#endif /* E_SOURCE_CREDENTIALS_PROVIDER_IMPL_H */