/*
- * Copyright (c) 1995-2003, Index Data.
+ * Copyright (c) 1995-2006, Index Data
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
*
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Index Data nor the names of its contributors
+ * may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
*
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
- *
- * 2. The name of Index Data or the individual authors may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
- * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
- * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/* $Id: backend.h,v 1.38 2006-10-09 21:02:41 adam Exp $ */
+
+/**
+ * \file backend.h
+ * \brief Header for GFS
*
- * $Id: backend.h,v 1.18 2003-02-12 15:06:43 adam Exp $
+ * This header includes all public definitions for the
+ * Generic Frontend Server (GFS).
*/
#ifndef BACKEND_H
#include <yaz/yconfig.h>
#include <yaz/proto.h>
+#include <yaz/srw.h>
YAZ_BEGIN_CDECL
int errcode; /* 0==OK */
char *errstring; /* system error string or NULL */
Z_OtherInformation *search_info; /* additional search info */
+ char *srw_sortKeys; /* holds SRU/SRW sortKeys info */
+ char *srw_setname; /* holds SRU/SRW generated resultsetID */
+ int *srw_setnameIdleTime; /* holds SRU/SRW life-time */
} bend_search_rr;
/* extended present handler. Does not replace bend_fetch. */
int errcode; /* 0==success */
char *errstring; /* system error string or NULL */
int surrogate_flag; /* surrogate diagnostic */
+ char *schema; /* string record schema input/output */
} bend_fetch_rr;
struct scan_entry {
int occurrences; /* no of occurrences or -1 if error (see below) */
int errcode; /* Bib-1 diagnostic code; only used when occur.= -1 */
char *errstring; /* Additional string */
+ char *display_term;
};
typedef enum {
int term_position; /* desired index of term in result list/returned */
int num_entries; /* number of entries requested/returned */
+ /* scan term entries. The called handler does not have
+ to allocate this. Size of entries is num_entries (see above) */
struct scan_entry *entries;
bend_scan_status status;
int errcode;
char *errstring;
+ char *scanClause; /* CQL scan clause */
} bend_scan_rr;
+typedef struct bend_update_rr {
+ int num_bases; /* number of elements in databaselist */
+ char **basenames; /* databases to search */
+ Z_ReferenceId *referenceId; /* reference ID */
+ ODR stream; /* encoding stream - memory source if required */
+ ODR print; /* printing stream */
+ char *operation;
+ char *operation_status;
+ char *record_id;
+ char *record_version;
+ char *record_checksum;
+ char *record_old_version;
+ char *record_packing;
+ char *record_schema;
+ char *record_data;
+ Z_SRW_extra_record *request_extra_record;
+ Z_SRW_extra_record *response_extra_record;
+ char *extra_request_data;
+ char *extra_response_data;
+ char *uri;
+ char *message;
+ char *details;
+} bend_update_rr;
+
/* delete handler */
typedef struct bend_delete_rr {
int function;
bend_association association;
} bend_segment_rr;
+typedef struct {
+ ODR stream;
+ ODR decode;
+ ODR print;
+ char *explain_buf;
+ char *database;
+ char *schema;
+ void *server_node_ptr;
+} bend_explain_rr;
+
typedef struct bend_initrequest
{
Z_IdAuthentication *auth;
/* character set and language negotiation - see include/yaz/z-charneg.h */
Z_CharSetandLanguageNegotiation *charneg_request;
Z_External *charneg_response;
-
+ int (*bend_explain)(void *handle, bend_explain_rr *rr);
+ int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
+ int (*bend_srw_update)(void *handle, bend_update_rr *rr);
} bend_initrequest;
typedef struct bend_initresult
} bend_initresult;
YAZ_EXPORT void bend_request_send (bend_association a, bend_request req,
- Z_APDU *res);
+ Z_APDU *res);
YAZ_EXPORT bend_request bend_request_mk (bend_association a);
int dynamic; /* fork on incoming requests */
int threads; /* use threads */
int one_shot; /* one session then exit(1) */
- int loglevel; /* desired logging-level */
+ int __UNUSED__loglevel; /* desired logging-level */
char apdufile[ODR_MAXNAME+1]; /* file for pretty-printed PDUs */
char logfile[ODR_MAXNAME+1]; /* file for diagnostic output */
char default_listen[1024]; /* 0 == no default listen */
char service_display_name[128]; /* The service display name */
#endif /* WIN32 */
struct bend_soap_handler *soap_handlers;
+ char pid_fname[128]; /* pid fname */
+ int background; /* auto daemon */
+ char cert_fname[128]; /* SSL certificate fname */
+ char xml_config[128]; /* XML config filename */
} statserv_options_block;
-struct bend_http_rr {
- void *handle;
- ODR stream; /* encoding stream */
- ODR decode; /* decoding stream */
- ODR print; /* print stream */
- Z_HTTP_Request *hreq; /* whole HTTP request */
- char *buf;
- int len;
-};
-
-struct bend_soap_rr {
- void *handle; /* user handle */
- ODR stream;
- ODR decode;
- ODR print;
- const char *ns_env; /* SOAP NS */
- const char *ns_enc; /* SOAP Encoding NS */
- void *request_method;
- void *response_body;
- char *fault_code;
- char *fault_string;
-};
-
-struct bend_soap_handler {
- char *ns;
- int (*handler)(struct bend_soap_rr *rr);
- struct bend_soap_handler *next;
-};
-
YAZ_EXPORT int statserv_main(
int argc, char **argv,
bend_initresult *(*bend_init)(bend_initrequest *r),
YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
-YAZ_EXPORT void statserv_add_soap_handler(int (*h)(struct bend_soap_rr *rr),
- const char *ns);
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff