org.apache.olingo.odata2.api.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odata-v2-lib Show documentation
Repackaged OData V2 Olingo Library
There is a newer version: 3.4.1
/*******************************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 ******************************************************************************/
/**
 * OData Library API
 * 
 * OData Library is a protocol implementation of the OData V2.0 standard. For details of this standard
 * see odata.org.
 * 

 * This API is intended to implement an OData service. An OData service consists of a metadata provider
 * implementation and an OData processor implementation.
 * 

 * An OData service can be exposed by a web application. For the runntime one JAX-RS
 * implementation is needed and the core implementation library of this API. Apache CXF for example is
 * one such JAX-RS implementation.
 * 

 * Entry point to the service is a JAX-RS servlet. At this servlet init parameters for a
 * ODataServiceFactory
 * is configured. The parameter javax.ws.rs.Application is a default by JAX-RS and has to be present
 * always.
 * 

 * 
 {@code
 * 
 * 
 *   Example OData Service
 *   
 *     MyODataServlet
 *     org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet
 *     
 *      javax.ws.rs.Application
 *      org.apache.olingo.odata2.core.rest.app.ODataApplication
 *     
 *     
 *       org.apache.olingo.odata2.service.factory
 *       com.sample.service.MyServiceFactory
 *     
 *     1
 *   
 *   
 *     MyODataServlet
 *     /MyService.svc/*
 *   
 * 
 * } 
 * 
 * This factory produces the service, a metadata provider and the data processor. The provider, typically
 * a derivative of the class EdmProvider provides the metadata of the service. The processor implements a
 * variety of service interfaces, and provides the data of the service. The processor is typically
 * a derivative of the class ODataSingleProcessor which can be used together with the class
 * ODataSingleService.
 */
package org.apache.olingo.odata2.api;