Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 06c46467b018f761eef7f34eb85856c58db22609 (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2018 Liferay, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Liferay, Inc. - Bug 530063 - CNFE when session replication
 *                    is used with equinox.http.servlet in bridge mode
 ******************************************************************************/

package org.eclipse.equinox.http.servlet.session;

/**
 * The Http Whiteboard runtime registers a service of this type to
 * allow an external actor to invalidate a session. This requirement is typical of
 * the bridge deployment scenario where the host may need to control session invalidation.
 * <p>
 * <b>Note:</b> This class is part of an interim SPI that is still under
 * development and expected to change significantly before reaching stability.
 * It is being made available at this stage to solicit feedback from pioneering
 * adopters on the understanding that any code that uses this SPI will almost certainly
 * be broken (repeatedly) as the SPI evolves.
 * </p>
 * @since 1.4
 */
public interface HttpSessionInvalidator {

	/**
	 * Invalidate a session. If no session matching the id is found, nothing happens.
	 * Optionally attempt to invalidate the parent (container) session.
	 *
	 * @param sessionId        the session id to invalidate
	 * @param invalidateParent if true, attempt to invalidate the parent
	 *                         (container) session
	 */
	public void invalidate(String sessionId, boolean invalidateParent);

}

Back to the top