/*
* JBoss, Home of Professional Open Source.
* Copyright 2014, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.wildfly.clustering.web.infinispan.session;
import org.wildfly.clustering.infinispan.spi.distribution.Locality;
import org.wildfly.clustering.web.session.ImmutableSessionMetaData;
/**
* A scheduler for some task.
* @author Paul Ferraro
*/
public interface Scheduler extends AutoCloseable {
/**
* Schedules a task for the specified session.
* @param session a web session.
*/
void schedule(String sessionId, ImmutableSessionMetaData metaData);
/**
* Cancels a previously scheduled task for the specified session
* @param sessionId the web session identifier
*/
void cancel(String sessionId);
/**
* Cancels any previous scheduled tasks for session which are no longer local to the current node
* @param location the cache locality
*/
void cancel(Locality locality);
/**
* Closes any resources used by this scheduler.
*/
@Override
void close();
}