| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| <body> |
| <h2>Cache API.</h2> |
| <p> |
| The Cache API/SPI is an extension point for Entity Store caching. |
| </p> |
| <p> |
| The API part is only to allow caching options to be passed to the underlying extension in a uniform and |
| standard way. CacheOptions are to be passed as meta info on the optional Cache extension that is specified |
| during assembly phase. Example; |
| </p> |
| <pre><code> |
| public void assemble( ModuleAssembly module ) |
| { |
| CacheOptions options = new CacheOptions( true, true, false ); |
| module.addServices( EhCacheService.class ).setMetaInfo( options ); |
| } |
| </code></pre> |
| <p> |
| Not all EntityStore implementations use the Cache extension, so check the implementation details of the |
| EntityStore whether the cache extension can bring any benefits or not. |
| </p> |
| </body> |
| </html> |
