org.eclipse.jetty.server.session.HouseKeeper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.server.session;
import java.util.concurrent.TimeUnit;
import org.eclipse.jetty.server.SessionIdManager;
import org.eclipse.jetty.util.annotation.ManagedAttribute;
import org.eclipse.jetty.util.annotation.ManagedObject;
import org.eclipse.jetty.util.component.AbstractLifeCycle;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.thread.ScheduledExecutorScheduler;
import org.eclipse.jetty.util.thread.Scheduler;
/**
* HouseKeeper
*
* There is 1 session HouseKeeper per SessionIdManager instance.
*
* @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
*/
@ManagedObject
@Deprecated(since = "2021-05-27")
public class HouseKeeper extends AbstractLifeCycle {
private static final Logger LOG = Log.getLogger("org.eclipse.jetty.server.session");
public static final long DEFAULT_PERIOD_MS = 1000L * 60 * 10;
protected SessionIdManager _sessionIdManager;
protected Scheduler _scheduler;
// scavenge task
protected Scheduler.Task _task;
protected Runner _runner;
protected boolean _ownScheduler = false;
private long _intervalMs = DEFAULT_PERIOD_MS;
/**
* Runner
*
* @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
*/
@Deprecated(since = "2021-05-27")
protected class Runner implements Runnable {
@Override
public void run() {
try {
scavenge();
} finally {
synchronized (HouseKeeper.this) {
if (_scheduler != null && _scheduler.isRunning())
_task = _scheduler.schedule(this, _intervalMs, TimeUnit.MILLISECONDS);
}
}
}
}
/**
* SessionIdManager associated with this scavenger
*
* @param sessionIdManager the session id manager
*/
public void setSessionIdManager(SessionIdManager sessionIdManager) {
if (isStarted())
throw new IllegalStateException("HouseKeeper started");
_sessionIdManager = sessionIdManager;
}
@Override
protected void doStart() throws Exception {
if (_sessionIdManager == null)
throw new IllegalStateException("No SessionIdManager for Housekeeper");
setIntervalSec(getIntervalSec());
super.doStart();
}
/**
* If scavenging is not scheduled, schedule it.
*
* @throws Exception if any error during scheduling the scavenging
*/
protected void startScavenging() throws Exception {
synchronized (this) {
if (_scheduler == null) {
if (_sessionIdManager instanceof DefaultSessionIdManager) {
// try and use a common scheduler, fallback to own
_scheduler = ((DefaultSessionIdManager) _sessionIdManager).getServer().getBean(Scheduler.class);
}
if (_scheduler == null) {
_scheduler = new ScheduledExecutorScheduler(String.format("Session-HouseKeeper-%x", hashCode()), false);
_ownScheduler = true;
_scheduler.start();
if (LOG.isDebugEnabled())
LOG.debug("Using own scheduler for scavenging");
} else if (!_scheduler.isStarted())
throw new IllegalStateException("Shared scheduler not started");
}
// cancel any previous task
if (_task != null)
_task.cancel();
if (_runner == null)
_runner = new Runner();
LOG.info("{} Scavenging every {}ms", _sessionIdManager.getWorkerName(), _intervalMs);
_task = _scheduler.schedule(_runner, _intervalMs, TimeUnit.MILLISECONDS);
}
}
/**
* If scavenging is scheduled, stop it.
*
* @throws Exception if any error during stopping the scavenging
*/
protected void stopScavenging() throws Exception {
synchronized (this) {
if (_task != null) {
_task.cancel();
LOG.info("{} Stopped scavenging", _sessionIdManager.getWorkerName());
}
_task = null;
if (_ownScheduler && _scheduler != null) {
_ownScheduler = false;
_scheduler.stop();
_scheduler = null;
}
_runner = null;
}
}
@Override
protected void doStop() throws Exception {
synchronized (this) {
stopScavenging();
_scheduler = null;
}
super.doStop();
}
/**
* Set the period between scavenge cycles
*
* @param sec the interval (in seconds)
* @throws Exception if any error during restarting the scavenging
*/
public void setIntervalSec(long sec) throws Exception {
synchronized (this) {
if (isStarted() || isStarting()) {
if (sec <= 0) {
_intervalMs = 0L;
LOG.info("{} Scavenging disabled", _sessionIdManager.getWorkerName());
stopScavenging();
} else {
if (sec < 10)
LOG.warn("{} Short interval of {}sec for session scavenging.", _sessionIdManager.getWorkerName(), sec);
_intervalMs = sec * 1000L;
// add a bit of variability into the scavenge time so that not all
// nodes with the same scavenge interval sync up
long tenPercent = _intervalMs / 10;
if ((System.currentTimeMillis() % 2) == 0)
_intervalMs += tenPercent;
if (isStarting() || isStarted()) {
startScavenging();
}
}
} else {
_intervalMs = sec * 1000L;
}
}
}
/**
* Get the period between scavenge cycles.
*
* @return the interval (in seconds)
*/
@ManagedAttribute(value = "secs between scavenge cycles", readonly = true)
public long getIntervalSec() {
synchronized (this) {
return _intervalMs / 1000;
}
}
/**
* Periodically do session housekeeping
*/
public void scavenge() {
// don't attempt to scavenge if we are shutting down
if (isStopping() || isStopped())
return;
if (LOG.isDebugEnabled())
LOG.debug("{} scavenging sessions", _sessionIdManager.getWorkerName());
// find the session managers
for (SessionHandler manager : _sessionIdManager.getSessionHandlers()) {
if (manager != null) {
try {
manager.scavenge();
} catch (Exception e) {
LOG.warn(e);
}
}
}
}
@Override
public String toString() {
synchronized (this) {
return super.toString() + "[interval=" + _intervalMs + ", ownscheduler=" + _ownScheduler + "]";
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy