001    package org.apache.ojb.otm.lock.map;
002    
003    /* Copyright 2003-2005 The Apache Software Foundation
004     *
005     * Licensed under the Apache License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * 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     */
017    
018    import org.apache.ojb.broker.Identity;
019    import org.apache.ojb.otm.lock.ObjectLock;
020    
021    /**
022     *
023     * <javadoc>
024     *
025     * @author <a href="mailto:rraghuram@hotmail.com">Raghu Rajah</a>
026     *
027     */
028    public interface LockMap
029    {
030        
031        public ObjectLock getLock(Identity oid);
032    
033        /**
034         * This is "garbage collection" - remove free locks from 
035         * the map. This method is called at the end of each transaction.
036         * Maybe that would be better to call it by timer?
037         */
038        public void gc();
039    
040    }