| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_222) on Tue Dec 08 12:28:32 UTC 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractResource (EclipseLink 3.0.0, API Reference)</title> |
| <meta name="date" content="2020-12-08"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractResource (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractSingleResultQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html" target="_top">Frames</a></li> |
| <li><a href="AbstractResource.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.jpa.rs.resources.common</div> |
| <h2 title="Class AbstractResource" class="title">Class AbstractResource</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.jpa.rs.resources.common.AbstractResource</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractEntityResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common">AbstractEntityResource</a>, <a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractPersistenceResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common">AbstractPersistenceResource</a>, <a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractPersistenceUnitResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common">AbstractPersistenceUnitResource</a>, <a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common">AbstractQueryResource</a>, <a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractSingleResultQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common">AbstractSingleResultQueryResource</a>, <a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/MetadataResource.html" title="class in org.eclipse.persistence.jpa.rs.resources">MetadataResource</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractResource</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Base class for all resources.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>gonural</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#APPLICATION_SCHEMA_JSON">APPLICATION_SCHEMA_JSON</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static jakarta.ws.rs.core.MediaType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#APPLICATION_SCHEMA_JSON_TYPE">APPLICATION_SCHEMA_JSON_TYPE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#factory">factory</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#SERVICE_VERSION_FORMAT">SERVICE_VERSION_FORMAT</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#AbstractResource--">AbstractResource</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#buildPersistenceContextFactory-java.lang.ClassLoader-">buildPersistenceContextFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Builds the persistence context factory.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getMatrixParameters-jakarta.ws.rs.core.UriInfo-java.lang.String-">getMatrixParameters</a></span>(jakarta.ws.rs.core.UriInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> segment)</code> |
| <div class="block">Get a map of the matrix parameters associated with the URI path segment of the current request |
| |
| In JPA-RS, things that user sets (such as parameters of named queries, etc.) are treated as matrix parameters |
| List of valid matrix parameters for JPA-RS is defined in MatrixParameters</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContext.html" title="class in org.eclipse.persistence.jpa.rs">PersistenceContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getPersistenceContext-java.lang.String-java.lang.String-java.net.URI-java.lang.String-java.util.Map-">getPersistenceContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistenceUnit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> baseURI, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> initializationProperties)</code> |
| <div class="block">Gets the persistence context.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getPersistenceFactory--">getPersistenceFactory</a></span>()</code> |
| <div class="block">Gets the persistence factory.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getPersistenceFactory-java.lang.ClassLoader-">getPersistenceFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Gets the persistence factory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getQueryParameters-jakarta.ws.rs.core.UriInfo-">getQueryParameters</a></span>(jakarta.ws.rs.core.UriInfo info)</code> |
| <div class="block">Get the URI query parameters of the current request |
| |
| In JPA-RS, predefined attributes (such as eclipselink query hints) are treated as query parameters |
| List of valid query parameters for JPA-RS is defined in QueryParameters</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#getRelationshipPartner-java.util.Map-java.util.Map-">getRelationshipPartner</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> matrixParams, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> queryParams)</code> |
| <div class="block">Gets the relationship partner.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#isValidVersion-java.lang.String-">isValidVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</code> |
| <div class="block">Checks if is valid version.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#marshallMetadata-java.lang.Object-java.lang.String-">marshallMetadata</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> metadata, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType)</code> |
| <div class="block">Marshall metadata.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#setPersistenceFactory-org.eclipse.persistence.jpa.rs.PersistenceContextFactory-">setPersistenceFactory</a></span>(<a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> factory)</code> |
| <div class="block">Sets the persistence factory.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html#setRequestUniqueId--">setRequestUniqueId</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SERVICE_VERSION_FORMAT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE_VERSION_FORMAT</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVICE_VERSION_FORMAT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.eclipse.persistence.jpa.rs.resources.common.AbstractResource.SERVICE_VERSION_FORMAT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="APPLICATION_SCHEMA_JSON"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>APPLICATION_SCHEMA_JSON</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APPLICATION_SCHEMA_JSON</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.eclipse.persistence.jpa.rs.resources.common.AbstractResource.APPLICATION_SCHEMA_JSON">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="APPLICATION_SCHEMA_JSON_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>APPLICATION_SCHEMA_JSON_TYPE</h4> |
| <pre>public static final jakarta.ws.rs.core.MediaType APPLICATION_SCHEMA_JSON_TYPE</pre> |
| </li> |
| </ul> |
| <a name="factory"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>factory</h4> |
| <pre>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> factory</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractResource--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractResource</h4> |
| <pre>public AbstractResource()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setPersistenceFactory-org.eclipse.persistence.jpa.rs.PersistenceContextFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPersistenceFactory</h4> |
| <pre>public void setPersistenceFactory(<a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> factory)</pre> |
| <div class="block">Sets the persistence factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>factory</code> - the new persistence factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceFactory</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> getPersistenceFactory()</pre> |
| <div class="block">Gets the persistence factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the persistence factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceFactory-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceFactory</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> getPersistenceFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre> |
| <div class="block">Gets the persistence factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the persistence factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildPersistenceContextFactory-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildPersistenceContextFactory</h4> |
| <pre>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContextFactory.html" title="interface in org.eclipse.persistence.jpa.rs">PersistenceContextFactory</a> buildPersistenceContextFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre> |
| <div class="block">Builds the persistence context factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - the loader</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the persistence context factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMatrixParameters-jakarta.ws.rs.core.UriInfo-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatrixParameters</h4> |
| <pre>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getMatrixParameters(jakarta.ws.rs.core.UriInfo info, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> segment)</pre> |
| <div class="block">Get a map of the matrix parameters associated with the URI path segment of the current request |
| |
| In JPA-RS, things that user sets (such as parameters of named queries, etc.) are treated as matrix parameters |
| List of valid matrix parameters for JPA-RS is defined in MatrixParameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - the info</dd> |
| <dd><code>segment</code> - the segment</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matrix parameters</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/eclipse/persistence/jpa/rs/MatrixParameters.html" title="class in org.eclipse.persistence.jpa.rs"><code>MatrixParameters</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryParameters-jakarta.ws.rs.core.UriInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryParameters</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getQueryParameters(jakarta.ws.rs.core.UriInfo info)</pre> |
| <div class="block">Get the URI query parameters of the current request |
| |
| In JPA-RS, predefined attributes (such as eclipselink query hints) are treated as query parameters |
| List of valid query parameters for JPA-RS is defined in QueryParameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - the info</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the query parameters</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/eclipse/persistence/jpa/rs/QueryParameters.html" title="class in org.eclipse.persistence.jpa.rs"><code>QueryParameters</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidVersion-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidVersion</h4> |
| <pre>protected static boolean isValidVersion(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version)</pre> |
| <div class="block">Checks if is valid version.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - the version</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if is valid version</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistenceContext-java.lang.String-java.lang.String-java.net.URI-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceContext</h4> |
| <pre>protected <a href="../../../../../../../org/eclipse/persistence/jpa/rs/PersistenceContext.html" title="class in org.eclipse.persistence.jpa.rs">PersistenceContext</a> getPersistenceContext(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> persistenceUnit, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> baseURI, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> initializationProperties)</pre> |
| <div class="block">Gets the persistence context.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceUnit</code> - the persistence unit</dd> |
| <dd><code>baseURI</code> - the base uri</dd> |
| <dd><code>version</code> - the version</dd> |
| <dd><code>initializationProperties</code> - the initialization properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the persistence context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRelationshipPartner-java.util.Map-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationshipPartner</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRelationshipPartner(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> matrixParams, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> queryParams)</pre> |
| <div class="block">Gets the relationship partner.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>matrixParams</code> - the matrix params</dd> |
| <dd><code>queryParams</code> - the query params</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the relationship partner</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="marshallMetadata-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshallMetadata</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> marshallMetadata(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> metadata, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> mediaType) |
| throws jakarta.xml.bind.JAXBException</pre> |
| <div class="block">Marshall metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the metadata</dd> |
| <dd><code>mediaType</code> - the media type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>jakarta.xml.bind.JAXBException</code> - the jAXB exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRequestUniqueId--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setRequestUniqueId</h4> |
| <pre>protected void setRequestUniqueId()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/persistence/jpa/rs/resources/common/AbstractSingleResultQueryResource.html" title="class in org.eclipse.persistence.jpa.rs.resources.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/persistence/jpa/rs/resources/common/AbstractResource.html" target="_top">Frames</a></li> |
| <li><a href="AbstractResource.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
