aboutsummaryrefslogtreecommitdiffstats
path: root/aai-traversal/src/main/java/org/onap/aai/rest/util/AaiGraphChecker.java
blob: 11b412df517dc7dac177eaa9f339bc5d849cd782 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*
 * ============LICENSE_START=======================================================
 * Copyright (C) 2022 Bell Canada
 * Modification Copyright (C) 2022 Deutsche Telekom SA
 * ================================================================================
 * Licensed 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.
 * ============LICENSE_END=========================================================
 */
package org.onap.aai.rest.util;

import java.util.Iterator;

import org.janusgraph.core.JanusGraphException;
import org.janusgraph.core.JanusGraphTransaction;
import org.onap.aai.dbmap.AAIGraph;
import org.onap.aai.logging.ErrorLogHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import com.google.common.collect.Iterators;

/**
 * Singleton class responsible to check that AAI service is able to connect to its back-end
 * database.
 */
@Component
@Scope(ConfigurableBeanFactory.SCOPE_SINGLETON)
public class AaiGraphChecker {
    private static final Logger LOGGER = LoggerFactory.getLogger(AaiGraphChecker.class);

    private AaiGraphChecker() {
    }

    /**
     * Checks whether a connection to the graph database can be made.
     * 
     * @return
     *         <li>true, if database is available</li>
     *         <li>false, if database is NOT available</li>
     */
    public Boolean isAaiGraphDbAvailable() {
        Boolean dbAvailable;
        JanusGraphTransaction transaction = null;
        try {
            transaction = AAIGraph.getInstance().getGraph().newTransaction();
            final Iterator<?> vertexIterator = transaction.query().limit(1).vertices().iterator();
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("Number of vertices retrieved while checking db: {}",
                    Iterators.size(vertexIterator));
            }
            vertexIterator.hasNext();
            LOGGER.debug("Database is available");
            dbAvailable = Boolean.TRUE;
        } catch (JanusGraphException e) {
            String message = "Database is not available (after JanusGraph exception)";
            ErrorLogHelper.logError("500", message + ": " + e.getMessage());
            LOGGER.error(message, e);
            dbAvailable = Boolean.FALSE;
        } catch (Error e) {
            // Following error occurs when aai resources is starting:
            // - UnsatisfiedLinkError (for org.onap.aai.dbmap.AAIGraph$Helper instantiation)
            // Following errors are raised when aai resources is starting and cassandra is not
            // running:
            // - ExceptionInInitializerError
            // - NoClassDefFoundError (definition for org.onap.aai.dbmap.AAIGraph$Helper is not
            // found)
            String message = "Database is not available (after error)";
            ErrorLogHelper.logError("500", message + ": " + e.getMessage());
            LOGGER.error(message, e);
            dbAvailable = Boolean.FALSE;
        } catch (Exception e) {
            String message = "Database availability can not be determined";
            ErrorLogHelper.logError("500", message + ": " + e.getMessage());
            LOGGER.error(message, e);
            dbAvailable = null;
        } finally {
            if (transaction != null && !transaction.isClosed()) {
                // check if transaction is open then closed instead of flag
                try {
                    transaction.rollback();
                } catch (Exception e) {
                    String message = "Exception occurred while closing transaction";
                    LOGGER.error(message, e);
                    ErrorLogHelper.logError("500", message + ": " + e.getMessage());
                }
            }
        }
        return dbAvailable;
    }
}