Welcome!

Java IoT Authors: Tim Hinds, Elizabeth White, Yeshim Deniz, Douglas Lyon, Stackify Blog

Related Topics: Java IoT, Microservices Expo, PowerBuilder, Microsoft Cloud, Agile Computing, Artificial Intelligence

Java IoT: Article

OData Support in SQLAnywhere 16.0

New features for web-based access to database resources

OData is quickly becoming the Lingua Franca for data exchange over the web.  The OData standard defines a protocol and a language structure for issuing queries and updates to remote data sources, including (but not limited to) relational databases, file systems, content management systems, and traditional web sites.  It builds upon existing Web technologies, like HTTP and RESTful web services, the Atom Publishing Protocol (AtomPub), XML, and Javascript Object Notation (JSON).

SAP and Sybase iAnywhere released SQL Anywhere version 16 in March 2013, and it had many cool new features. This blog post will cover one specific enhancement, the new support for OData access to SA databases.

Note:  SA 16.0 is the follow-on release to version 12.0.1. There was no version 13, 14, or 15.

Background
SQL Anywhere actually introduced support for SOAP and REST-based web services back in their version 9.0 release!  To enable web access, the server needed to be started with a new commandline switch that started an internal HTTP listener.  This allowed the database server itself to function as a web server, and it could handle incoming HTTP/s requests.  Inside the database, the developer would create separate SERVICE objects that could take a regular SQL query against a table, view, or stored procedure, and transform the result set into a number of formats, including XML, HTML, and JSON.  Figure 1 below shows that basic architecture.  ODBC/JDBC client/server connections would come into the server on a TCP/IP port, and HTTP/S connections would arrive through a separate port and be processed by the HTTP listener.

SA12 arch.png

While this was a nice feature, it had the following negative aspects:

  1. Even though the HTTP web server component was listening on a separate port from the ODBC/JDBC connections, it still meant opening a port through the firewall and exposing the actual database server process to the open internet.  Network administrators typically have a problem with opening non-standard ports through their firewall, especially to critical resources like database servers...
  2. The SERVICE objects were separate database objects from the underlying tables, views, and procedures that they were exposing.  These would be written in a specific SQL Anywhere syntax, and would have to be maintained separately.  Changes to the schema were not automatically reflected in the service objects, including artifacts like the WSDL for any SOAP services.
  3. The URI for accessing these services would need to include the physical database name.  For example:

http://<servername>:<port>/<database name>/<service name>

This is a key piece of information that could potentially be used for malicious attacks against the database server.

SA 16.0 Architecture
SA 16 introduces a new server process for providing OData support.  Its name is DBOSRV16.EXE, and it consists of two distinct components:

  1. The DBOSRV16.EXE HTTP server, which is the Jetty open source Java servlet container.  This process runs outside the SA16 database server, and listens for incoming HTTP or HTTPS connections from web clients.
  2. The OData Producer Java servlet.  This opens a JDBC connection to the SQL Anywhere database, and is responsible for processing the OData queries and updates and responding with either AtomPub (XML) or JSON formatted result sets.  The OData producer servlet code is provided, and can be compiled and executed inside any web server capable of running Java servlets.

The best feature of this new setup is that database objects (tables and views) are automatically exposed to the OData producer.  There is no longer any need to create and maintain separate SERVICE objects.  In addition, the HTTP requests are not hitting the database server directly, increasing the security protection of that critical resource.

It's important to know that this does not replace the existing web services infrastructure - that all still exists in SA 16.  These features are new additions to the architecture.  Figure 2 below shows the revised architecture, with the DBOSRV16.EXE process managing incoming web requests.

SA16 arch.png

Getting Started
The first step is obviously to install and license SA 16.  (SAP has continued the practice of offering free developer licenses for SQL Anywhere.)

There is already an important service pack release posted on the Sybase Downloads site.  Download and patch to a minimum of build 1535.  Full documentation of SQL Anywhere 16 (and all prior releases...) can be found online at the CommentExchange site.

The SA 16 Samples folder gets installed into the \Users\Public\Documents\SQL Anywhere 16 folder.  From there, the OData samples can be found in the\SQLAnywhere\ODataSalesOrders and \SQLAnywhere\ODataSecurity folders.

Open the start_server.bat file in the \ODataSalesOrders folder.  The key line in this file is the one that launches DBOSRV16.EXE:

start "dbosrv16" "%__SABIN%\dbosrv16" SalesOrdersConfig.properties

That loads the new DBOSRV16.EXE process, using configuration options stored in the file "SalesOrdersConfig.properties".  For the purposes of this exercise, the pertinent options in that file are the HTTP listener port, and the authentication style.  This example uses port 8090, and a generic userid/password to connect to the SA16 Sample database.  There are several other configurable options, including SSL certificates, logging file location and verbosity, and database authentication options.

Run the start_server.bat file to start the DBOSRV16 OData server.

Running OData Queries
My browser of choice is Google Chrome, but Firefox works as well for testing the OData connection.  Enter the following URL, which is called the "service root":

http://localhost:8090/odata

The result is known as the Service Document, and it describes the set of entity collections that can be queried from a service.  Take note that this is every table in the SA16 sample database that has a primary key.  We'll cover how to include views and tables that do not have a primary key in the next section.

Append the /$metadata directive to get the Metadata Document, which defines all data exposed by the service as an XML schema.

http://localhost:8090/odata/$metadata

To query any individual entity, append that entity name to the service root.  Here's how to query the Products table, and return the XML structure:

http://localhost:8090/odata/Products

If you'd rather see that response in JSON format, add the $format directive (note the "?" following the Products entity name, which serves as the separator between the entity URI and the query options):

http://localhost:8090/odata/Products?$format=json

OData contains an entire set of query options that function much like SQL clauses.

    • $format - select either json, xml, or atom as the structure of the returned data
    • $select - to select specific attributes (i.e., columns) from the entity (i.e., table).
    • $orderby - to sort on a specific attribute
    • $filter - functions the same as the WHERE clause in SQL
    • $top - restricts the result set to the first N rows retrieved
    • $skip - if the skip value is set to N, then the first row retrieved will be N+1
    • $expand - this can include nested subquery results to linked entities, when a specific foreign key is present

OData Producer Service Language (.OSDL) files
By default, the OData Producer servlet will expose every table and view that the connected user has SELECT authority for.  In addition, the table must have a defined primary key.  Since views do not have a primary key, they are not automatically included in the OData service document.  To expose a view or a table without a primary key, an .OSDL file must be created and specified in the server startup .properties file.

The \samples\SQLAnywhere\ODataSecurity folder contains an example of an .OSDL file.  Basically, it's a listing of the tables and view names, along with the column names that serve as the primary key of the entity.  If you use an .OSDL file, then you must specify every table or view that is to be exposed in the service document.  To illustrate, the sample secureView.osdl file only contains a single entry for the view EmployeeConfidential, so that is the only entity that is exposed by the OData producer.

Conclusion
The new OData Server process in SQL Anywhere 16 has a great many potential benefits.

  1. It can speed the development and prototyping phase, by allowing quick creation and modeling of OData services, without requiring heavy backend or EIS development.
  2. It can enhance the security of a production web services environment by eliminating the need for HTTP access directly to the database server.
  3. It can reduce the overall complexity of an n-tier application by eliminating the need to write middle-tier components that do nothing but transform data into JSON or XML.

More Stories By Paul Horan

Paul Horan is a Senior Solution Advisor and Mobility Architect at SAP, and works with the SAP Mobile Platform and SAP Mobile Secure product lines. Paul joined SAP as part of their acquisition of Sybase in June, 2010. Prior to that, Paul worked for Sybase as a technical pre-sales architect supporting PowerBuilder, PowerDesigner, and SQL Anywhere. Paul works out of SAP's Reston VA office. A 1984 graduate of Indiana University, Paul currently resides in Arlington VA.

@ThingsExpo Stories
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...