1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16 package org.forgerock.audit.handlers.jms;
17
18 import jakarta.jms.ConnectionFactory;
19 import jakarta.jms.Topic;
20 import org.forgerock.json.resource.InternalServerErrorException;
21
22 /**
23 * Interface for retrieving a {@link Topic JMS topic} and a {@link ConnectionFactory JMS connection factory}.
24 */
25 public interface JmsContextManager {
26
27 /**
28 * Gets a {@link Topic JMS topic}.
29 * @return a {@link Topic JMS topic}.
30 * @throws InternalServerErrorException if an error occurs getting the {@link Topic JMS topic}.
31 */
32 Topic getTopic() throws InternalServerErrorException;
33
34 /**
35 * Gets a {@link ConnectionFactory JMS connection factory}.
36 * @return a {@link ConnectionFactory JMS connection factory}.
37 * @throws InternalServerErrorException if an error occurs getting
38 * the {@link ConnectionFactory JMS connection factory}.
39 */
40 ConnectionFactory getConnectionFactory() throws InternalServerErrorException;
41 }