1 /*
2 * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3 * the spring framework, http://el4j.sf.net
4 * Copyright (C) 2010 by ELCA Informatique SA, Av. de la Harpe 22-24,
5 * 1000 Lausanne, Switzerland, http://www.elca.ch
6 *
7 * EL4J is published under the GNU Lesser General Public License (LGPL)
8 * Version 2.1. See http://www.gnu.org/licenses/
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Lesser General Public License for more details.
14 *
15 * For alternative licensing, please contact info@elca.ch
16 */
17 package ch.elca.el4j.core.correlationId;
18
19 /**
20 * Provides the functionality to set and get the current correlation id.
21 * Usually implementations will be available as Spring bean under the name
22 * 'correlationIdManager'.
23 *
24 * @svnLink $Revision: 4253 $;$Date: 2010-12-21 11:08:04 +0100 (Di, 21. Dez 2010) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/core/src/main/java/ch/elca/el4j/core/correlationId/CorrelationIdManager.java $
25 *
26 * @author Simon Stelling (SST)
27 */
28 public interface CorrelationIdManager {
29
30 /**
31 * sets the current correlation id to the specified value.
32 * @param correlationId the new value
33 */
34 public void setCurrentCorrelationId(String correlationId);
35
36 /**
37 * generates a new correlation Id value and sets it as the new current value.
38 */
39 public void createNewCorrelationId();
40
41 /**
42 * Clears the correlation id.
43 * Subsequent calls to getCurrentCorrelationId() will return null until
44 * setCurrentCorrelationId() or createNewCorrelationId() are called.
45 */
46 public void clearCurrentCorrelationId();
47
48 /**
49 * @return the current correlation id
50 */
51 public String getCurrentCorrelationId();
52
53 }