source: SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServer.java @ 2246

Last change on this file since 2246 was 2246, checked in by oschonef, 12 years ago
  • cleanup whitespace
  • add some javadoc
  • Property svn:eol-style set to native
File size: 40.9 KB
Line 
1/**
2 * This software is copyright (c) 2011 by
3 *  - Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
4 * This is free software. You can redistribute it
5 * and/or modify it under the terms described in
6 * the GNU General Public License v3 of which you
7 * should have received a copy. Otherwise you can download
8 * it from
9 *
10 *   http://www.gnu.org/licenses/gpl-3.0.txt
11 *
12 * @copyright Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
13 *
14 * @license http://www.gnu.org/licenses/gpl-3.0.txt
15 *  GNU General Public License v3
16 */
17package eu.clarin.sru.server;
18
19import java.io.IOException;
20import java.io.OutputStream;
21import java.util.Arrays;
22import java.util.List;
23import java.util.NoSuchElementException;
24
25import javax.servlet.http.HttpServletRequest;
26import javax.servlet.http.HttpServletResponse;
27import javax.xml.stream.XMLOutputFactory;
28import javax.xml.stream.XMLStreamException;
29import javax.xml.stream.XMLStreamWriter;
30
31import org.slf4j.Logger;
32import org.slf4j.LoggerFactory;
33import org.z3950.zing.cql.CQLNode;
34
35import eu.clarin.sru.server.SRUServerConfig.DatabaseInfo;
36import eu.clarin.sru.server.SRUServerConfig.IndexInfo;
37import eu.clarin.sru.server.SRUServerConfig.LocalizedString;
38import eu.clarin.sru.server.SRUServerConfig.SchemaInfo;
39import eu.clarin.sru.server.utils.SRUServerServlet;
40
41
42/**
43 * SRU/CQL protocol implementation for the server-side (SRU/S). This class
44 * implements SRU/CQL version 1.1 and and 1.2.
45 *
46 * @see SRUServerConfig
47 * @see SRUSearchEngine
48 * @see SRUServerServlet
49 * @see <a href="http://www.loc.gov/standards/sru/">SRU/CQL protocol 1.2</a>
50 */
51public final class SRUServer {
52    private static final String SRU_NS =
53            "http://www.loc.gov/zing/srw/";
54    private static final String SRU_PREFIX = "sru";
55    private static final String SRU_DIAGNOSIC_NS =
56            "http://www.loc.gov/zing/srw/diagnostic/";
57    private static final String SRU_DIAGNOSTIC_PREFIX = "diag";
58    private static final String SRU_DIAGNOSTIC_RECORD_SCHEMA =
59            "info:srw/schema/1/diagnostics-v1.1";
60    private static final String SRU_EXPLAIN_NS =
61            "http://explain.z3950.org/dtd/2.0/";
62    private static final String SRU_EXPLAIN_PREFIX = "zr";
63    private static final String SRU_XCQL_NS =
64            "http://www.loc.gov/zing/cql/xcql/";
65    static final String RESPONSE_ENCODING = "utf-8";
66    private static final String RESPONSE_CONTENT_TYPE = "application/xml";
67    private static final int RESPONSE_BUFFER_SIZE = 64 * 1024;
68    private static final Logger logger =
69            LoggerFactory.getLogger(SRUServer.class);
70    private final SRUServerConfig config;
71    private final SRUSearchEngine searchEngine;
72    private final XMLOutputFactory writerFactory;
73
74
75    /**
76     * Constructor.
77     *
78     * @param config
79     *            a SRUEndpointConfig object
80     * @param searchEngine
81     *            an object implementing the SRUSearchEngine interface
82     * @throws NullPointerException
83     *             if config or searchEngine is <code>null</code>
84     * @throws SRUException
85     *             if an error occurred
86     */
87    public SRUServer(SRUServerConfig config, SRUSearchEngine searchEngine)
88            throws SRUException {
89        if (config == null) {
90            throw new NullPointerException("config == null");
91        }
92        this.config = config;
93        if (searchEngine == null) {
94            throw new NullPointerException("searchEngine == null");
95        }
96        this.searchEngine = searchEngine;
97        this.writerFactory = XMLOutputFactory.newInstance();
98    }
99
100
101    /**
102     * Handle a SRU request.
103     *
104     * @param request
105     *            a HttpServletRequest request
106     * @param response
107     *            a HttpServletResponse request
108     */
109    public void handleRequest(HttpServletRequest request,
110            HttpServletResponse response) {
111        final SRURequestImpl req = new SRURequestImpl(config, request);
112        try {
113            // set response properties
114            response.setContentType(RESPONSE_CONTENT_TYPE);
115            response.setCharacterEncoding(RESPONSE_ENCODING);
116            response.setStatus(HttpServletResponse.SC_OK);
117            // make sure we can reset the stream later in case of error ...
118            response.setBufferSize(RESPONSE_BUFFER_SIZE);
119
120            try {
121                if (req.checkParameters()) {
122                    switch (req.getOperation()) {
123                    case EXPLAIN:
124                        explain(req, response);
125                        break;
126                    case SCAN:
127                        scan(req, response);
128                        break;
129                    case SEARCH_RETRIEVE:
130                        search(req, response);
131                        break;
132                    }
133                } else {
134                    // (some) parameters are malformed, send error
135                    SRUXMLStreamWriter out =
136                        createXMLStreamWriter(response.getOutputStream(),
137                                SRURecordPacking.XML, req.getIndentResponse());
138                    writeFatalError(out, req, req.getDiagnostics());
139                }
140            } catch (XMLStreamException e) {
141                logger.error("An error occured while serializing response", e);
142                throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR,
143                        "An error occured while serializing response.", e);
144            } catch (IOException e) {
145                /*
146                 * Well, can't really do anything useful here ...
147                 */
148                logger.error("An unexpected exception occured", e);
149            }
150        } catch (SRUException e) {
151            if (!response.isCommitted()) {
152                response.resetBuffer();
153                try {
154                    List<SRUDiagnostic> diagnostics = req.getDiagnostics();
155                    if (diagnostics != null) {
156                        diagnostics.add(e.getDiagnostic());
157                    } else {
158                        diagnostics = Arrays.asList(e.getDiagnostic());
159                    }
160                    SRUXMLStreamWriter out =
161                            createXMLStreamWriter(response.getOutputStream(),
162                                    SRURecordPacking.XML,
163                                    req.getIndentResponse());
164                    writeFatalError(out, req, diagnostics);
165                } catch (Exception ex) {
166                    logger.error("An exception occured while in error state",
167                            ex);
168                }
169            } else {
170                logger.error("A fatal error occured, but the response was "
171                        + "already committed", e);
172            }
173        }
174    }
175
176
177    private void explain(SRURequestImpl request, HttpServletResponse response)
178            throws IOException, XMLStreamException, SRUException {
179        logger.info("explain");
180
181        // commence explain ...
182        final SRUExplainResult result =
183                searchEngine.explain(config, request, request);
184
185        try {
186            // send results
187            SRUXMLStreamWriter out =
188                    createXMLStreamWriter(response.getOutputStream(),
189                                          request.getRecordPacking(),
190                                          request.getIndentResponse());
191
192            beginResponse(out, request);
193
194            // write the explain record
195            writeExplainRecord(out, request);
196
197            if (config.getEchoRequests()) {
198                writeEchoedExplainRequest(out, request);
199            }
200
201            // diagnostics
202            writeDiagnosticList(out, request.getDiagnostics());
203
204            // extraResponseData
205            if (result != null) {
206                if (result.hasExtraResponseData()) {
207                    out.writeStartElement(SRU_NS, "extraResponseData");
208                    result.writeExtraResponseData(out);
209                    out.writeEndElement(); // "extraResponseData" element
210                }
211            }
212
213            endResponse(out);
214        } finally {
215            if (result != null) {
216                result.close();
217            }
218        }
219    }
220
221
222    private void scan(SRURequestImpl request, HttpServletResponse response)
223            throws IOException, XMLStreamException, SRUException {
224        logger.info("scan: scanClause = \"{}\"",
225                new Object[] { request.getRawScanClause() });
226
227        // commence scan
228        final SRUScanResultSet result =
229                searchEngine.scan(config, request, request);
230        if (result == null) {
231            throw new SRUException(SRUConstants.SRU_UNSUPPORTED_OPERATION,
232                    "The 'scan' operation is not supported by this endpoint.");
233        }
234
235        try {
236            // send results
237            SRUXMLStreamWriter out =
238                    createXMLStreamWriter(response.getOutputStream(),
239                                          request.getRecordPacking(),
240                                          request.getIndentResponse());
241
242            beginResponse(out, request);
243
244            try {
245                /*
246                 * a scan result without a list of terms is a valid response;
247                 * make sure, to produce the correct output and omit in that case
248                 * the <terms> ...
249                 */
250                boolean wroteTerms = false;
251                while (result.nextTerm()) {
252                    if (!wroteTerms) {
253                        out.writeStartElement(SRU_NS, "terms");
254                        wroteTerms = true;
255                    }
256                    out.writeStartElement(SRU_NS, "term");
257
258                    out.writeStartElement(SRU_NS, "value");
259                    out.writeCharacters(result.getValue());
260                    out.writeEndElement(); // "value" element
261
262                    if (result.getNumberOfRecords() > -1) {
263                        out.writeStartElement(SRU_NS, "numberOfRecords");
264                        out.writeCharacters(
265                                Integer.toString(result.getNumberOfRecords()));
266                        out.writeEndElement(); // "numberOfRecords" element
267                    }
268
269                    if (result.getDisplayTerm() != null) {
270                        out.writeStartElement(SRU_NS, "displayTerm");
271                        out.writeCharacters(result.getDisplayTerm());
272                        out.writeEndElement(); // "displayTerm" element
273                    }
274
275                    if (result.getWhereInList() != null) {
276                        out.writeStartElement(SRU_NS, "whereInList");
277                        switch (result.getWhereInList()) {
278                        case FIRST:
279                            out.writeCharacters("first");
280                            break;
281                        case LAST:
282                            out.writeCharacters("last");
283                            break;
284                        case ONLY:
285                            out.writeCharacters("only");
286                            break;
287                        case INNER:
288                            out.writeCharacters("inner");
289                            break;
290                        } // switch
291                        out.writeEndElement(); // "whereInList" element
292                    }
293
294                    if (result.hasExtraTermData()) {
295                        out.writeStartElement(SRU_NS, "extraTermData");
296                        result.writeExtraTermData(out);
297                        out.writeEndElement(); // "extraTermData" element
298                    }
299
300                    out.writeEndElement(); // "term" element
301                } // while
302                if (wroteTerms) {
303                    out.writeEndElement(); // "terms" element
304                }
305            } catch (NoSuchElementException e) {
306                throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR,
307                        "An internal error occurred while "
308                                + "serializing scan results.");
309            }
310
311            // echoedScanRequest
312            if (config.getEchoRequests()) {
313                writeEchoedScanRequest(out, request, request.getScanClause());
314            }
315
316            // diagnostics
317            writeDiagnosticList(out, request.getDiagnostics());
318
319            // extraResponseData
320            if (result.hasExtraResponseData()) {
321                out.writeStartElement(SRU_NS, "extraResponseData");
322                result.writeExtraResponseData(out);
323                out.writeEndElement(); // "extraResponseData" element
324            }
325
326            endResponse(out);
327        } finally {
328            if (result != null) {
329                result.close();
330            }
331        }
332    }
333
334
335    private void search(SRURequestImpl request, HttpServletResponse response)
336            throws IOException, XMLStreamException, SRUException {
337        logger.info("searchRetrieve: query = \"{}\", startRecord = {}, " +
338                "maximumRecords = {}, recordSchema = {}, resultSetTTL = {}",
339                new Object[] { request.getRawQuery(), request.getStartRecord(),
340                        request.getMaximumRecords(),
341                        request.getRecordSchemaIdentifier(),
342                        request.getResultSetTTL() });
343
344        // commence search ...
345        final SRUSearchResultSet result =
346                searchEngine.search(config, request, request);
347        if (result == null) {
348            throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR,
349                    "SRUSearchEngine implementation returned invalid result (null).");
350        }
351
352
353        // check, of startRecord position is greater than total record set
354        if ((result.getTotalRecordCount() > 0) && (request.getStartRecord() > 0) &&
355                (request.getStartRecord() > result.getTotalRecordCount())) {
356            throw new SRUException(SRUConstants.SRU_FIRST_RECORD_POSITION_OUT_OF_RANGE);
357        }
358
359        try {
360            // send results
361            SRUXMLStreamWriter out =
362                    createXMLStreamWriter(response.getOutputStream(),
363                                          request.getRecordPacking(),
364                                          request.getIndentResponse());
365
366            beginResponse(out, request);
367
368            // numberOfRecords
369            out.writeStartElement(SRU_NS, "numberOfRecords");
370            out.writeCharacters(
371                    Integer.toString(result.getTotalRecordCount()));
372            out.writeEndElement(); // "numberOfRecords" element
373
374            // resultSetId
375            if (result.getResultSetId() != null) {
376                out.writeStartElement(SRU_NS, "resultSetId");
377                out.writeCharacters(result.getResultSetId());
378                out.writeEndElement(); // "resultSetId" element
379            }
380
381            // resultSetIdleTime
382            if (result.getResultSetIdleTime() > 0) {
383                out.writeStartElement(SRU_NS, "resultSetIdleTime");
384                out.writeCharacters(Integer.toString(result
385                        .getResultSetIdleTime()));
386                out.writeEndElement(); // "resultSetIdleTime" element
387            }
388
389            int position = (request.getStartRecord() > 0)
390                    ? request.getStartRecord() : 1;
391            if (result.getRecordCount() > 0) {
392                final int maxPositionOffset =
393                        (request.getMaximumRecords() != -1)
394                        ? (position + request.getMaximumRecords() - 1)
395                        : -1;
396                try {
397                    out.writeStartElement(SRU_NS, "records");
398                    while (result.nextRecord()) {
399                        /*
400                         * Sanity check: do not return more then the maximum
401                         * requested records. If the search engine
402                         * implementation does not honor limit truncate the
403                         * result set.
404                         */
405                        if ((maxPositionOffset != -1) &&
406                                (position > maxPositionOffset)) {
407                            logger.error("SRUSearchEngine implementation did " +
408                                    "not honor limit for the amount of " +
409                                    "requsted records. Result set truncated!");
410                            break;
411                        }
412
413                        out.writeStartElement(SRU_NS, "record");
414
415                        /*
416                         * We need to output either the record or a surrogate
417                         * diagnostic. In case of the latter, we need to output
418                         * the appropriate record schema ...
419                         */
420                        final SRUDiagnostic diagnostic =
421                                result.getSurrogateDiagnostic();
422
423                        out.writeStartElement(SRU_NS, "recordSchema");
424                        if (diagnostic == null) {
425                            out.writeCharacters(
426                                    result.getRecordSchemaIdentifier());
427                        } else {
428                            out.writeCharacters(SRU_DIAGNOSTIC_RECORD_SCHEMA);
429                        }
430                        out.writeEndElement(); // "recordSchema" element
431
432                        // recordPacking
433                        writeRecordPacking(out, request.getRecordPacking());
434
435                        /*
436                         * Output either record data or surrogate diagnostic ...
437                         */
438                        out.writeStartElement(SRU_NS, "recordData");
439                        out.startRecord();
440                        if (diagnostic == null) {
441                            result.writeRecord(out);
442                        } else {
443                            // write a surrogate diagnostic
444                            writeDiagnostic(out, diagnostic, true);
445                        }
446                        out.endRecord();
447                        out.writeEndElement(); // "recordData" element
448
449                        /*
450                         * recordIdentifier is version 1.2 only
451                         */
452                        if (request.isVersion(SRUVersion.VERSION_1_2)) {
453                            final String identifier =
454                                    result.getRecordIdentifier();
455                            if (identifier != null) {
456                                out.writeStartElement(SRU_NS,
457                                                      "recordIdentifier");
458                                out.writeCharacters(identifier);
459                                out.writeEndElement(); // "recordIdentifier" element
460                            }
461                        }
462
463                        out.writeStartElement(SRU_NS, "recordPosition");
464                        out.writeCharacters(Integer.toString(position));
465                        out.writeEndElement(); // "recordPosition" element
466
467                        if (result.hasExtraRecordData()) {
468                            out.writeStartElement(SRU_NS, "extraRecordData");
469                            result.writeExtraRecordData(out);
470                            out.writeEndElement(); // "extraRecordData"
471                        }
472
473                        out.writeEndElement(); // "record" element
474
475                        position++;
476                    } // while
477                    out.writeEndElement(); // "records" element
478                } catch (NoSuchElementException e) {
479                    throw new SRUException(
480                            SRUConstants.SRU_GENERAL_SYSTEM_ERROR,
481                            "An internal error occurred while " +
482                            "serializing search result set.");
483                }
484            }
485
486            // nextRecordPosition
487            if (position <= result.getTotalRecordCount()) {
488                out.writeStartElement(SRU_NS, "nextRecordPosition");
489                out.writeCharacters(Integer.toString(position));
490                out.writeEndElement();
491            }
492
493            // echoedSearchRetrieveRequest
494            if (config.getEchoRequests()) {
495                writeEchoedSearchRetrieveRequest(out, request,
496                                                 request.getQuery());
497            }
498
499            // diagnostics
500            writeDiagnosticList(out, request.getDiagnostics());
501
502            // extraResponseData
503            if (result.hasExtraResponseData()) {
504                out.writeStartElement(SRU_NS, "extraResponseData");
505                result.writeExtraResponseData(out);
506                out.writeEndElement(); // "extraResponseData" element
507            }
508
509            endResponse(out);
510        } finally {
511            result.close();
512        }
513    }
514
515
516    private void beginResponse(SRUXMLStreamWriter out, SRUOperation operation,
517            SRUVersion version, String stylesheet) throws XMLStreamException {
518        out.writeStartDocument("utf-8", "1.0");
519
520        if (stylesheet != null) {
521            StringBuilder param = new StringBuilder();
522            param.append("type=\"text/xsl\"");
523            param.append(" ");
524            param.append("href=\"");
525            param.append(stylesheet);
526            param.append("\"");
527            out.writeProcessingInstruction("xml-stylesheet", param.toString());
528        }
529
530        out.setPrefix(SRU_PREFIX, SRU_NS);
531        switch (operation) {
532        case EXPLAIN:
533            out.writeStartElement(SRU_NS, "explainResponse");
534            break;
535        case SCAN:
536            out.writeStartElement(SRU_NS, "scanResponse");
537            break;
538        case SEARCH_RETRIEVE:
539            out.writeStartElement(SRU_NS, "searchRetrieveResponse");
540            break;
541        }
542        out.writeNamespace(SRU_PREFIX, SRU_NS);
543
544        // version
545        writeVersion(out, version);
546    }
547
548
549    private void beginResponse(SRUXMLStreamWriter out, SRURequest request)
550            throws XMLStreamException {
551        beginResponse(out, request.getOperation(), request.getVersion(),
552                request.getStylesheet());
553    }
554
555
556    private void endResponse(SRUXMLStreamWriter out)
557            throws XMLStreamException {
558        out.writeEndElement(); // "root" element
559
560        out.writeEndDocument();
561        out.close();
562        try {
563            out.getWriter().close();
564        } catch (IOException e) {
565            /* IGNORE */
566        }
567    }
568
569
570    private void writeFatalError(SRUXMLStreamWriter out,
571            SRURequestImpl request, List<SRUDiagnostic> diagnotics)
572            throws XMLStreamException {
573        /*
574         * if operation is unknown, default to 'explain'
575         */
576        SRUOperation operation = request.getOperation();
577        if (operation == null) {
578            operation = SRUOperation.EXPLAIN;
579        }
580        SRUVersion version = request.getVersion();
581        if (version == null) {
582            version = config.getDefaultVersion();
583        }
584        /*
585         * write a response which conforms to the schema
586         */
587        beginResponse(out, operation, version, null);
588        switch (operation) {
589        case EXPLAIN:
590            // 'explain' requires a complete explain record ...
591            writeExplainRecord(out, request);
592            break;
593        case SCAN:
594            // 'scan' fortunately does not need any elements ...
595            break;
596        case SEARCH_RETRIEVE:
597            // 'searchRetrieve' needs numberOfRecords ..
598            out.writeStartElement(SRU_NS, "numberOfRecords");
599            out.writeCharacters("0");
600            out.writeEndElement(); // "numberOfRecords" element
601            break;
602        }
603        writeDiagnosticList(out, diagnotics);
604        endResponse(out);
605    }
606
607
608    private void writeDiagnosticList(SRUXMLStreamWriter out,
609            List<SRUDiagnostic> diagnostics) throws XMLStreamException {
610        if ((diagnostics != null) && !diagnostics.isEmpty()) {
611            out.setPrefix(SRU_DIAGNOSTIC_PREFIX, SRU_DIAGNOSIC_NS);
612            out.writeStartElement(SRU_NS, "diagnostics");
613            out.writeNamespace(SRU_DIAGNOSTIC_PREFIX, SRU_DIAGNOSIC_NS);
614            for (SRUDiagnostic diagnostic : diagnostics) {
615                writeDiagnostic(out, diagnostic, false);
616            }
617            out.writeEndElement(); // "diagnostics" element
618        }
619    }
620
621
622    private void writeExplainRecord(SRUXMLStreamWriter out,
623            SRURequestImpl request) throws XMLStreamException {
624        out.writeStartElement(SRU_NS, "record");
625
626        out.writeStartElement(SRU_NS, "recordSchema");
627        out.writeCharacters(SRU_EXPLAIN_NS);
628        out.writeEndElement(); // "recordSchema" element
629
630        // recordPacking
631        writeRecordPacking(out, request.getRecordPacking());
632
633        out.writeStartElement(SRU_NS, "recordData");
634
635        out.startRecord();
636
637        // explain ...
638        out.setPrefix(SRU_EXPLAIN_PREFIX, SRU_EXPLAIN_NS);
639        out.writeStartElement(SRU_EXPLAIN_NS, "explain");
640        out.writeNamespace(SRU_EXPLAIN_PREFIX, SRU_EXPLAIN_NS);
641
642        // explain/serverInfo
643        out.writeStartElement(SRU_EXPLAIN_NS, "serverInfo");
644        out.writeAttribute("protocol", "SRU");
645        switch (config.getDefaultVersion()) {
646        case VERSION_1_1:
647            out.writeAttribute("version", "1.1");
648            break;
649        case VERSION_1_2:
650            out.writeAttribute("version", "1.2");
651        } // switch
652        out.writeAttribute("transport", config.getTransports());
653        out.writeStartElement(SRU_EXPLAIN_NS, "host");
654        out.writeCharacters(config.getHost());
655        out.writeEndElement(); // "host" element
656        out.writeStartElement(SRU_EXPLAIN_NS, "port");
657        out.writeCharacters(Integer.toString(config.getPort()));
658        out.writeEndElement(); // "port" element
659        out.writeStartElement(SRU_EXPLAIN_NS, "database");
660        out.writeCharacters(config.getDatabase());
661        out.writeEndElement(); // "database" element
662        out.writeEndElement(); // "serverInfo" element
663
664        // explain/databaseInfo
665        final DatabaseInfo dbinfo = config.getDatabaseInfo();
666        if (dbinfo != null) {
667            out.writeStartElement(SRU_EXPLAIN_NS, "databaseInfo");
668            writeLocalizedStrings(out, "title", dbinfo.getTitle());
669            writeLocalizedStrings(out, "description", dbinfo.getDescription());
670            writeLocalizedStrings(out, "author", dbinfo.getAuthor());
671            writeLocalizedStrings(out, "extent", dbinfo.getExtend());
672            writeLocalizedStrings(out, "history", dbinfo.getHistory());
673            writeLocalizedStrings(out, "langUsage", dbinfo.getLangUsage());
674            writeLocalizedStrings(out, "restrictions", dbinfo.getRestrictions());
675            writeLocalizedStrings(out, "subjects", dbinfo.getSubjects());
676            writeLocalizedStrings(out, "links", dbinfo.getLinks());
677            writeLocalizedStrings(out, "implementation",
678                    dbinfo.getImplementation());
679            out.writeEndElement(); // "databaseInfo" element
680        }
681
682        // explain/indexInfo
683        final IndexInfo indexInfo = config.getIndexInfo();
684        if (indexInfo != null) {
685            out.writeStartElement(SRU_EXPLAIN_NS, "indexInfo");
686
687            List<IndexInfo.Set> sets = indexInfo.getSets();
688            if (sets != null) {
689                for (IndexInfo.Set set : sets) {
690                    out.writeStartElement(SRU_EXPLAIN_NS, "set");
691                    out.writeAttribute("identifier", set.getIdentifier());
692                    out.writeAttribute("name", set.getName());
693                    writeLocalizedStrings(out, "title", set.getTitle());
694                    out.writeEndElement(); // "set" element
695                }
696            }
697
698            List<IndexInfo.Index> indexes = indexInfo.getIndexes();
699            if (indexes != null) {
700                for (IndexInfo.Index index : indexes) {
701                    out.writeStartElement(SRU_EXPLAIN_NS, "index");
702                    out.writeAttribute("search",
703                            index.canSearch() ? "true" : "false");
704                    out.writeAttribute("scan",
705                            index.canScan() ? "true" : "false");
706                    out.writeAttribute("sort",
707                            index.canSort() ? "true" : "false");
708                    writeLocalizedStrings(out, "title", index.getTitle());
709                    List<IndexInfo.Index.Map> maps = index.getMaps();
710                    if (maps != null) {
711                        for (IndexInfo.Index.Map map : maps) {
712                            out.writeStartElement(SRU_EXPLAIN_NS, "map");
713                            if (map.isPrimary()) {
714                                out.writeAttribute("primary", "true");
715                            }
716                            out.writeStartElement(SRU_EXPLAIN_NS, "name");
717                            out.writeAttribute("set", map.getSet());
718                            out.writeCharacters(map.getName());
719                            out.writeEndElement(); // "name" element
720                            out.writeEndElement(); // "map" element
721                        }
722                    }
723                    out.writeEndElement(); // "index" element
724                }
725            }
726            out.writeEndElement(); // "indexInfo" element
727        }
728
729        // explain/schemaInfo
730        final List<SchemaInfo> schemaInfo =
731                config.getSchemaInfo();
732        if (schemaInfo != null) {
733            out.writeStartElement(SRU_EXPLAIN_NS, "schemaInfo");
734            for (SRUServerConfig.SchemaInfo schema : schemaInfo) {
735                out.writeStartElement(SRU_EXPLAIN_NS, "schema");
736                out.writeAttribute("identifier", schema.getIdentifier());
737                out.writeAttribute("name", schema.getName());
738                /*
739                 * default is "false", so only add attribute if set to true
740                 */
741                if (schema.getSort() ) {
742                    out.writeAttribute("sort", "true");
743                }
744                /*
745                 * default is "true", so only add attribute if set to false
746                 */
747                if (!schema.getRetrieve()) {
748                    out.writeAttribute("retrieve", "false");
749                }
750                writeLocalizedStrings(out, "title", schema.getTitle());
751                out.writeEndElement(); // "schema" element
752            }
753            out.writeEndElement(); // "schemaInfo" element
754        }
755
756        // explain/configInfo
757        out.writeStartElement(SRU_EXPLAIN_NS, "configInfo");
758        // numberOfRecords (default)
759        out.writeStartElement(SRU_EXPLAIN_NS, "default");
760        out.writeAttribute("type", "numberOfRecords");
761        out.writeCharacters(Integer.toString(config.getNumberOfRecords()));
762        out.writeEndElement(); // default" element
763
764        // maximumRecords (setting)
765        out.writeStartElement(SRU_EXPLAIN_NS, "setting");
766        out.writeAttribute("type", "maximumRecords");
767        out.writeCharacters(Integer.toString(config.getMaximumRecords()));
768        out.writeEndElement(); // "setting" element
769
770        out.writeEndElement(); // "configInfo" element
771
772        out.writeEndElement(); // "explain" element
773
774        out.endRecord();
775
776        out.writeEndElement(); // "recordData" element
777        out.writeEndElement(); // "record" element
778    }
779
780
781    private void writeDiagnostic(SRUXMLStreamWriter out,
782            SRUDiagnostic diagnostic, boolean writeNsDecl)
783            throws XMLStreamException {
784        if (writeNsDecl) {
785            out.setPrefix(SRU_DIAGNOSTIC_PREFIX, SRU_DIAGNOSIC_NS);
786        }
787        out.writeStartElement(SRU_DIAGNOSIC_NS, "diagnostic");
788        if (writeNsDecl) {
789            out.writeNamespace(SRU_DIAGNOSTIC_PREFIX, SRU_DIAGNOSIC_NS);
790        }
791        out.writeStartElement(SRU_DIAGNOSIC_NS, "uri");
792        out.writeCharacters(SRUConstants.SRU_DIAGNOSTIC_URI_PREFIX);
793        out.writeCharacters(Integer.toString(diagnostic.getCode()));
794        out.writeEndElement(); // "uri" element
795        if (diagnostic.getDetails() != null) {
796            out.writeStartElement(SRU_DIAGNOSIC_NS, "details");
797            out.writeCharacters(diagnostic.getDetails());
798            out.writeEndElement(); // "details" element
799        }
800        if (diagnostic.getMessage() != null) {
801            out.writeStartElement(SRU_DIAGNOSIC_NS, "message");
802            out.writeCharacters(diagnostic.getMessage());
803            out.writeEndElement(); // "message" element
804        }
805        out.writeEndElement(); // "diagnostic" element
806    }
807
808
809    private void writeEchoedExplainRequest(SRUXMLStreamWriter out,
810            SRURequestImpl request) throws XMLStreamException,
811            SRUException {
812        // echoedSearchRetrieveRequest
813        out.writeStartElement(SRU_NS, "echoedExplainRequest");
814
815        // echoedExplainRequest/version
816        if (request.getRawVersion() != null) {
817            writeVersion(out, request.getRawVersion());
818        }
819
820        // echoedExplainRequest/recordPacking
821        if (request.getRawRecordPacking() != null) {
822            writeRecordPacking(out, request.getRawRecordPacking());
823        }
824
825        // echoedExplainRequest/stylesheet
826        if (request.getStylesheet() != null) {
827            out.writeStartElement(SRU_NS, "stylesheet");
828            out.writeCharacters(request.getStylesheet());
829            out.writeEndElement(); // "stylesheet" element
830        }
831
832        // echoedExplainRequest/baseUrl (SRU 1.2 only)
833        if (request.isVersion(SRUVersion.VERSION_1_2)) {
834            writeBaseUrl(out, request);
835        }
836
837        out.writeEndElement(); // "echoedExplainRequest" element
838    }
839
840
841    private void writeEchoedScanRequest(SRUXMLStreamWriter out,
842            SRURequestImpl request, CQLNode cql) throws XMLStreamException,
843            SRUException {
844        // echoedScanRequest
845        out.writeStartElement(SRU_NS, "echoedScanRequest");
846
847        // echoedScanRequest/version
848        if (request.getRawVersion() != null) {
849            writeVersion(out, request.getRawVersion());
850        }
851
852        // echoedScanRequest/scanClause
853        out.writeStartElement(SRU_NS, "scanClause");
854        out.writeCharacters(request.getRawScanClause());
855        out.writeEndElement(); // "query"
856
857        // echoedScanRequest/xScanClause
858        out.setDefaultNamespace(SRU_XCQL_NS);
859        out.writeStartElement(SRU_NS, "xScanClause");
860        out.writeDefaultNamespace(SRU_XCQL_NS);
861        out.writeXCQL(cql, false);
862        out.writeEndElement(); // "xScanClause" element
863
864        // echoedScanRequest/responsePosition
865        if (request.getResponsePosition() != -1) {
866            out.writeStartElement(SRU_NS, "responsePosition");
867            out.writeCharacters(
868                    Integer.toString(request.getResponsePosition()));
869            out.writeEndElement(); // "responsePosition" element
870        }
871
872        // echoedScanRequest/maximumTerms
873        if (request.getMaximumTerms() != -1) {
874            out.writeStartElement(SRU_NS, "maximumTerms");
875            out.writeCharacters(Integer.toString(request.getMaximumTerms()));
876            out.writeEndElement(); // "maximumTerms" element
877        }
878
879        // echoedScanRequest/stylesheet
880        if (request.getStylesheet() != null) {
881            out.writeStartElement(SRU_NS, "stylesheet");
882            out.writeCharacters(request.getStylesheet());
883            out.writeEndElement(); // "stylesheet" element
884        }
885
886        // echoedScanRequest/baseUrl (SRU 1.2 only)
887        if (request.isVersion(SRUVersion.VERSION_1_2)) {
888            writeBaseUrl(out, request);
889        }
890
891        out.writeEndElement(); // "echoedScanRequest" element
892    }
893
894
895    private void writeEchoedSearchRetrieveRequest(SRUXMLStreamWriter out,
896            SRURequestImpl request, CQLNode cql) throws XMLStreamException,
897            SRUException {
898        // echoedSearchRetrieveRequest
899        out.writeStartElement(SRU_NS, "echoedSearchRetrieveRequest");
900
901        // echoedSearchRetrieveRequest/version
902        if (request.getRawVersion() != null) {
903            writeVersion(out, request.getRawVersion());
904        }
905
906        // echoedSearchRetrieveRequest/query
907        out.writeStartElement(SRU_NS, "query");
908        out.writeCharacters(request.getRawQuery());
909        out.writeEndElement(); // "query"
910
911        // echoedSearchRetrieveRequest/xQuery
912        out.setDefaultNamespace(SRU_XCQL_NS);
913        out.writeStartElement(SRU_NS, "xQuery");
914        out.writeDefaultNamespace(SRU_XCQL_NS);
915        out.writeXCQL(cql, true);
916        out.writeEndElement(); // "xQuery" element
917
918        // echoedSearchRetrieveRequest/startRecord
919        if (request.getStartRecord() > 0) {
920            out.writeStartElement(SRU_NS, "startRecord");
921            out.writeCharacters(Integer.toString(request.getStartRecord()));
922            out.writeEndElement(); // "startRecord" element
923        }
924
925        // echoedSearchRetrieveRequest/maximumRecords
926        if (request.getRawMaximumRecords() > 0) {
927            out.writeStartElement(SRU_NS, "maximumRecords");
928            out.writeCharacters(
929                    Integer.toString(request.getRawMaximumRecords()));
930            out.writeEndElement(); // "startRecord" element
931        }
932
933        // echoedSearchRetrieveRequest/recordPacking
934        if (request.getRawRecordPacking() != null) {
935            writeRecordPacking(out, request.getRawRecordPacking());
936        }
937
938        // echoedSearchRetrieveRequest/recordSchema
939        if (request.getRecordSchemaName() != null) {
940            out.writeStartElement(SRU_NS, "recordSchema");
941            out.writeCharacters(request.getRecordSchemaName());
942            out.writeEndElement(); // "recordSchema" element
943        }
944
945        // echoedSearchRetrieveRequest/recordXPath (1.1)
946        if (request.isVersion(SRUVersion.VERSION_1_1) &&
947                (request.getRecordXPath() != null)) {
948            out.writeStartElement(SRU_NS, "recordXPath");
949            out.writeCharacters(request.getRecordXPath());
950            out.writeEndElement(); // "recordXPath" element
951        }
952
953        // echoedSearchRetrieveRequest/resultSetTTL
954        if (request.getResultSetTTL() > 0) {
955            out.writeStartElement(SRU_NS, "resultSetTTL");
956            out.writeCharacters(Long.toString(request.getResultSetTTL()));
957            out.writeEndElement(); // "resultSetTTL" element
958        }
959
960        // echoedSearchRetrieveRequest/sortKeys
961        if (request.isVersion(SRUVersion.VERSION_1_1) &&
962                (request.getSortKeys() != null)) {
963            out.writeStartElement(SRU_NS, "sortKeys");
964            out.writeCharacters(request.getSortKeys());
965            out.writeEndElement(); // "sortKeys" element
966        }
967
968        // echoedSearchRetrieveRequest/xsortKeys
969
970        // echoedSearchRetrieveRequest/stylesheet
971        if (request.getStylesheet() != null) {
972            out.writeStartElement(SRU_NS, "stylesheet");
973            out.writeCharacters(request.getStylesheet());
974            out.writeEndElement(); // "stylesheet" element
975        }
976
977        // echoedSearchRetrieveRequest/baseUrl (SRU 1.2 only)
978        if (request.isVersion(SRUVersion.VERSION_1_2)) {
979            writeBaseUrl(out, request);
980        }
981
982        out.writeEndElement(); // "echoedSearchRetrieveRequest" element
983    }
984
985
986    private void writeVersion(SRUXMLStreamWriter out, SRUVersion version)
987            throws XMLStreamException {
988        out.writeStartElement(SRU_NS, "version");
989        switch (version) {
990        case VERSION_1_1:
991            out.writeCharacters("1.1");
992            break;
993        case VERSION_1_2:
994            out.writeCharacters("1.2");
995            break;
996        } // switch
997        out.writeEndElement(); // "version" element
998    }
999
1000
1001    private void writeRecordPacking(SRUXMLStreamWriter out,
1002            SRURecordPacking recordPacking) throws XMLStreamException {
1003        out.writeStartElement(SRU_NS, "recordPacking");
1004        switch (recordPacking) {
1005        case XML:
1006            out.writeCharacters("xml");
1007            break;
1008        case STRING:
1009            out.writeCharacters("string");
1010            break;
1011        } // switch
1012        out.writeEndElement(); // "recordPacking" element
1013    }
1014
1015
1016    private void writeBaseUrl(SRUXMLStreamWriter out,
1017            SRURequest request) throws XMLStreamException {
1018        out.writeStartElement(SRU_NS, "baseUrl");
1019        out.writeCharacters(request.getProtocolScheme());
1020        out.writeCharacters(config.getBaseUrl());
1021        out.writeEndElement(); // "baseUrl" element
1022    }
1023
1024
1025    private void writeLocalizedStrings(XMLStreamWriter writer, String name,
1026            List<LocalizedString> list) throws XMLStreamException {
1027        if ((list != null) && !list.isEmpty()) {
1028            for (LocalizedString item : list) {
1029                writer.writeStartElement(SRU_EXPLAIN_NS, name);
1030                if (item.getLang() != null) {
1031                    writer.writeAttribute("lang", item.getLang());
1032                }
1033                if (item.isPrimary()) {
1034                    writer.writeAttribute("primary", "true");
1035                }
1036                writer.writeCharacters(item.getValue());
1037                writer.writeEndElement();
1038            }
1039        }
1040    }
1041
1042
1043    private SRUXMLStreamWriter createXMLStreamWriter(OutputStream out,
1044            SRURecordPacking recordPacking, int indent) throws SRUException {
1045        try {
1046            return new SRUXMLStreamWriter(out, writerFactory, recordPacking,
1047                    indent);
1048        } catch (Exception e) {
1049            throw new SRUException(SRUConstants.SRU_GENERAL_SYSTEM_ERROR,
1050                    "Error creating output stream.", e);
1051
1052        }
1053    }
1054
1055} // class SRUService
Note: See TracBrowser for help on using the repository browser.