Space Details. Available Pages

Transcription

1 Key: Space Details extremescale Name: WebSphere extreme Scale and DataPower XC10 Appliance Wiki Description: Creator (Creation Date): dwblogadmin (Apr 09, 2009) Last Modifier (Mod. Date): carriemiller (Mar 01, 2011) Available Pages WebSphere extreme Scale REST Data Service REST Data Service FAQ Document generated by Confluence on Nov 28, :25 Page 1

2 WebSphere extreme Scale REST Data Service This page last changed on Jan 15, 2010 by chris.d.johnson. This wiki has migrated to the new IBM Caching Community. All new and existing content will be available there as this wiki will be sunset. Overview The WebSphere extreme Scale REST Data Service allows HTTP clients, including.net and AJAX clients, to use and exploit WebSphere extreme Scale..NET applications that use the Open Data Protocol (OData) to access services compatible with Microsoft's WCF Data Service (formerly ADO.NET Data Services) may now be easily modified to use WebSphere extreme Scale, and gain its performance, scalability and availability advantages. Existing Visual Studio tooling is used to modify the data service URL to point to this new service. With the release of WebSphere extreme Scale cumulative fix 2, the REST Data Service is available as a fully supported feature set included with the product. The WebSphere extreme Scale REST data service interface offers some powerful functionality: Microsoft WCF Data Services client library compatibility - Microsoft Visual Studio 2008 SP1 can be used to build applications using C#, Visual Basic and C++ programming languages on Windows and Silverlight platforms. Standard web technology support such as HTTP, Atom Publishing Protocol (AtomPub) and JSON - Allows a wide variety of client platforms to interact with the REST data service, such as PHP. Support for popular Java EE web servers such as: IBM WebSphere Application Server, Websphere Application Server Community Edition and Apache Tomcat Common data access operations - Create, Read, Update, Merge, Delete and Query operation support provide the basics for interacting with the extreme Scale grid. Batch support - Clients can update and retrieve data from the REST data service using a single remote procedure call to the REST data service, allowing multiple requests to participate in a single transaction. Partition support for entity relationships - The REST data service can realize the full scalability of the extreme Scale grid by partitioning the data and using key relationships between entities to identify partitionable schema root entities. The REST data service schema is modeled using EntityManager API entities - Entities are automatically mapped to a Entity Data Model (EDMX) allowing relationships and Java to EDM type mapping. See the product announcement page for an overview and more details on the REST data service. How To... Install Document generated by Confluence on Nov 28, :25 Page 2

3 1. Download the WebSphere extreme Scale version 7.0 trial. The REST data service is packaged within this trial. You may use the REST data service with the trial version, or a product version of WebSphere extreme Scale version 7.0 you have. 2. Alternatively, install or apply WebSphere extreme Scale version 7.0 cumulative fix 2 to an existing extreme Scale install 3. Extract the trial zip file to your hard drive, for example: c:\extremescale. 4. Read the REST data service user guide, which includes detailed installation instructions. 5. Visit the WebSphere extreme Scale Wiki for additional hints, tips and troubleshooting. 6. Use the WebSphere extreme Scale Forum for questions and feedback. Getting Started Installation is only the first step. The WebSphere extreme Scale REST data service ships with a getting started directory which contains a sample application that facilitates inserting data into the Northwind data model we use for the remaining samples and documentation. This client does not directly use the REST data service, but can be used to insert and retrieve data which can then be used by the remaining samples. Instructions are provided for running the sample in WebSphere Application Server and Tomcat. Source is included, as well as an eclipse project and instructions. See the User Guide in the restservice/docs directory, and READMEs in the gettingstarted directory. This sample client is written in Java. Frequently Asked Questions (FAQ) We have collected common questions and pitfalls on the WebSphere extreme Scale REST data service FAQ Samples.NET Simple Data client Similar to the Java getting started sample, a sample written in C# has been provided. This sample illustrates how to use the ADO.NET data services interface to its full potential. Included is the C# source and a binary executable. This sample is intended to be utilized within a Visual Studio 2008 SP1 development environment. Source - DataServices.cs Resources WebSphere extreme Scale Wiki for additional hints, tips and troubleshooting. WebSphere extreme Scale Forum for questions and feedback. WebSphere extreme Scale Information Center WCF Data Services (formerly ADO.NET Data Services) reference material in MSDN WebSphere Extreme Transaction Processing for Developers Space WebSphere Extreme Transaction Processing Blog Document generated by Confluence on Nov 28, :25 Page 3

4 YouTube video discussing the new REST data service IBM WebSphere extreme Scale YouTube channel WebSphere XTP on Twitter Articles on WebSphere extreme Scale Wiki Disclaimer and License Copyright IBM Corporation 2009,2010,2011,2012. All Rights Reserved. Document generated by Confluence on Nov 28, :25 Page 4

5 REST Data Service FAQ This page last changed on Jan 04, 2010 by chris.d.johnson. This wiki has migrated to the new IBM Caching Community. All new and existing content will be available there as this wiki will be sunset. Here you'll find the answers to the frequently asked WebSphere extreme Scale REST data service questions: General What is it? What is OData? What is WCF Data Services (formerly ADO.NET Data Services)? What is REST? Why are we doing it? Can I use it without the Microsoft.NET Framework? How do I get it? What versions of extreme Scale are supported? What features are available? What features aren't implemented yet? What web servers does it run with? Cool! How do I get started using it? What software requirements does it have? When will it be supported? Will it support extreme Scale version 6.1? How do I get support today? How do I learn more? Troubleshooting Q: How do I run the WebSphere extreme Scale REST data service with Tomcat version 6.0 and a Sun JDK? Q: When I use Sun JRE or JDK to start a Tomcat server with WebSphere extreme Scale REST data service installed, I am seeing the following error message: Q: When I start the Tomcat server with WebSphere extreme Scale REST service installed, I am seeing the following error message: General What is it? The WebSphere extreme Scale REST data service is a JavaTM HTTP service that implements the Microsoft OData protocol. The REST data service allows any HTTP client to access a WebSphere extreme Scale FIX2 or later grid. What is OData? The Open Data Protocol (OData) is an open protocol for sharing data. Microsoft provides clients and data services that communicate using this protocol, known as WCF Data Services (formerly ADO.NET Data Services). The OData protocol leverages common HTTP, AtomPub and JSON specifications and adds Document generated by Confluence on Nov 28, :25 Page 5

6 additional extensions to allow flexible and interoperable data access using REST semantics. What is WCF Data Services (formerly ADO.NET Data Services)? WCF Data Services is the Microsoft technology that implements the OData protocol. Version 1.0 was released as part of the.net Framework version 3.5 SP1 and Visual Studio 2008 SP1. The extreme Scale REST data service also implements the OData protocol and therefore WCF Data Services clients can interoperate with an extreme Scale grid. What is REST? REST stands for REpresentational State Transfer and "is a style of software architecture for distributed hypermedia systems such as the World Wide Web." REST is client - server interaction model where object identification and state maybe be exchanged between client and server. It is well-suited to using HTTP over the web. For example, the client may GET the state (attributes) of an object, change some of the attributes of the object, and PUT the changes back to the server. Why are we doing it? The extreme Scale REST data service allows.net clients and other non-java clients to use extreme Scale data grids, as shown here: The only change required to a.net client is to change its data service URL from its existing ADO.NET data service to the new extreme Scale REST data service. Existing Visual Studio 2008 SP1 tooling can be used to build ADO.NET Data Services clients that use the WebSphere extreme Scale REST data service. Document generated by Confluence on Nov 28, :25 Page 6

7 Non-Java clients using Ruby, Python, JavaScript and Perl may access WebSphere extreme Scale grids with this service. Can I use it without the Microsoft.NET Framework? Yes. Any client that can communicate using HTTP and can parse Atom Publishing Protocol (AtomPub) or JavaScript Object Notation (JSON) documents can communicate with both the Microsoft ADO.NET Rest Data Service and the WebSphere extreme Scale REST data service. How do I get it? The REST data service is available in two forms: Free Trial: It is included in the trial version of WebSphere extreme Scale v7.0. Download the trial version of WebSphere extreme Scale v7.0 here. Free Upgrade: The REST data service is included in WebSphere extreme Scale cumulative fix 2 (PM02591). What versions of extreme Scale are supported? Version FIX 2 and later. What features are available? Technology preview 3 includes most of the features that the Microsoft ADO.NET Data Service specification provides including: Automatic modeling of extreme Scale EntityManager API entities as WCF Data Services entities which includes (see section for additional detail): Java data type to Entity Data Model type conversion. Entity association support. Schema root and key association support which is required for partitioned grids. Atom Publish Protocol (AtomPub or APP) XML and JavaScript Object Notation (JSON) data payload format. Create, Read, Update and Delete (CRUD) operations using the respective HTTP request methods: POST, GET, PUT and DELETE. In addition, the Microsoft extension: MERGE is supported. Simple queries are supported using filters. Batch retrieval and change set requests are supported. Partitioned grid support for high availability. Interoperability with extreme Scale EntityManager API clients. Support for standard JEE web servers. What features aren't implemented yet? There are several optional features of the ADO.NET Data Service version 1.0 specification that are not yet available: Security is not supported. User authorization and authentication is not supported between the REST Document generated by Confluence on Nov 28, :25 Page 7

8 data service and the extreme Scale grid. Java SE security is also not supported. Mixed character sets are not supported in batches. Each batch part must contain the same character set as the request. ETags are not supported. Concurrent update collisions are only detected if using entity versioning and the version field is supplied in the data payload. Tunneled requests are not supported. Complex types are not supported Inheritance is not supported GUID types GeneratedId types String and Date filter expressions are not allowed. Method call support What web servers does it run with? The extreme Scale REST data service has been tested with the following Java web containers: WebSphere Application Server version and later WebSphere Application Server Community Edition version and later Apache Tomcat version 5.5 and later Cool! How do I get started using it? A sample application is provided to demonstrate the operation of the REST data service. Instructions are provided for running it in WebSphere Application Server, WebSphere Application Server Community Edition and Apache Tomcat. Source is included, as well as an Eclipse and Visual Studio 2008 project and instructions. See the User Guide in the docs directory, and READMEs in the gettingstarted directory. See Rob's YouTube video here. Get more information, including more samples, in the wiki here. What software requirements does it have? WebSphere extreme Scale v cumulative fix 2 Java 5 or greater A web server: WebSphere Application Server - The free WebSphere Application Server Version 7.0 for Developers is a good choice to get started. WebSphere Application Server Community Edition Version or later. Apache Tomcat Version 5.5 or later. When will it be supported? The REST data service is supported now! It was released in December, 2009 as part of a free cumulative fix pack for extreme Scale version Will it support extreme Scale version 6.1? The REST data service only supports version 7.0. Version 7.0 is a free upgrade for version 6.1 customers. Document generated by Confluence on Nov 28, :25 Page 8

9 How do I get support today? For community support and questions, see the WebSphere extreme Scale wiki and WebSphere extreme Scale forum. Existing extreme Scale customers can open a service request ticket for the WebSphere extreme Scale product. For more information, click the support link on the extreme Scale product web site. How do I learn more? Find information and samples on the Wiki. Be sure to see the Troubleshooting section on this page. See the documentation in PDF format. Troubleshooting Q: How do I run the WebSphere extreme Scale REST data service with Tomcat version 6.0 and a Sun JDK? A: The instructions describe how to run with Tomcat 5.5. The instructions for Tomcat 6.0 are the same. However, the endorsed directory that the IBM ORB is copied to must be manually created: For Tomcat 6.0.x, create an endorsed directory in tomcat root directory, and copy all of the JAR files from: wxs_home/lib/endorsed to: tomcat_root/endorsed Q: When I use Sun JRE or JDK to start a Tomcat server with WebSphere extreme Scale REST data service installed, I am seeing the following error message: CWOBJ4007E: The WebSphere extreme Scale REST data service was unable to connect to the extreme Scale grid: org.omg.corba.initialize: can't instantiate default ORB implementation com.ibm.corba.iiop.orb vmcid: 0x0 minor code: 0 completed: No. The exception stack shows a chained java.lang.classnotfoundexception: com.ibm.corba.iiop.orb. A: If using a Sun JRE or JDK, you must install the IBM ORB into Tomcat. You must copy all the IBM ORB jar files from WebSphere extreme Scale endorsed lib directory into Tomcat endorsed lib directory. For Tomcat 5.5, copy all of the JAR files from: _ wxs_home{_}/lib/endorsed to: tomcat_root/common/endorsed For Tomcat 6.0.x, create an endorsed directory in tomcat root directory, and copy all of the JAR files from: wxs_home/lib/endorsed to: tomcat_root/endorsed Document generated by Confluence on Nov 28, :25 Page 9

10 Q: When I start the Tomcat server with WebSphere extreme Scale REST service installed, I am seeing the following error message: CWOBJ4007E: The WebSphere extreme Scale REST data service was unable to connect to the extreme Scale grid: org.omg.corba.transient: java.net.connectexception: Connection refused: connect: host=localhost,port=2909 vmcid: IBM minor code: E02 completed: No A: Make sure you have started the WebSphere extreme Scale catalog service and container servers. Use the script runcat.bat/runcat.sh in wxsrest_home/gettingstarted directory to start a catalog service, and use the script runcontainer.bat/runcontainer.sh in wxsrest_home/gettingstarted directory to start container servers. If you have already started a catalog service, make sure you use the right runcat.bat/runcat.sh script in the wxsrest_home/gettingstarted directory so the catalog server is running with bootstrap port There is another gettingstarted directory in WXS_HOME directory. If you run runcat.bat/runcat.sh from WXS_HOME/gettingstarted directory, it will start the catalog server with bootstrap port set to 2809 by default. Wiki Disclaimer and License Copyright IBM Corporation 2009,2010,2011,2012. All Rights Reserved. Document generated by Confluence on Nov 28, :25 Page 10