| <!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 --> |
| <title>Declarable (Apache Geode 1.15.0)</title> |
| <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="Declarable (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":50,"i1":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"],32:["t6","Deprecated 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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/DiskAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/Declarable.html" target="_top">Frames</a></li> |
| <li><a href="Declarable.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.apache.geode.cache</div> |
| <h2 title="Interface Declarable" class="title">Interface Declarable</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/geode/security/AccessControl.html" title="interface in org.apache.geode.security">AccessControl</a>, <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventListener.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventListener</a>, <a href="../../../../org/apache/geode/security/Authenticator.html" title="interface in org.apache.geode.security">Authenticator</a>, <a href="../../../../org/apache/geode/security/AuthInitialize.html" title="interface in org.apache.geode.security">AuthInitialize</a>, <a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a>, <a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><K,V>, <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><K,V>, <a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><K,V>, <a href="../../../../org/apache/geode/cache/query/CqListener.html" title="interface in org.apache.geode.cache.query">CqListener</a>, <a href="../../../../org/apache/geode/cache/query/CqStatusListener.html" title="interface in org.apache.geode.cache.query">CqStatusListener</a>, <a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><K,V>, <a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="interface in org.apache.geode.cache">FixedPartitionResolver</a><K,V>, <a href="../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>, <a href="../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a><K,V>, <a href="../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">GatewayTransportFilter</a>, <a href="../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a>, <a href="../../../../org/apache/geode/cache/lucene/LuceneSerializer.html" title="interface in org.apache.geode.cache.lucene">LuceneSerializer</a><T>, <a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a><K,V>, <a href="../../../../org/apache/geode/cache/RegionMembershipListener.html" title="interface in org.apache.geode.cache">RegionMembershipListener</a><K,V>, <a href="../../../../org/apache/geode/cache/RegionRoleListener.html" title="interface in org.apache.geode.cache">RegionRoleListener</a><K,V>, <a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a>, <a href="../../../../org/apache/geode/cache/TransactionListener.html" title="interface in org.apache.geode.cache">TransactionListener</a>, <a href="../../../../org/apache/geode/cache/TransactionWriter.html" title="interface in org.apache.geode.cache">TransactionWriter</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd>org.apache.geode.connectors.jdbc.internal.AbstractJdbcCallback, <a href="../../../../org/apache/geode/cache/util/AutoBalancer.html" title="class in org.apache.geode.cache.util">AutoBalancer</a>, <a href="../../../../org/apache/geode/cache/util/CacheListenerAdapter.html" title="class in org.apache.geode.cache.util">CacheListenerAdapter</a>, <a href="../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="class in org.apache.geode.cache.util">CacheWriterAdapter</a>, <a href="../../../../org/apache/geode/cache/util/CqListenerAdapter.html" title="class in org.apache.geode.cache.util">CqListenerAdapter</a>, <a href="../../../../org/apache/geode/modules/util/CreateRegionFunction.html" title="class in org.apache.geode.modules.util">CreateRegionFunction</a>, <a href="../../../../org/apache/geode/modules/util/DebugCacheListener.html" title="class in org.apache.geode.modules.util">DebugCacheListener</a>, <a href="../../../../org/apache/geode/cache/lucene/FlatFormatSerializer.html" title="class in org.apache.geode.cache.lucene">FlatFormatSerializer</a>, <a href="../../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaEventApplicationCacheListener.html" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaEventApplicationCacheListener</a>, <a href="../../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaForwarderCacheListener.html" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaForwarderCacheListener</a>, <a href="../../../../org/apache/geode/connectors/jdbc/JdbcAsyncWriter.html" title="class in org.apache.geode.connectors.jdbc">JdbcAsyncWriter</a>, <a href="../../../../org/apache/geode/connectors/jdbc/JdbcLoader.html" title="class in org.apache.geode.connectors.jdbc">JdbcLoader</a>, <a href="../../../../org/apache/geode/connectors/jdbc/JdbcWriter.html" title="class in org.apache.geode.connectors.jdbc">JdbcWriter</a>, <a href="../../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheLoader.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheLoader</a>, <a href="../../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheWriter.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheWriter</a>, <a href="../../../../org/apache/geode/pdx/ReflectionBasedAutoSerializer.html" title="class in org.apache.geode.pdx">ReflectionBasedAutoSerializer</a>, <a href="../../../../org/apache/geode/modules/util/RegionConfigurationCacheListener.html" title="class in org.apache.geode.modules.util">RegionConfigurationCacheListener</a>, <a href="../../../../org/apache/geode/cache/util/RegionMembershipListenerAdapter.html" title="class in org.apache.geode.cache.util">RegionMembershipListenerAdapter</a>, <a href="../../../../org/apache/geode/cache/util/RegionRoleListenerAdapter.html" title="class in org.apache.geode.cache.util">RegionRoleListenerAdapter</a>, <a href="../../../../org/apache/geode/modules/util/RegionSizeFunction.html" title="class in org.apache.geode.modules.util">RegionSizeFunction</a>, <a href="../../../../org/apache/geode/cache/server/ServerLoadProbeAdapter.html" title="class in org.apache.geode.cache.server">ServerLoadProbeAdapter</a>, <a href="../../../../org/apache/geode/modules/util/SessionCustomExpiry.html" title="class in org.apache.geode.modules.util">SessionCustomExpiry</a>, <a href="../../../../org/apache/geode/modules/session/catalina/callback/SessionExpirationCacheListener.html" title="class in org.apache.geode.modules.session.catalina.callback">SessionExpirationCacheListener</a>, <a href="../../../../org/apache/geode/cache/client/proxy/SniProxySocketFactory.html" title="class in org.apache.geode.cache.client.proxy">SniProxySocketFactory</a>, <a href="../../../../org/apache/geode/cache/util/StringPrefixPartitionResolver.html" title="class in org.apache.geode.cache.util">StringPrefixPartitionResolver</a>, <a href="../../../../org/apache/geode/modules/util/TouchPartitionedRegionEntriesFunction.html" title="class in org.apache.geode.modules.util">TouchPartitionedRegionEntriesFunction</a>, <a href="../../../../org/apache/geode/modules/util/TouchReplicatedRegionEntriesFunction.html" title="class in org.apache.geode.modules.util">TouchReplicatedRegionEntriesFunction</a>, <a href="../../../../org/apache/geode/cache/util/TransactionListenerAdapter.html" title="class in org.apache.geode.cache.util">TransactionListenerAdapter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Declarable</span></pre> |
| <div class="block">An object that can be described in a declarative caching XML file. |
| |
| <p> |
| |
| Any user-defined object in the declarative caching xml file should implement this interface in |
| order to be constructed. |
| |
| <p> |
| |
| For example, the user can declare a <code>CacheLoader</code> in a declarative XML file as |
| follows: |
| |
| <pre> |
| <cache-loader> |
| <class-name>com.company.app.DBLoader</class-name> |
| <parameter name="URL"> |
| <string>jdbc://12.34.56.78/mydb</string> |
| </parameter> |
| </cache-loader> |
| </pre> |
| |
| <p> |
| |
| In this case, <code>com.company.app.DBLoader</code> must implement both the <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache"><code>CacheLoader</code></a> |
| and <code>Declarable</code> interfaces. The cache service will construct a |
| <code>com.company.app.DBLoader</code> object by invoking the loader's zero-argument constructor |
| and then calling the <a href="../../../../org/apache/geode/cache/Declarable.html#init-java.util.Properties-"><code>init(java.util.Properties)</code></a> method to pass in the parameters. |
| |
| <P> |
| |
| See <a href="package-summary.html#declarative">package introduction</a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Declarable.html#init-java.util.Properties-">init</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of Geode 1.5 implement initialize instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Declarable.html#initialize-org.apache.geode.cache.Cache-java.util.Properties-">initialize</a></span>(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code> |
| <div class="block">Initializes a user-defined object, owned by the given cache, using the given properties.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="init-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| default void init(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of Geode 1.5 implement initialize instead.</span></div> |
| <div class="block">Initializes a user-defined object using the given properties. Note that any uncaught exception |
| thrown by this method will cause the <code>Cache</code> initialization to fail.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>props</code> - Contains the parameters declared in the declarative xml file.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If one of the configuration options in <code>props</code> is |
| illegal or malformed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-org.apache.geode.cache.Cache-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>default void initialize(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre> |
| <div class="block">Initializes a user-defined object, owned by the given cache, using the given properties. |
| Note that any uncaught exception |
| thrown by this method will cause the <code>Cache</code> initialization to fail. |
| Note that if this method is implemented then the deprecated init method should not be |
| implemented. |
| The product will call both methods assuming that only one will have a non-default |
| implementation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the cache that owns this declarable</dd> |
| <dd><code>properties</code> - Contains the parameters declared in the declarative xml file.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - should be thrown if properties contains something unexpected.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.5</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="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/DiskAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/Declarable.html" target="_top">Frames</a></li> |
| <li><a href="Declarable.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
