org.apache.olingo.odata2.core.rest

Class ODataRootLocator

java.lang.Object

org.apache.olingo.odata2.core.rest.ODataRootLocator

@Path(value="/")
public class ODataRootLocator
extends Object

Default OData root locator responsible to handle the whole path and delegate all calls to a sub locator:

/{odata path} e.g. http://host:port/webapp/odata.svc/$metadata
All path segments defined by a servlet mapping belong to the odata uri.

This behavior can be changed:

/{custom path}{odata path} e.g. http://host:port/webapp/bmw/odata.svc/$metadata
The first segment defined by a servlet mapping belong to customer context and the following segments are OData specific.

Constructor Summary

Constructors

Constructor and Description
ODataRootLocator()

Method Summary

Modifier and Type	Method and Description
static ODataServiceFactory	createServiceFactoryFromContext(javax.ws.rs.core.Application app, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.ServletConfig servletConfig)
int	getPathSplit()
ODataServiceFactory	getServiceFactory()
Object	handleRequest(List<javax.ws.rs.core.PathSegment> pathSegments, String xHttpMethod, String xHttpMethodOverride) Default root behavior which will delegate all paths to a ODataLocator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ODataRootLocator

public ODataRootLocator()

Method Detail

handleRequest

@Path(value="/{pathSegments: .*}")
public Object handleRequest(@Encoded @PathParam(value="pathSegments")
                                                               List<javax.ws.rs.core.PathSegment> pathSegments,
                                                               @HeaderParam(value="X-HTTP-Method")
                                                               String xHttpMethod,
                                                               @HeaderParam(value="X-HTTP-Method-Override")
                                                               String xHttpMethodOverride)
                                                        throws ODataException,
                                                               ClassNotFoundException,
                                                               InstantiationException,
                                                               IllegalAccessException

Default root behavior which will delegate all paths to a ODataLocator.

Parameters:

pathSegments - URI path segments - all segments have to be OData

xHttpMethod - HTTP Header X-HTTP-Method for tunneling through POST

xHttpMethodOverride - HTTP Header X-HTTP-Method-Override for tunneling through POST

Returns:

a locator handling OData protocol

Throws:

ODataException

ClassNotFoundException

IllegalAccessException

InstantiationException

getServiceFactory

public ODataServiceFactory getServiceFactory()

getPathSplit

public int getPathSplit()

createServiceFactoryFromContext

public static ODataServiceFactory createServiceFactoryFromContext(javax.ws.rs.core.Application app,
                                                                  javax.servlet.http.HttpServletRequest servletRequest,
                                                                  javax.servlet.ServletConfig servletConfig)