/usr/include/aqbanking5/aqbanking/provider_be.h is in libaqbanking-dev 5.6.12-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | /***************************************************************************
begin : Mon Mar 01 2004
copyright : (C) 2004-2010 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* This file is part of the project "AqBanking". *
* Please see toplevel file COPYING of that project for license details. *
***************************************************************************/
/** @file provider_be.h
* @short This file is used by provider backends.
*/
#ifndef AQBANKING_PROVIDER_BE_H
#define AQBANKING_PROVIDER_BE_H
#include <aqbanking/provider.h>
#include <aqbanking/user.h>
#include <gwenhywfar/plugin.h>
#include <gwenhywfar/db.h>
#include <gwenhywfar/dialog.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @addtogroup G_AB_PROVIDER
*
*/
/*@{*/
#define AB_PROVIDER_FLAGS_HAS_NEWUSER_DIALOG 0x00000001
#define AB_PROVIDER_FLAGS_HAS_EDITUSER_DIALOG 0x00000002
#define AB_PROVIDER_FLAGS_HAS_NEWACCOUNT_DIALOG 0x00000004
#define AB_PROVIDER_FLAGS_HAS_EDITACCOUNT_DIALOG 0x00000008
#define AB_PROVIDER_FLAGS_HAS_USERTYPE_DIALOG 0x00000010
/**
* This type is used with @ref AB_Provider_ExtendAccount and
* @ref AB_Provider_ExtendUser.
*/
typedef enum {
/** Object to be extended has just been created. For some backends this
* means that some settings are allowed to be missing at this point.*/
AB_ProviderExtendMode_Create=0,
/** Object to be extended has been read from the configuration file */
AB_ProviderExtendMode_Extend,
/** Object to be extended has just been added to internal lists.
* For the backend this might mean that the object should be completely
* setup at this point. */
AB_ProviderExtendMode_Add,
/** Object to be extended is just about to be removed from the internal
* list. */
AB_ProviderExtendMode_Remove,
/** This extend mode just lets the backend store data which has not yet
* been stored into the users/accounts DB.
* Please note that in this mode the backend might no longer be
* initialized, so you should not call any other provider function (or call
* @ref AB_Provider_IsInit to see whether the backend still is initialized).
*/
AB_ProviderExtendMode_Save,
/** This mode tells the backend to reload its configuration from the given
* DB.
*/
AB_ProviderExtendMode_Reload
} AB_PROVIDER_EXTEND_MODE;
/** @name Prototypes For Virtual Functions
*
*/
/*@{*/
/**
* See @ref AB_Provider_Init.
*/
typedef int (*AB_PROVIDER_INIT_FN)(AB_PROVIDER *pro, GWEN_DB_NODE *dbData);
/**
* See @ref AB_Provider_Fini.
*/
typedef int (*AB_PROVIDER_FINI_FN)(AB_PROVIDER *pro, GWEN_DB_NODE *dbData);
/**
* See @ref AB_Provider_UpdateJob
*/
typedef int (*AB_PROVIDER_UPDATEJOB_FN)(AB_PROVIDER *pro, AB_JOB *j);
/**
* See @ref AB_Provider_AddJob.
*/
typedef int (*AB_PROVIDER_ADDJOB_FN)(AB_PROVIDER *pro, AB_JOB *j);
/**
* See @ref AB_Provider_Execute
*/
typedef int (*AB_PROVIDER_EXECUTE_FN)(AB_PROVIDER *pro,
AB_IMEXPORTER_CONTEXT *ctx);
/**
* See @ref AB_Provider_ResetQueue.
*/
typedef int (*AB_PROVIDER_RESETQUEUE_FN)(AB_PROVIDER *pro);
/**
* See @ref AB_Provider_ExtendUser.
*/
typedef int (*AB_PROVIDER_EXTEND_USER_FN)(AB_PROVIDER *pro, AB_USER *u,
AB_PROVIDER_EXTEND_MODE um,
GWEN_DB_NODE *db);
/**
* See @ref AB_Provider_ExtendAccount.
*/
typedef int (*AB_PROVIDER_EXTEND_ACCOUNT_FN)(AB_PROVIDER *pro,
AB_ACCOUNT *a,
AB_PROVIDER_EXTEND_MODE um,
GWEN_DB_NODE *db);
typedef int (*AB_PROVIDER_UPDATE_FN)(AB_PROVIDER *pro,
uint32_t lastVersion,
uint32_t currentVersion);
typedef GWEN_DIALOG* (*AB_PROVIDER_GET_NEWUSER_DIALOG_FN)(AB_PROVIDER *pro, int i);
typedef GWEN_DIALOG* (*AB_PROVIDER_GET_EDITUSER_DIALOG_FN)(AB_PROVIDER *pro, AB_USER *u);
typedef GWEN_DIALOG* (*AB_PROVIDER_GET_NEWACCOUNT_DIALOG_FN)(AB_PROVIDER *pro);
typedef GWEN_DIALOG* (*AB_PROVIDER_GET_EDITACCOUNT_DIALOG_FN)(AB_PROVIDER *pro, AB_ACCOUNT *a);
typedef GWEN_DIALOG* (*AB_PROVIDER_GET_USERTYPE_DIALOG_FN)(AB_PROVIDER *pro);
/*@}*/
AQBANKING_API
AB_PROVIDER *AB_Provider_new(AB_BANKING *ab,
const char *name);
/**
* @return 0 if the backend is not initialized, !=0 if it is
*/
AQBANKING_API
int AB_Provider_IsInit(const AB_PROVIDER *pro);
AQBANKING_API
void AB_Provider_AddFlags(AB_PROVIDER *pro, uint32_t fl);
/** @name Virtual Functions
*
*/
/*@{*/
/**
* Allow the backend to initialize itself.
* @param pro backend object
*/
AQBANKING_API
int AB_Provider_Init(AB_PROVIDER *pro);
/**
* Allow the backend to deinitialize itself.
* @param pro backend object
*/
AQBANKING_API
int AB_Provider_Fini(AB_PROVIDER *pro);
/**
* This function should check for the availability of the given job and
* prepare it for the next call to @ref AB_PROVIDER_ADDJOB_FN.
* If the job is available with this backend it should also set the job
* parameters (such as the maximum number of purpose lines for transfer jobs
* etc).
* This function is called from the constructor AB_Job_new() in AqBanking.
* The value returned here is stored within the job in question and becomes
* available via @ref AB_Job_CheckAvailability.
* @param pro backend object
* @param j job to update
*/
AQBANKING_API
int AB_Provider_UpdateJob(AB_PROVIDER *pro, AB_JOB *j);
/**
* <p>
* Add the given job to the backend's internal queue. This is an immediate
* queue, it is not persistent. The queue is flushed by
* @ref AB_PROVIDER_EXECUTE_FN. The added job is removed in any case
* after @ref AB_PROVIDER_EXECUTE_FN has been called.
* </p>
* <p>
* This function should first check the job arguments (sanity checks etc).
* If this function returns an error the job MUST NOT be enqueued in the
* providers own queue. In this case the job will be marked "errornous".
* </p>
* <p>
* However, if the backend prepares the job well enough (via
* @ref AB_PROVIDER_UPDATEJOB_FN) then the application should have made sure
* that the job complies to the rules laid out by the backend. So rejecting
* a job here should be a rare case with well-designed applications and
* backends.
* </p>
* @param pro backend object
*/
AQBANKING_API
int AB_Provider_AddJob(AB_PROVIDER *pro, AB_JOB *j);
/**
* Executes all jobs in the queue which have just been added via
* @ref AB_PROVIDER_ADDJOB_FN. After calling this function @b all jobs are
* removed from the backend's queue in any case.
* @param pro backend object
* @param ctx im-/exporter context to receive responses
*/
AQBANKING_API
int AB_Provider_Execute(AB_PROVIDER *pro, AB_IMEXPORTER_CONTEXT *ctx);
/**
* Resets the queue of the backend.
* After calling this function @b all jobs are removed from the
* backend's queue in any case.
* @param pro backend object
*/
AQBANKING_API
int AB_Provider_ResetQueue(AB_PROVIDER *pro);
/**
* Allows the backend to extend the given user (e.g. load backend-specific
* data for the given user).
*/
AQBANKING_API
int AB_Provider_ExtendUser(AB_PROVIDER *pro, AB_USER *u,
AB_PROVIDER_EXTEND_MODE em,
GWEN_DB_NODE *db);
/**
* Allows the backend to extend the given account (e.g. load backend-specific
* data for the given account).
*/
AQBANKING_API
int AB_Provider_ExtendAccount(AB_PROVIDER *pro, AB_ACCOUNT *a,
AB_PROVIDER_EXTEND_MODE em,
GWEN_DB_NODE *db);
/**
* Allows the backend to update AqBanking data.
* This function is called for each active provider after all backends, users
* and accounts have been loaded and initialised but before loading the
* outbox jobs.
*/
AQBANKING_API
int AB_Provider_Update(AB_PROVIDER *pro,
uint32_t lastVersion,
uint32_t currentVersion);
/**
* Create a dialog which allows to create a new user.
* The dialog returned (if any) must be derived via @ref AB_NewUserDialog_new().
* @param pro pointer to the backend for which a new user is to be created
* @param i additional parameter depending on the backend. it can be used
* to specify the user type to be created (e.g. for HBCI those values
* specify whether PIN/TAN, keyfile or chipcard users are to be created).
* Use value 0 for the generic dialog.
*/
AQBANKING_API
GWEN_DIALOG *AB_Provider_GetNewUserDialog(AB_PROVIDER *pro, int i);
AQBANKING_API
GWEN_DIALOG *AB_Provider_GetEditUserDialog(AB_PROVIDER *pro, AB_USER *u);
/**
* Create a dialog which allows to create a new account.
* The dialog returned (if any) must be derived via @ref AB_NewAccountDialog_new().
*/
AQBANKING_API
GWEN_DIALOG *AB_Provider_GetNewAccountDialog(AB_PROVIDER *pro);
AQBANKING_API
GWEN_DIALOG *AB_Provider_GetEditAccountDialog(AB_PROVIDER *pro, AB_ACCOUNT *a);
AQBANKING_API
GWEN_DIALOG *AB_ProviderGetUserTypeDialog(AB_PROVIDER *pro);
/*@}*/
/** @name Setters For Virtual Functions
*
*/
/*@{*/
AQBANKING_API
void AB_Provider_SetInitFn(AB_PROVIDER *pro, AB_PROVIDER_INIT_FN f);
AQBANKING_API
void AB_Provider_SetFiniFn(AB_PROVIDER *pro, AB_PROVIDER_FINI_FN f);
AQBANKING_API
void AB_Provider_SetUpdateJobFn(AB_PROVIDER *pro, AB_PROVIDER_UPDATEJOB_FN f);
AQBANKING_API
void AB_Provider_SetAddJobFn(AB_PROVIDER *pro, AB_PROVIDER_ADDJOB_FN f);
AQBANKING_API
void AB_Provider_SetExecuteFn(AB_PROVIDER *pro, AB_PROVIDER_EXECUTE_FN f);
AQBANKING_API
void AB_Provider_SetResetQueueFn(AB_PROVIDER *pro, AB_PROVIDER_RESETQUEUE_FN f);
AQBANKING_API
void AB_Provider_SetExtendUserFn(AB_PROVIDER *pro,
AB_PROVIDER_EXTEND_USER_FN f);
AQBANKING_API
void AB_Provider_SetExtendAccountFn(AB_PROVIDER *pro,
AB_PROVIDER_EXTEND_ACCOUNT_FN f);
AQBANKING_API
void AB_Provider_SetUpdateFn(AB_PROVIDER *pro, AB_PROVIDER_UPDATE_FN f);
AQBANKING_API
void AB_Provider_SetGetNewUserDialogFn(AB_PROVIDER *pro, AB_PROVIDER_GET_NEWUSER_DIALOG_FN f);
AQBANKING_API
void AB_Provider_SetGetEditUserDialogFn(AB_PROVIDER *pro, AB_PROVIDER_GET_EDITUSER_DIALOG_FN f);
AQBANKING_API
void AB_Provider_SetGetNewAccountDialogFn(AB_PROVIDER *pro, AB_PROVIDER_GET_NEWACCOUNT_DIALOG_FN f);
AQBANKING_API
void AB_Provider_SetGetEditAccountDialogFn(AB_PROVIDER *pro, AB_PROVIDER_GET_EDITACCOUNT_DIALOG_FN f);
AQBANKING_API
void AB_Provider_SetGetUserTypeDialogFn(AB_PROVIDER *pro, AB_PROVIDER_GET_USERTYPE_DIALOG_FN f);
/*@}*/
typedef AB_PROVIDER* (*AB_PLUGIN_PROVIDER_FACTORY_FN)(GWEN_PLUGIN *pl,
AB_BANKING *ab);
AQBANKING_API
GWEN_PLUGIN *AB_Plugin_Provider_new(GWEN_PLUGIN_MANAGER *pm,
const char *name,
const char *fileName);
AQBANKING_API
AB_PROVIDER *AB_Plugin_Provider_Factory(GWEN_PLUGIN *pl, AB_BANKING *ab);
AQBANKING_API
void AB_Plugin_Provider_SetFactoryFn(GWEN_PLUGIN *pl,
AB_PLUGIN_PROVIDER_FACTORY_FN fn);
/*@}*/ /* defgroup */
#ifdef __cplusplus
}
#endif
#endif /* AQBANKING_PROVIDER_BE_H */
|