1 /*
2 * Copyright 2017 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.openehealth.ipf.commons.audit.queue;
17
18 import org.openehealth.ipf.commons.audit.AuditContext;
19 import org.openehealth.ipf.commons.audit.model.AuditMessage;
20
21 /**
22 * Determine the timing and priority in which audit messages are delivered.
23 * Examples for implementations are synchronous, asynchronous or JMS-based.
24 *
25 * @author Christian Ohr
26 * @since 3.5
27 */
28 public interface AuditMessageQueue {
29
30 /**
31 *
32 * @param auditContext
33 * @param auditMessages
34 * @throws Exception
35 */
36 void audit(AuditContext auditContext, AuditMessage... auditMessages);
37
38 /**
39 * Forces all unsent messages in the queue to be sent
40 */
41 default void flush() {}
42
43 /**
44 * Flushes the queue and shutdown any associated runtime daemons that
45 * may be handling queue inflow/outflow
46 */
47 default void shutdown() {}
48 }