Package org.apache.ignite.plugin
Interface CachePluginProvider<C extends CachePluginConfiguration>
-
public interface CachePluginProvider<C extends CachePluginConfiguration>Cache plugin provider is a point for processing of properties which provide specificCachePluginConfiguration.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T> TcreateComponent(Class<T> cls)voidonIgniteStart()Callback that notifies that Ignite has successfully started, including all internal components.voidonIgniteStop(boolean cancel)Callback to notify that Ignite is about to stop.voidstart()Starts grid component.voidstop(boolean cancel)Stops grid component.<T,K,V>
TunwrapCacheEntry(javax.cache.Cache.Entry<K,V> entry, Class<T> cls)Unwrap entry to specified type.voidvalidate()Validates cache plugin configuration in process of cache creation.voidvalidateRemote(CacheConfiguration locCfg, CacheConfiguration rmtCfg, ClusterNode rmtNode)Checks that remote caches has configuration compatible with the local.
-
-
-
Method Detail
-
start
void start() throws IgniteCheckedExceptionStarts grid component.- Throws:
IgniteCheckedException- Throws in case of any errors.
-
stop
void stop(boolean cancel)
Stops grid component.- Parameters:
cancel- Iftrue, then all ongoing tasks or jobs for relevant components need to be cancelled.
-
onIgniteStart
void onIgniteStart() throws IgniteCheckedExceptionCallback that notifies that Ignite has successfully started, including all internal components.- Throws:
IgniteCheckedException- Thrown in case of any errors.
-
onIgniteStop
void onIgniteStop(boolean cancel)
Callback to notify that Ignite is about to stop.- Parameters:
cancel- Flag indicating whether jobs should be canceled.
-
createComponent
@Nullable <T> T createComponent(Class<T> cls)
- Type Parameters:
T- Type of the component to create.- Parameters:
cls- Ignite component class.- Returns:
- Ignite component or
nullif component is not supported.
-
unwrapCacheEntry
@Nullable <T,K,V> T unwrapCacheEntry(javax.cache.Cache.Entry<K,V> entry, Class<T> cls)Unwrap entry to specified type. For details seejavax.cache.Cache.Entry.unwrap(Class).- Type Parameters:
T- Type of the object cache entry be unwrapped to.V- Cache entry value type.K- Cache entry key type.- Parameters:
entry- Mutable entry to unwrap.cls- Type of the expected component.- Returns:
- New instance of underlying type or
nullif it's not available.
-
validate
void validate() throws IgniteCheckedExceptionValidates cache plugin configuration in process of cache creation. Throw exception if validation failed.- Throws:
IgniteCheckedException- If validation failed.
-
validateRemote
void validateRemote(CacheConfiguration locCfg, CacheConfiguration rmtCfg, ClusterNode rmtNode) throws IgniteCheckedException
Checks that remote caches has configuration compatible with the local.- Parameters:
locCfg- Local configuration.rmtCfg- Remote configuration.rmtNode- Remote node.- Throws:
IgniteCheckedException
-
-