summaryrefslogtreecommitdiff
path: root/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/ConfigurationEntryStore.java
blob: d514bf25cef65cff12905ae062c00f55a6112b4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
 *
 * 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.
 *
 */
package org.apache.qpid.server.configuration;

import java.util.UUID;

public interface ConfigurationEntryStore
{

    /**
     * Returns stored root configuration entry
     *
     * @return root entry
     */
    ConfigurationEntry getRootEntry();

    /**
     * Returns the configuration entry with a given id.
     *
     * @return entry with a given id or null if entry does not exists
     */
    ConfigurationEntry getEntry(UUID id);

    /**
     * Saves given entries in the store.
     *
     * @param entries entries to store
     * @throws IllegalConfigurationException if save operation fails
     */
    void save(ConfigurationEntry... entries);

    /**
     * Removes the entries with given IDs and all their children
     *
     * @param entryIds IDs of entries to remove
     * @return IDs of removed entries
     * @throws IllegalConfigurationException if remove operation fails
     */
    UUID[] remove(UUID... entryIds);

    /**
     * Copies the store into the given location
     *
     * @param target location to copy store into
     * @throws IllegalConfigurationException if store cannot be copied into given location
     */
    public void copyTo(String copyLocation);

    /**
     * Return the store location for the opened store or null if store has not been opened.
     *
     * @return store location for the opened store or null if store has not been opened
     */
    public String getStoreLocation();
}