001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.page;
018
019import java.io.Serializable;
020
021/**
022 * Lock manager for {@link PageAccessSynchronizer} responsible for locking and unlocking pages for
023 * the duration of a request.
024 */
025public interface IPageLockManager extends Serializable
026{
027
028        /**
029         * Acquire a lock to a page
030         *
031         * @param pageId
032         *            page id
033         * @throws CouldNotLockPageException
034         *             if lock could not be acquired
035         */
036        void lockPage(int pageId) throws CouldNotLockPageException;
037
038        /**
039         * Unlocks all pages locked by this thread
040         */
041        void unlockAllPages();
042
043        /**
044         * Unlocks a single page locked by the current thread.
045         *
046         * @param pageId
047         *            the id of the page which should be unlocked.
048         */
049        void unlockPage(int pageId);
050
051}