EclipseLink JPA-RS 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.rs
Class ServiceBase

java.lang.Object
  extended by org.eclipse.persistence.jpa.rs.ServiceBase
Direct Known Subclasses:
Service

public class ServiceBase
extends java.lang.Object

Provides all the base JPA-RS Rest functionality.

Author:
tware

Field Summary
protected  PersistenceFactoryBase factory
           
static java.lang.String RELATIONSHIP_PARTNER
           
 
Constructor Summary
ServiceBase()
           
 
Method Summary
protected  void addMapping(Descriptor descriptor, org.eclipse.persistence.mappings.DatabaseMapping mapping)
           
protected  void addQueries(java.util.List<Query> queryList, PersistenceContext app, java.lang.String javaClassName)
           
protected  Descriptor buildDescriptor(PersistenceContext app, java.lang.String persistenceUnit, org.eclipse.persistence.descriptors.ClassDescriptor descriptor, java.lang.String baseUri)
           
 javax.ws.rs.core.Response callSessionBean(javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, javax.ws.rs.core.UriInfo uriInfo, java.io.InputStream is)
           
 javax.ws.rs.core.Response callSessionBean(javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI, java.io.InputStream is)
           
 javax.ws.rs.core.Response create(java.lang.String persistenceUnit, java.lang.String type, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo, java.io.InputStream in)
           
 javax.ws.rs.core.Response create(java.lang.String persistenceUnit, java.lang.String type, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo, java.net.URI baseURI, java.io.InputStream in)
           
 javax.ws.rs.core.Response delete(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response delete(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response find(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response find(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response findAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response findAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getContexts(javax.ws.rs.core.HttpHeaders hh, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getContexts(javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo)
           
 javax.ws.rs.core.Response getDescriptorMetadata(java.lang.String persistenceUnit, java.lang.String descriptorAlias, javax.ws.rs.core.HttpHeaders hh, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getDescriptorMetadata(java.lang.String persistenceUnit, java.lang.String descriptorAlias, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo)
           
protected static java.util.Map<java.lang.String,java.lang.Object> getHintMap(javax.ws.rs.core.UriInfo info)
           
protected static java.util.Map<java.lang.String,java.lang.String> getParameterMap(javax.ws.rs.core.UriInfo info, java.lang.String segment)
          This method has been temporarily added to allow processing of either query or matrix parameters When the final protocol is worked out, it should be removed or altered.
 PersistenceFactoryBase getPersistenceFactory()
           
 javax.ws.rs.core.Response getQueriesMetadata(java.lang.String persistenceUnit, javax.ws.rs.core.HttpHeaders hh, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getQueriesMetadata(java.lang.String persistenceUnit, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo)
           
protected  Query getQuery(org.eclipse.persistence.queries.DatabaseQuery query, PersistenceContext app)
           
 javax.ws.rs.core.Response getQueryMetadata(java.lang.String persistenceUnit, java.lang.String queryName, javax.ws.rs.core.HttpHeaders hh, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getQueryMetadata(java.lang.String persistenceUnit, java.lang.String queryName, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo)
           
protected  java.lang.String getSingleHeader(java.lang.String parameterName, javax.ws.rs.core.HttpHeaders hh)
           
 javax.ws.rs.core.Response getTypes(java.lang.String persistenceUnit, javax.ws.rs.core.HttpHeaders hh, java.net.URI baseURI)
           
 javax.ws.rs.core.Response getTypes(java.lang.String persistenceUnit, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo)
           
protected  java.lang.String marshallMetadata(java.lang.Object metadata, java.lang.String mediaType)
           
 javax.ws.rs.core.Response namedQuery(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response namedQuery(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response namedQuerySingleResult(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response namedQuerySingleResult(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response namedQueryUpdate(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui)
           
 javax.ws.rs.core.Response namedQueryUpdate(java.lang.String persistenceUnit, java.lang.String name, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI)
           
 javax.ws.rs.core.Response removeAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.io.InputStream in)
           
 javax.ws.rs.core.Response removeAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI, java.io.InputStream in)
           
 javax.ws.rs.core.Response setOrAddAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.io.InputStream in)
           
 javax.ws.rs.core.Response setOrAddAttribute(java.lang.String persistenceUnit, java.lang.String type, java.lang.String key, java.lang.String attribute, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo ui, java.net.URI baseURI, java.io.InputStream in)
           
protected  SessionBeanCall unmarshallSessionBeanCall(java.io.InputStream data)
           
 javax.ws.rs.core.Response update(java.lang.String persistenceUnit, java.lang.String type, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo, java.io.InputStream in)
           
 javax.ws.rs.core.Response update(java.lang.String persistenceUnit, java.lang.String type, javax.ws.rs.core.HttpHeaders hh, javax.ws.rs.core.UriInfo uriInfo, java.net.URI baseURI, java.io.InputStream in)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RELATIONSHIP_PARTNER

public static final java.lang.String RELATIONSHIP_PARTNER
See Also:
Constant Field Values

factory

protected PersistenceFactoryBase factory
Constructor Detail

ServiceBase

public ServiceBase()
Method Detail

getPersistenceFactory

public PersistenceFactoryBase getPersistenceFactory()

getContexts

public javax.ws.rs.core.Response getContexts(@Context
                                             javax.ws.rs.core.HttpHeaders hh,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)
                                      throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

getContexts

public javax.ws.rs.core.Response getContexts(javax.ws.rs.core.HttpHeaders hh,
                                             java.net.URI baseURI)
                                      throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

callSessionBean

public javax.ws.rs.core.Response callSessionBean(@Context
                                                 javax.ws.rs.core.HttpHeaders hh,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo ui,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 java.io.InputStream is)
                                          throws javax.xml.bind.JAXBException,
                                                 java.lang.ClassNotFoundException,
                                                 javax.naming.NamingException,
                                                 java.lang.NoSuchMethodException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.IllegalAccessException
Throws:
javax.xml.bind.JAXBException
java.lang.ClassNotFoundException
javax.naming.NamingException
java.lang.NoSuchMethodException
java.lang.reflect.InvocationTargetException
java.lang.IllegalAccessException

callSessionBean

public javax.ws.rs.core.Response callSessionBean(javax.ws.rs.core.HttpHeaders hh,
                                                 javax.ws.rs.core.UriInfo ui,
                                                 java.net.URI baseURI,
                                                 java.io.InputStream is)
                                          throws javax.xml.bind.JAXBException,
                                                 java.lang.ClassNotFoundException,
                                                 javax.naming.NamingException,
                                                 java.lang.NoSuchMethodException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.IllegalAccessException
Throws:
javax.xml.bind.JAXBException
java.lang.ClassNotFoundException
javax.naming.NamingException
java.lang.NoSuchMethodException
java.lang.reflect.InvocationTargetException
java.lang.IllegalAccessException

getTypes

public javax.ws.rs.core.Response getTypes(java.lang.String persistenceUnit,
                                          @Context
                                          javax.ws.rs.core.HttpHeaders hh,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)

getTypes

public javax.ws.rs.core.Response getTypes(java.lang.String persistenceUnit,
                                          javax.ws.rs.core.HttpHeaders hh,
                                          java.net.URI baseURI)

getDescriptorMetadata

public javax.ws.rs.core.Response getDescriptorMetadata(java.lang.String persistenceUnit,
                                                       java.lang.String descriptorAlias,
                                                       @Context
                                                       javax.ws.rs.core.HttpHeaders hh,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo)

getDescriptorMetadata

public javax.ws.rs.core.Response getDescriptorMetadata(java.lang.String persistenceUnit,
                                                       java.lang.String descriptorAlias,
                                                       javax.ws.rs.core.HttpHeaders hh,
                                                       java.net.URI baseURI)

getQueriesMetadata

public javax.ws.rs.core.Response getQueriesMetadata(java.lang.String persistenceUnit,
                                                    @Context
                                                    javax.ws.rs.core.HttpHeaders hh,
                                                    @Context
                                                    javax.ws.rs.core.UriInfo uriInfo)

getQueriesMetadata

public javax.ws.rs.core.Response getQueriesMetadata(java.lang.String persistenceUnit,
                                                    javax.ws.rs.core.HttpHeaders hh,
                                                    java.net.URI baseURI)

getQueryMetadata

public javax.ws.rs.core.Response getQueryMetadata(java.lang.String persistenceUnit,
                                                  java.lang.String queryName,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders hh,
                                                  @Context
                                                  javax.ws.rs.core.UriInfo uriInfo)

getQueryMetadata

public javax.ws.rs.core.Response getQueryMetadata(java.lang.String persistenceUnit,
                                                  java.lang.String queryName,
                                                  javax.ws.rs.core.HttpHeaders hh,
                                                  java.net.URI baseURI)

find

public javax.ws.rs.core.Response find(java.lang.String persistenceUnit,
                                      java.lang.String type,
                                      java.lang.String key,
                                      @Context
                                      javax.ws.rs.core.HttpHeaders hh,
                                      @Context
                                      javax.ws.rs.core.UriInfo ui)

find

public javax.ws.rs.core.Response find(java.lang.String persistenceUnit,
                                      java.lang.String type,
                                      java.lang.String key,
                                      javax.ws.rs.core.HttpHeaders hh,
                                      javax.ws.rs.core.UriInfo ui,
                                      java.net.URI baseURI)

findAttribute

public javax.ws.rs.core.Response findAttribute(java.lang.String persistenceUnit,
                                               java.lang.String type,
                                               java.lang.String key,
                                               java.lang.String attribute,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders hh,
                                               @Context
                                               javax.ws.rs.core.UriInfo ui)

findAttribute

public javax.ws.rs.core.Response findAttribute(java.lang.String persistenceUnit,
                                               java.lang.String type,
                                               java.lang.String key,
                                               java.lang.String attribute,
                                               javax.ws.rs.core.HttpHeaders hh,
                                               javax.ws.rs.core.UriInfo ui,
                                               java.net.URI baseURI)

setOrAddAttribute

public javax.ws.rs.core.Response setOrAddAttribute(java.lang.String persistenceUnit,
                                                   java.lang.String type,
                                                   java.lang.String key,
                                                   java.lang.String attribute,
                                                   @Context
                                                   javax.ws.rs.core.HttpHeaders hh,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo ui,
                                                   java.io.InputStream in)

setOrAddAttribute

public javax.ws.rs.core.Response setOrAddAttribute(java.lang.String persistenceUnit,
                                                   java.lang.String type,
                                                   java.lang.String key,
                                                   java.lang.String attribute,
                                                   javax.ws.rs.core.HttpHeaders hh,
                                                   javax.ws.rs.core.UriInfo ui,
                                                   java.net.URI baseURI,
                                                   java.io.InputStream in)

removeAttribute

public javax.ws.rs.core.Response removeAttribute(java.lang.String persistenceUnit,
                                                 java.lang.String type,
                                                 java.lang.String key,
                                                 java.lang.String attribute,
                                                 @Context
                                                 javax.ws.rs.core.HttpHeaders hh,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo ui,
                                                 java.io.InputStream in)

removeAttribute

public javax.ws.rs.core.Response removeAttribute(java.lang.String persistenceUnit,
                                                 java.lang.String type,
                                                 java.lang.String key,
                                                 java.lang.String attribute,
                                                 javax.ws.rs.core.HttpHeaders hh,
                                                 javax.ws.rs.core.UriInfo ui,
                                                 java.net.URI baseURI,
                                                 java.io.InputStream in)

create

public javax.ws.rs.core.Response create(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders hh,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        java.io.InputStream in)
                                 throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

create

public javax.ws.rs.core.Response create(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        javax.ws.rs.core.HttpHeaders hh,
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        java.net.URI baseURI,
                                        java.io.InputStream in)
                                 throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

update

public javax.ws.rs.core.Response update(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders hh,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        java.io.InputStream in)

update

public javax.ws.rs.core.Response update(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders hh,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        java.net.URI baseURI,
                                        java.io.InputStream in)

delete

public javax.ws.rs.core.Response delete(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        java.lang.String key,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders hh,
                                        @Context
                                        javax.ws.rs.core.UriInfo ui)

delete

public javax.ws.rs.core.Response delete(java.lang.String persistenceUnit,
                                        java.lang.String type,
                                        java.lang.String key,
                                        javax.ws.rs.core.HttpHeaders hh,
                                        javax.ws.rs.core.UriInfo ui,
                                        java.net.URI baseURI)

namedQuery

public javax.ws.rs.core.Response namedQuery(java.lang.String persistenceUnit,
                                            java.lang.String name,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders hh,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui)

namedQuery

public javax.ws.rs.core.Response namedQuery(java.lang.String persistenceUnit,
                                            java.lang.String name,
                                            javax.ws.rs.core.HttpHeaders hh,
                                            javax.ws.rs.core.UriInfo ui,
                                            java.net.URI baseURI)

namedQueryUpdate

public javax.ws.rs.core.Response namedQueryUpdate(java.lang.String persistenceUnit,
                                                  java.lang.String name,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders hh,
                                                  @Context
                                                  javax.ws.rs.core.UriInfo ui)

namedQueryUpdate

public javax.ws.rs.core.Response namedQueryUpdate(java.lang.String persistenceUnit,
                                                  java.lang.String name,
                                                  javax.ws.rs.core.HttpHeaders hh,
                                                  javax.ws.rs.core.UriInfo ui,
                                                  java.net.URI baseURI)

namedQuerySingleResult

public javax.ws.rs.core.Response namedQuerySingleResult(java.lang.String persistenceUnit,
                                                        java.lang.String name,
                                                        @Context
                                                        javax.ws.rs.core.HttpHeaders hh,
                                                        @Context
                                                        javax.ws.rs.core.UriInfo ui)

namedQuerySingleResult

public javax.ws.rs.core.Response namedQuerySingleResult(java.lang.String persistenceUnit,
                                                        java.lang.String name,
                                                        javax.ws.rs.core.HttpHeaders hh,
                                                        javax.ws.rs.core.UriInfo ui,
                                                        java.net.URI baseURI)

buildDescriptor

protected Descriptor buildDescriptor(PersistenceContext app,
                                     java.lang.String persistenceUnit,
                                     org.eclipse.persistence.descriptors.ClassDescriptor descriptor,
                                     java.lang.String baseUri)

addMapping

protected void addMapping(Descriptor descriptor,
                          org.eclipse.persistence.mappings.DatabaseMapping mapping)

addQueries

protected void addQueries(java.util.List<Query> queryList,
                          PersistenceContext app,
                          java.lang.String javaClassName)

getQuery

protected Query getQuery(org.eclipse.persistence.queries.DatabaseQuery query,
                         PersistenceContext app)

getHintMap

protected static java.util.Map<java.lang.String,java.lang.Object> getHintMap(javax.ws.rs.core.UriInfo info)

getParameterMap

protected static java.util.Map<java.lang.String,java.lang.String> getParameterMap(javax.ws.rs.core.UriInfo info,
                                                                                  java.lang.String segment)
This method has been temporarily added to allow processing of either query or matrix parameters When the final protocol is worked out, it should be removed or altered. Here we check for query parameters and if they don't exist, we get the matrix parameters.

Parameters:
info -
Returns:

getSingleHeader

protected java.lang.String getSingleHeader(java.lang.String parameterName,
                                           javax.ws.rs.core.HttpHeaders hh)

marshallMetadata

protected java.lang.String marshallMetadata(java.lang.Object metadata,
                                            java.lang.String mediaType)
                                     throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

unmarshallSessionBeanCall

protected SessionBeanCall unmarshallSessionBeanCall(java.io.InputStream data)
                                             throws javax.xml.bind.JAXBException
Throws:
javax.xml.bind.JAXBException

EclipseLink JPA-RS 2.4.1, build 'v20121003-ad44345' API Reference