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 2013 Cybernetica AS
15 * Portions copyright 2014-2015 ForgeRock AS.
16 */
17 package org.forgerock.audit.handlers.syslog;
18
19 import java.io.IOException;
20
21 /**
22 * Responsible for transmitting Syslog messages to a Syslog server.
23 */
24 interface SyslogPublisher extends AutoCloseable {
25
26 /**
27 * Send the provided message to the Syslog server.
28 *
29 * @param syslogMessage The message to transmit to the Syslog server.
30 *
31 * @throws IOException If connecting or publishing events to the Syslog daemon failed.
32 */
33 void publishMessage(String syslogMessage) throws IOException;
34
35 /**
36 * Closes the underlying connection.
37 */
38 void close();
39 }