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.activemq.broker;
018
019import java.io.IOException;
020
021/**
022 * A lockable broker resource. Uses {@link Locker} to guarantee that only single instance is running
023 *
024 */
025public interface Lockable {
026
027    /**
028     * Turn locking on/off on the resource
029     *
030     * @param useLock
031     */
032    public void setUseLock(boolean useLock);
033
034    /**
035     * Stop the broker if the locker get an exception while processing lock.
036     *
037     * @param stopOnError
038     */
039    public void setStopOnError(boolean stopOnError);
040
041    /**
042     * Create a default locker
043     *
044     * @return default locker
045     * @throws IOException
046     */
047    public Locker createDefaultLocker() throws IOException;
048
049    /**
050     * Set locker to be used
051     *
052     * @param locker
053     * @throws IOException
054     */
055    public void setLocker(Locker locker) throws IOException;
056
057    /**
058     * Period (in milliseconds) on which {@link org.apache.activemq.broker.Locker#keepAlive()} should be checked
059     *
060     * @param lockKeepAlivePeriod
061     */
062    public void setLockKeepAlivePeriod(long lockKeepAlivePeriod);
063
064    long getLockKeepAlivePeriod();
065}