blob: 909c9563ea7f20a2d8ca0c65c514763fdac00f7a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Lock</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Lock";
}
}
catch(err) {
}
//-->
</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/ejb/LocalHome.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/LockType.html" title="enum in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/Lock.html" target="_top">Frames</a></li>
<li><a href="Lock.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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">jakarta.ejb</div>
<h2 title="Annotation Type Lock" class="title">Annotation Type Lock</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Target(value={TYPE,METHOD})
@Retention(value=RUNTIME)
public @interface <span class="memberNameLabel">Lock</span></pre>
<div class="block">Declares a concurrency lock for a singleton session bean with container managed concurrency.
<p>
This annotation may be specified on the bean class, the business methods of the bean class or both. Specifying the
annotation on a business method overrides the value specified at class level, if any.
<p>
If this annotation is not used, a value of <code>Lock(WRITE)</code> is assumed.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 3.1</dd>
<dt><span class="simpleTagLabel">Examples (en):</span></dt>
<dd><a href="../../../../../tomee-9.0/examples/xa-datasource.html">xa-datasource</a>, <a href="../../../../../tomee-9.0/examples/tomee-jersey-eclipselink.html">tomee-jersey-eclipselink</a>, <a href="../../../../../tomee-9.0/examples/simple-singleton.html">simple-singleton</a>, <a href="../../../../../tomee-9.0/examples/schedule-methods.html">schedule-methods</a>, <a href="../../../../../tomee-9.0/examples/schedule-methods-meta.html">schedule-methods-meta</a>, <a href="../../../../../tomee-9.0/examples/schedule-expression.html">schedule-expression</a>, <a href="../../../../../tomee-9.0/examples/schedule-events.html">schedule-events</a>, <a href="../../../../../tomee-9.0/examples/rest-on-ejb.html">rest-on-ejb</a>, <a href="../../../../../tomee-9.0/examples/rest-example.html">rest-example</a>, <a href="../../../../../tomee-9.0/examples/rest-example-with-application.html">rest-example-with-application</a>, <a href="../../../../../tomee-9.0/examples/resources-jmx-example.html">resources-jmx-example</a>, <a href="../../../../../tomee-9.0/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/examples/connector-war.html">connector-war</a>, <a href="../../../../../tomee-9.0/examples/change-jaxws-url.html">change-jaxws-url</a>, <a href="../../../../../tomee-9.0/examples/async-servlet.html">async-servlet</a>, <a href="../../../../../tomee-9.0/examples/async-postconstruct.html">async-postconstruct</a>, <a href="../../../../../tomee-9.0/examples/async-methods.html">async-methods</a>, <a href="../../../../../tomee-9.0/examples/access-timeout.html">access-timeout</a>, <a href="../../../../../tomee-9.0/examples/access-timeout-meta.html">access-timeout-meta</a></dd>
<dt><span class="simpleTagLabel">Examples (es):</span></dt>
<dd><a href="../../../../../tomee-9.0/es/examples/simple-singleton.html">simple-singleton</a>, <a href="../../../../../tomee-9.0/es/examples/async-methods.html">async-methods</a>, <a href="../../../../../tomee-9.0/es/examples/access-timeout.html">access-timeout</a>, <a href="../../../../../tomee-9.0/es/examples/access-timeout-meta.html">access-timeout-meta</a></dd>
<dt><span class="simpleTagLabel">Examples (pt):</span></dt>
<dd><a href="../../../../../tomee-9.0/pt/examples/xa-datasource.html">xa-datasource</a>, <a href="../../../../../tomee-9.0/pt/examples/change-jaxws-url.html">change-jaxws-url</a>, <a href="../../../../../tomee-9.0/pt/examples/async-servlet.html">async-servlet</a>, <a href="../../../../../tomee-9.0/pt/examples/async-postconstruct.html">async-postconstruct</a>, <a href="../../../../../tomee-9.0/pt/examples/async-methods.html">async-methods</a>, <a href="../../../../../tomee-9.0/pt/examples/access-timeout.html">access-timeout</a>, <a href="../../../../../tomee-9.0/pt/examples/access-timeout-meta.html">access-timeout-meta</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/LockType.html" title="enum in jakarta.ejb">LockType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/Lock.html#value--">value</a></span></code>
<div class="block">value.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="value--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>public abstract&nbsp;<a href="../../jakarta/ejb/LockType.html" title="enum in jakarta.ejb">LockType</a>&nbsp;value</pre>
<div class="block"><p>value.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/LockType.html" title="enum in jakarta.ejb"><code>LockType</code></a> object.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>jakarta.ejb.LockType.WRITE</dd>
</dl>
</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/ejb/LocalHome.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/LockType.html" title="enum in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/Lock.html" target="_top">Frames</a></li>
<li><a href="Lock.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>