/hazelcast/src/main/java/com/hazelcast/core/MapLoaderLifecycleSupport.java

 1/*
 2 * Copyright (c) 2008-2013, Hazelcast, Inc. All Rights Reserved.
 3 *
 4 * Licensed under the Apache License, Version 2.0 (the "License");
 5 * you may not use this file except in compliance with the License.
 6 * You may obtain a copy of the License at
 7 *
 8 * http://www.apache.org/licenses/LICENSE-2.0
 9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.hazelcast.core;
18
19import java.util.Properties;
20
21/**
22 * Provides Lifecycle support for the implementing MapLoader class.
23 * MapLoader classes implementing MapLoaderLifecycleSupport
24 * interface will be called by Hazelcast on init and destroy so that
25 * implementation can do necessary configuration when initializing and
26 * cleanup when destroying.
27 */
28public interface MapLoaderLifecycleSupport {
29    /**
30     * Initializes this MapLoader implementation. Hazelcast will call
31     * this method when the map is first used on the
32     * HazelcastInstance. Implementation can
33     * initialize required resources for the implementing
34     * mapLoader such as reading a config file and/or creating
35     * database connection.
36     *
37     * @param hazelcastInstance HazelcastInstance of this mapLoader.
38     * @param properties        Properties set for this mapStore. see MapStoreConfig
39     * @param mapName           name of the map.
40     */
41    void init(HazelcastInstance hazelcastInstance, Properties properties, String mapName);
42
43    /**
44     * Hazelcast will call this method before shutting down.
45     * This method can be overridden to cleanup the resources
46     * held by this map loader implementation, such as closing the
47     * database connections etc.
48     */
49    void destroy();
50}