DOCSLIB.ORG

Java Application Developer's Guide (PDF)

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Java Application Developer's Guide (PDF) MarkLogic Server Java Application Developer’s Guide 1 MarkLogic 10 May, 2019 Last Revised: 10.0, May, 2019 Copyright © 2019 MarkLogic Corporation. All rights reserved. MarkLogic Server Table of Contents Table of Contents Java Application Developer’s Guide 1.0 Introduction to the Java API ........................................................................12 1.1 Java Client API Overview ....................................................................................12 1.2 Java Client API or Java XCC? ..............................................................................13 1.3 Getting Started ......................................................................................................14 1.3.1 Required Software ....................................................................................14 1.3.2 Make the Libraries Available to Your Application ..................................14 1.3.2.1 ZIP File ......................................................................................14 1.3.2.2 Maven ........................................................................................15 1.3.2.3 Gradle ........................................................................................15 1.3.3 Choose a REST API Instance ...................................................................15 1.3.4 Create Users ..............................................................................................16 1.3.5 Explore the Examples ...............................................................................16 1.4 Creating, Working With, And Releasing a Database Client .................................17 1.4.1 The Role of a Database Client ..................................................................17 1.4.2 Expected Database Client Lifetime ..........................................................17 1.4.3 Connection Management and Configuration ............................................17 1.4.4 Creating a Database Client .......................................................................18 1.4.5 Connecting Through a Load Balancer ......................................................19 1.4.6 Releasing a Database Client .....................................................................19 1.5 Authentication and Connection Security ..............................................................20 1.5.1 Creating a SecurityContext Object ...........................................................20 1.5.2 Using Kerberos Authentication ................................................................20 1.5.2.1 Configuring MarkLogic to Use Kerberos .................................21 1.5.2.2 Configuring Your Client Host for Kerberos .............................21 1.5.2.3 Creating a Database Client that Uses Kerberos ........................22 1.5.3 Connecting to MarkLogic with SSL .........................................................22 1.5.4 Using SAML Authentication ....................................................................24 1.6 A Basic “Hello World” Method ............................................................................26 1.7 Document Managers .............................................................................................26 1.8 Streaming ..............................................................................................................27 1.9 Using Handles for Input and Output .....................................................................27 1.9.1 Handle Overview ......................................................................................27 1.9.2 Specifying Content Format .......................................................................29 1.9.3 Handle Type Quick Reference ..................................................................29 1.9.4 Handle Example ........................................................................................30 1.10 Shortcut Methods as an Alternative to Creating Handles .....................................31 1.10.1 Understanding Shortcut Methods .............................................................31 1.10.2 When to Choose Strongly Typed Over Shortcut ......................................32 MarkLogic 10—May, 2019 Java Application Developer’s Guide—Page 2 MarkLogic Server Table of Contents 1.10.3 Extending Shortcuts by Registering Handle Factories .............................33 1.11 Thread Safety of the Java API ..............................................................................34 1.12 Downloading the Library Source Code ................................................................34 2.0 Single Document Operations .......................................................................36 2.1 Document Creation ...............................................................................................36 2.1.1 Writing an XML or JSON Document To The Database ..........................37 2.1.2 Creating a Text Document In the Database ..............................................38 2.1.3 Automatically Generating Document URIs ..............................................39 2.1.4 Format-Specific Write Capabilities ..........................................................40 2.2 Document Deletion ...............................................................................................40 2.3 Reading Document Content ..................................................................................41 2.4 Writing A Binary Document .................................................................................43 2.5 Reading Content From A Binary Document ........................................................43 2.6 Reading, Modifying, and Writing Metadata .........................................................43 2.6.1 Document Metadata ..................................................................................44 2.6.2 Reading Document Metadata ....................................................................44 2.6.3 Collections Metadata ................................................................................46 2.6.4 Values Metadata .......................................................................................47 2.6.5 Properties Metadata ..................................................................................48 2.6.6 Quality Metadata .......................................................................................48 2.6.7 Permissions Metadata ...............................................................................49 2.6.8 Manipulating Document Metadata In Your Application ..........................49 2.6.9 Writing Metadata ......................................................................................50 2.7 Working with Temporal Documents ....................................................................50 2.8 Conversion of Document Encoding ......................................................................51 2.9 Partially Updating Document Content and Metadata ...........................................53 2.9.1 Introduction to Content and Metadata Patching .......................................54 2.9.2 Basic Steps for Patching Documents and Metadata .................................56 2.9.3 Construct a Patch From Raw XML or JSON ...........................................58 2.9.4 Defining the Context for a Patch Operation .............................................60 2.9.5 Example: Replacing Parts of a JSON Document ......................................60 2.9.6 Example: Patching Metadata ....................................................................61 2.9.7 Managing XML Namespaces in a Patch ...................................................65 2.9.7.1 Defining Namespaces With a Builder .......................................66 2.9.7.2 Defining Namespaces in Raw XML .........................................67 2.9.8 Construct Replacement Data on the Server ..............................................67 3.0 Synchronous Multi-Document Operations ..................................................70 3.1 Write Multiple Documents ...................................................................................70 3.1.1 Overview of Multi-Document Write ........................................................70 3.1.2 Example: Loading Multiple Documents ...................................................72 3.1.3 Understanding Metadata Scoping .............................................................73 3.1.4 Understanding When Metadata is Preserved or Replaced ........................76 3.1.5 Example: Controlling Metadata Through Defaults ..................................77 MarkLogic 10—May, 2019 Java Application Developer’s Guide—Page 3 MarkLogic Server Table of Contents 3.1.6 Example: Adding Documents to a Collection ..........................................80 3.1.7 Example: Writing a Mixed Document Set ................................................81 3.2 Read Multiple Documents by URI .......................................................................83 3.3 Read Multiple Documents Matching a Query ......................................................84 3.3.1 Overview of Multi-Document Read by Query .........................................84 3.3.2 Example: Read Documents Matching a Query .........................................85 3.3.3 Add Query Options to a Search ................................................................87 3.3.4 Return Search Results ...............................................................................88 3.3.5 Read Documents Incrementally
Load more

Recommended publications
  • Xml Parsing with Dom4j
    University at Buffalo Hanifi Gunes Spring 2011 PhD Candidate Computer Science & Engineering CSE 586 - Distributed Systems hanifigu{at}buffalo{dot}edu xml parsing with dom4j In this tutorial we will talk about XML parsing with dom4j, an easy to use, open source library working with XML, XPath and XSLT on the Java platform. So let’s get started. ➀ Download and install eclipse for Java developers: http://www.eclipse.org Download the dom4j jar package: http://dom4j.sourceforge.net Download the jaxen jar package: http://jaxen.codehaus.org ➁ Run eclipse and locate your workspace directory if you are running it for the first time. Now, create a new Java Project, MyXMLReader, from File ➝ New ➝ Java Project. Notice that the project is created under the workspace directory {workspace_dir}/MyXMLReader. ➂ Right click on your project and select Build Path ➝ Add External Archives. Locate and add the dom4j jar archive from step 1 and repeat the same procedure to add the jaxen package to your build path. At that point, you should see these packages listed under Referenced Libraries as it is on the left snapshot. ➃ Now that, the project setup is done we can work with Yahoo! Weather. Visit http:// developer.yahoo.com/weather/ to get familiar with the XML response schema. First thing to observe is that you can query Yahoo Weather for a particular zip code using the following pattern http://weather.yahooapis.com/forecastrss?p=ZIPCODE. Try substituting your own zip code into the address pattern and then navigate to that address from your browser in order to inspect the XML response.
    [Show full text]
  • Product Description for Saxon- HE (Home Edition) Version 9.7 Released Nov 2015 Page 1/4
    Product Description for Saxon- HE (Home Edition) Version 9.7 released Nov 2015 Page 1/4 This document lists the features provided by Saxon 9.7 open source Home Edition (Saxon-HE). This document does not form part of any contract unless expressly incorporated. Language Support 1. XSLT (Transformation Processing) 1.1 XSLT 2.0 Provides a basic XSLT 2.0 processor as defined in section 21 of the (Basic) XSLT 2.0 Recommendation: it is a conformance level that includes all features of the language other than those that involve schema processing. For more details see: XSLT 2.0 conformance. Relevant W3C Specification: XSLT 2.0 Recommendation (23 January 2007). 2. XPath 2.1 XPath 2.0 Provides all XPath 2.0 features other than schema-awareness. (Basic) For more details see: XPath 2.0 conformance. Relevant W3C Specification: XPath 2.0 Recommendation (14 December 2010). 2.2 XPath 3.0 Provides all XPath 3.0 features other than schema-awareness and (Basic) higher-order functions. For more details see: XPath 3.0 conformance. Relevant W3C Specification: XPath 3.0 Recommendation (08 April 2014). 2.3 XPath 3.1 Provides all XPath 3.1 features other than schema-awareness and (Basic) higher-order functions. This includes an implementation of maps and arrays, and support for JSON. For more details see: XPath 3.1 conformance. Relevant W3C Specification: XPath 3.1 Candidate Recommendation (18 December 2014). Product Description for Saxon-HE (Home Edition) © Saxonica Ltd. 2017 Product Description for Saxon- HE (Home Edition) Version 9.7 released Nov 2015 Page 2/4 3.
    [Show full text]
  • JAVA XML Interview Questions
    JJAAVVAA XXMMLL -- IINNTTEERRVVIIEEWW QQUUEESSTTIIOONNSS http://www.tutorialspoint.com/java_xml/java_xml_interview_questions.htm Copyright © tutorialspoint.com Dear readers, these JAVA based XML Parsing Interview Questions have been designed specially to get you acquainted with the nature of questions you may encounter during your interview for the subject of JAVA based XML Parsing. As per my experience good interviewers hardly plan to ask any particular question during your interview, normally questions start with some basic concept of the subject and later they continue based on further discussion and what you answer − What XML stands for? XML stands for Extensible Markup Language. What are the advantages of using XML? Following are the advantages that XML provides − Technology agnostic - Being plain text, XML is technology independent. It can be used by any technology for data storage and transmission purpose. Human readable- XML uses simple text format. It is human readable and understandable. Extensible - in XML, custom tags can be created and used very easily. Allow Validation - Using XSD, DTD and XML structure can be validated easily. What are the disadvantages of using XML? Following are the disadvantages of XML usage − Redundant Syntax - Normally XML file contains lot of repeatitive terms. Verbose-Being a verbose language, XML file size increases the transmission and storage costs. What is XML Parsing? Parsing XML refers to going through XML document to access data or to modify data in one or other way. What is XML Parser? XML Parser provides way how to access or modify data present in an XML document. Java provides multiple options to parse XML document.
    [Show full text]
  • Designing of an Xpath Engine for P2P XML Store
    Designing of an XPath Engine for P2P XML Store Jovic, Darko; and Milutinovic, Veljko We can use XPath engine which works with Abstract— In the introductory part, this paper generic DOM and use it on top of P2P DOM defines the general environment for this research layer. This way we get full XPath functionality, but and defines the terms of interest. Then we define query execution is performed locally. All required the research problem: How to perform distributed node sets are pulled from the community and XPath query execution in a P2P environment. nodes matched against query to get the result. Existing solutions to the problem are briefly surveyed, and their drawbacks are underlined; Getting node sets from the community in case of each surveyed piece of research is analyzed large XML documents can cause increased according to the same template. Then, the essence communication among local peer and other of the proposed solution is presented: peers which contain node sets for specific implementation of an XPath engine which works in documents. High communication traffic can be a P2P environment and performs distributed avoided by distributing XPath query execution. query execution. The conclusion is from the point of view of performance/complexity ratio. 1. INTRODUCTION PATH is a language for addressing parts of X an XML document, designed to be used by both XSLT and XPointer [1][4]. XPath expressions are used to query XML data, express transformations and reference elements in remote documents. XPath is specification language designed by the World Wide Web Consortium (W3C) [6]. It is an expression language for addressing parts of an XML document, used by various XML Figure 1: Peer-to-Peer XML Storage System technologies such as XSL Transformation (XSLT) and XML Pointer Language (XPointer).
    [Show full text]
  • Xpath 2.0 in Context
    P1: KTX WY030-01 WY030-Kay WY030-Kay-v3.cls July 7, 2004 15:52 XPath 2.0 in Context This chapter explains what kind of language XPath is, and some of the design thinking behind it. It explains how XPath relates to the other specifications in the growing XML family, and to describe what’s new in XPath 2.0 compared with XPath 1.0. The chapter starts with an introduction to the basic concepts behind the language, its data model and the different kinds of expression it supports. This is followed by a survey of new features, since I think it’s likely that many readers of this book will already have some familiarity with XPath 1.0. I also introduce a few software products that you can use to try out these new features. The central part of the chapter is concerned with the relationships between XPath and other languages and specifications: with XSLT, with XML itself and XML namespaces, with XPointer, with XQuery, and with XML Schema. It also takes a look at the way XPath interacts with Java and with the various document object models (DOM and its variations). The final section of the chapter tries to draw out the distinctive features of the language, the things that make XPath different. The aim is to understand what lies behind the peculiarities of the language, to get an appreciation for the reasons (sometimes good reasons and sometimes bad) why the language is the way it is. Hopefully, with this insight, you will be able to draw on the strengths of the language and learn to skirt round its weaker points.
    [Show full text]
  • A Performance Based Comparative Study of Different Apis Used for Reading and Writing XML Files
    A Performance Based Comparative Study of Different APIs Used for Reading and Writing XML Files A Thesis submitted to the Graduate School at the University of Cincinnati In Partial Fulfillment of the requirements for the Degree of MASTER OF SCIENCE In the School of Electronics and Computing Systems of the College of Engineering and Applied Sciences By Neha Gujarathi Bachelor of Engineering (B. E.), 2009 University of Pune, India Committee Chair: Dr. Carla Purdy ABSTRACT Recently, XML (eXtensible Markup Language) files have become of great importance in business enterprises. Information in the XML files can be easily shared across the web. Thus, extracting data from XML documents and creating XML documents become important topics of discussion. There are many APIs (Application Program Interfaces) available which can perform these operations. For beginners in XML processing, selecting an API for a specific project is a difficult task. In this thesis we compare various APIs that are capable of extracting data and / or creating XML files. The comparison is done based on the performance time for different types of inputs which form different cases. The codes for all the different cases are implemented. Two different systems, one with Windows 7 OS and another with Mac OS are used to perform all the experiments. Using the results found we propose a suitable API for a given condition. In addition to the performance, programming ease for these APIs is taken into consideration as another aspect for comparison. To compare the programming ease, aspects such as number of lines of code, complexity of the code and complexity of understanding the coding for the particular API are considered.
    [Show full text]
  • XML Retrieval with Results Clustering on Android
    Proceedings of the 2012 2nd International Conference on Computer and Information Application (ICCIA 2012) XML Retrieval with Results Clustering on Android Pengfei Liu,Yanhua Chen,Wenjie Xie, Qiaoyi Hu Department of Mathematics South China Agricultural University Guangzhou, China [email protected], [email protected], [email protected],[email protected] Abstract—XML receives widely interests in data exchanging generating devices and can exchange data freely via and information management on both traditional desktop Bluetooth or WIFI, and then we can process data just by computing platforms and rising mobile computing platforms. mobile devices realtime. The idea of mining XML However, traditional XML retrieval does not work on mobile documents anywhere and anytime is very amazing but not devices due to the mobile platforms’ limitations and diversities. crazy. Clustering XML data is more complicated than common Considering that XML retrieval on mobile devices will text data as XML allows inserting structural and conceptual become increasingly popular, in this article, we have paid aspects into document content. An XML document includes attention to the design and implementation of XML retrieval tags and data; while tags describing names of elements and results clustering model on the android platform, building on jaxen and dom4j, the XML parser and retrieval engine; contain concepts as text data. Besides that, structure tags also furthermore, the K-means clustering algorithm. show the relationship between elements. Now, research work dedicated to XML document As an example of usage, we have tested the prototype on clustering mainly has three types, including structure-based some data sets to the mobile scenario and illustrated the method, content-based method and combination of both.
    [Show full text]
  • Java API for XML Processing (JAXP)
    Java API for XML Processing (JAXP) • API that provides an abstraction layer to XML parser implementations (specifically implementations of DOM and SAX), and applications that process Extensible Stylesheet Language Transformations (XSLT) • JAXP is is a layer above the parser APIs that makes it easier to perform some vendor-specific tasks in a vendor-neutral fashion. JAXP employs the Abstract Factory design pattern to provide a plugability layer, which allows you to plug in an implementation of DOM or SAX, or an application that processes XSLT • The primary classes of the JAXP plugability layer are javax.xml.parsers.DocumentBuilderFactory, javax.xml.parsers.SAXParserFactory, and javax.xml.transform.TransformerFactory. • Classes are abstract so you must ask the specific factory to create an instance of itself, and then use that instance to create a javax.xml.parsers.DocumentBuilder, javax.xml.parsers.SAXParser, or javax.xml.transform.Transformer, respectively. • DocumentBuilder abstracts the underlying DOM parser implementation, SAXParser the SAX parser implementation, and Transformer the underlying XSLT processor. DocumentBuilder, SAXParser, and Transformer are also abstract classes, so instances of them can only be obtained through their respective factory. JAXP Example - 1 import java.io.*; import javax.xml.*; import org.w3c.dom.Document; import org.xml.sax.SAXException; import javawebbook.sax.ContentHandlerExample; public class JAXPTest { public static void main(String[] args) throws Exception { File xmlFile = new File(args[0]); File
    [Show full text]
  • Java Parse Xml Document
    Java Parse Xml Document John-Patrick sovietizes his copses staunches preposterously or starchily after Dimitris plague and tenters untremblingly, popliteal and uncomposable. Lomentaceous Sayer dwarf her heavings so coevally that Filbert pinches very methodically. Unrequired Cobb bellying very operationally while Jamie remains ungulate and slashed. The allocation size is stored in our detailed steps, an xml using jdom to implement it is the parse xml document by james gosling and For each employee element get the id, Ruby and old on. Are the sure but want to delete this comment? Create content and provides data documents can also create an entity reference exhibited by. This is an extremely flexible and powerful technique for processing XML. Solved Java Parse XML or text file CodeProject. DocumentBuilderFactory dbf DocumentBuilderFactorynewInstance DocumentBuilder db dbfnewDocumentBuilder Document doc dbparsenew File. Java and open great stuff. It would indeed synchronous. ParsexmlFile The parse method parses the XML file into a Document docgetDocumentElementnormalize Normalizing the. Memory usage: Memory usage is important when parsing very big XML files. Xerces-J Parser Overview DOMParser methods Void parse javalangString Xerces-J DOMParser DOM interfaces Document Element. This example that regenerates sax parser will be learned about them, then verify yourself there would sauron kept doing it? XML parsing is used to cheat the data match the XML format files in our Android. The Sun parser calls a static method on the XmlDocument class to parse and. How to java parse xml document order to parse it down the factory methods included in a factory. Are elements must be supported by their logs are doing json parsing at one of tag data between nodes that has a software from.
    [Show full text]
  • XML Prague 2018 – Conference Proceedings Copyright © 2018 Jiří Kosek
    XML Prague 2018 Conference Proceedings University of Economics, Prague Prague, Czech Republic February 8–10, 2018 XML Prague 2018 – Conference Proceedings Copyright © 2018 Jiří Kosek ISBN 978-80-906259-4-5 (pdf) ISBN 978-80-906259-5-2 (ePub) X-definition X-definition gggggcuments lGdefinitionlllllllllllllll documents. lllllllllllstand lllllllllllllllta lllllllprehenlllGdefinitionllllllll lllllllllllctures. Validationgggtruction lGdefinitionlllllll)llll lllllllGlllllnguage. lllllllllllllll llllllllllllort lllllllllllocessing gggerconnecg lGdefinitionllllconnectionl lllllllllllllllll llllllllxGmponexllllllll llllllXMLlllllllllIlllll" Connecggtabasggg llGllllllIlll llll"llllllll ggenanceggg lllllGdefinitionllllllll lllllllllllIl" ggggw.syntea.cz Table of Contents General Information ..................................................................................................... vii Sponsors .......................................................................................................................... ix Preface .............................................................................................................................. xi Assisted Structured Authoring using Conditional Random Fields – Bert Willems ...................................................................................................................... 1 XML Success Story: Creating and Integrating Collaboration Solutions to Improve the Documentation Process – Steven Higgs ............................................... 13 xqerl: XQuery 3.1 Implementation
    [Show full text]
  • ADEP Adobe Digital Enterprise Platform - CRX
    ADEP Adobe Digital Enterprise Platform - CRX Third Party Software Notices and/or Additional Terms and Conditions The contents of this file are subject to the Netscape Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/NPL/ Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Original Code is Mozilla Communicator client code, released March 31, 1998. The Initial Developer of the Original Code is Netscape Communications Corporation. Portions created by Netscape are Copyright (C) 1998-1999 Netscape Communications Corporation. All Rights Reserved. W3C® SOFTWARE NOTICE AND LICENSE http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 This work (and included software, documentation such as READMEs, or other related items) is being provided by the copyright holders under the following license. By obtaining, using and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions. Permission to copy, modify, and distribute this software and its documentation, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the software and documentation or portions thereof, including modifications: 1. The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
    [Show full text]
  • Alternate Syntax for XSLT
    Rochester Institute of Technology RIT Scholar Works Theses 2007 Alternate syntax for XSLT David Love Follow this and additional works at: https://scholarworks.rit.edu/theses Recommended Citation Love, David, "Alternate syntax for XSLT" (2007). Thesis. Rochester Institute of Technology. Accessed from This Thesis is brought to you for free and open access by RIT Scholar Works. It has been accepted for inclusion in Theses by an authorized administrator of RIT Scholar Works. For more information, please contact [email protected]. Alternate Syntax for XSLT David Love Department of Computer Science Rochester Institute of Technology Rochester, NY, USA [email protected] November 5, 2007 Abstract XSLT is a transform language for XML that is defined over XML. In other words, XSLT is a language that performs transforms on XML documents, and XSLT programs are themselves XML documents. While XSLT is by nature a functional language, its definition as an XML application obfuscates this fact [15]. Previous research projects have taken the XML-Infoset and provided an alternate syntax in the form of S-expressions, along with providing languages to perform transformations of the new representation in manners similar to that of XSLT. For example, SXML / SXSLT performs this function by embedding said languages in Scheme [9]. XLove applies modern principles of object-oriented design, namely design patterns, to this problem. Xl is an alternate syntax for the XML-Infoset. It maintains a clear distinction between attributes and elements (while having a concise notation for namespaces). The syntax is built into a representation over the Document Object Model by observers responding to parsing events.
    [Show full text]