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     */
017    
018    package org.apache.geronimo.transaction.manager;
019    
020    import java.util.HashSet;
021    import java.util.List;
022    import java.util.Set;
023    import java.util.Map;
024    import javax.transaction.xa.XAException;
025    import javax.transaction.xa.Xid;
026    
027    /**
028     *
029     *
030     * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
031     *
032     * */
033    public interface Recovery {
034    
035        void recoverLog() throws XAException;
036    
037        void recoverResourceManager(NamedXAResource xaResource) throws XAException;
038    
039        boolean hasRecoveryErrors();
040    
041        List getRecoveryErrors();
042    
043        boolean localRecoveryComplete();
044    
045        int localUnrecoveredCount();
046    
047        //hard to implement.. needs ExternalTransaction to have a reference to externalXids.
048    //    boolean remoteRecoveryComplete();
049    
050        Map getExternalXids();
051    
052        public static class XidBranchesPair {
053            private final Xid xid;
054    
055            //set of TransactionBranchInfo
056            private final Set branches = new HashSet();
057    
058            private final Object mark;
059    
060            public XidBranchesPair(Xid xid, Object mark) {
061                this.xid = xid;
062                this.mark = mark;
063            }
064    
065            public Xid getXid() {
066                return xid;
067            }
068    
069            public Set getBranches() {
070                return branches;
071            }
072    
073            public Object getMark() {
074                return mark;
075            }
076    
077            public void addBranch(TransactionBranchInfo branchInfo) {
078                branches.add(branchInfo);
079            }
080        }
081    
082    }