1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.catalog.api.dao;
18
19 import java.util.Map;
20
21 import org.apache.logging.log4j.catalog.api.Attribute;
22 import org.apache.logging.log4j.catalog.api.CatalogReader;
23 import org.apache.logging.log4j.catalog.api.CatalogWriter;
24 import org.apache.logging.log4j.catalog.api.Category;
25 import org.apache.logging.log4j.catalog.api.Event;
26 import org.apache.logging.log4j.catalog.api.Product;
27
28 /**
29 * Provides access to the Catalog.
30 */
31 public interface CatalogDao extends CatalogReader, CatalogWriter {
32
33 /**
34 * Return all the Attributes as a Map.
35 * @return A map of the attributes where the key is the Attribute's name.
36 */
37 Map<String, Attribute> getAttributes();
38
39 /**
40 * Retrieves an Attribute.
41 * @param name The attribute name.
42 * @return The Attribute or null if no attribute with the specified name exists.
43 */
44 Attribute getAttribute(String name);
45
46 /**
47 * Retrieves a Category. Modifications made to the Category may not be reflected if updateCategory() is
48 * not called.
49 * @param name The category name.
50 * @return The Category.
51 */
52 Category getCategory(String name);
53
54
55 Event getEvent(String name);
56
57
58 Product getProduct(String name);
59
60 }