1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir package complex.loadAllDocuments;
28*cdf0e10cSrcweir 
29*cdf0e10cSrcweir import com.sun.star.beans.PropertyValue;
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir import com.sun.star.uno.Exception;
32*cdf0e10cSrcweir import com.sun.star.uno.RuntimeException;
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir import com.sun.star.task.XInteractionHandler;
35*cdf0e10cSrcweir import com.sun.star.task.XInteractionAbort;
36*cdf0e10cSrcweir import com.sun.star.task.XInteractionRetry;
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir import com.sun.star.uno.UnoRuntime;
39*cdf0e10cSrcweir import com.sun.star.uno.AnyConverter;
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir //import java.lang.*;
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir /**
45*cdf0e10cSrcweir  * Implemets a simple interaction handler,
46*cdf0e10cSrcweir  * which can abort all incoming interactions only ... but make it possible to
47*cdf0e10cSrcweir  * log it. So it can be used for debug and test purposes.
48*cdf0e10cSrcweir  */
49*cdf0e10cSrcweir public class InteractionHandler implements XInteractionHandler
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir     // ____________________
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     /**
54*cdf0e10cSrcweir      * @const   RETRY_COUNT it defines the max count of
55*cdf0e10cSrcweir      * retrying of an interaction
56*cdf0e10cSrcweir      */
57*cdf0e10cSrcweir     private static final int RETRY_COUNT    = 3;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     // ____________________
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir     /**
62*cdf0e10cSrcweir      * @member  m_aRequest      the origianl interaction request
63*cdf0e10cSrcweir      * safed for later analyzing
64*cdf0e10cSrcweir      * @member  m_bWasUsed      true if the interaction handler was used
65*cdf0e10cSrcweir      * @member  m_nTry          count using of RETRY continuations
66*cdf0e10cSrcweir      */
67*cdf0e10cSrcweir     private Object          m_aRequest  ;
68*cdf0e10cSrcweir     private int             m_nTry      ;
69*cdf0e10cSrcweir     private boolean         m_bWasUsed  ;
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir     /**
73*cdf0e10cSrcweir      * ctor
74*cdf0e10cSrcweir      * It's initialize an object of this class with default values
75*cdf0e10cSrcweir      * and set the protocol stack. So the outside code can check
76*cdf0e10cSrcweir      * if this handler was used or not.
77*cdf0e10cSrcweir      */
78*cdf0e10cSrcweir     public InteractionHandler()
79*cdf0e10cSrcweir     {
80*cdf0e10cSrcweir         m_aRequest  = null     ;
81*cdf0e10cSrcweir         //m_aProtocol = aProtocol;
82*cdf0e10cSrcweir         m_nTry      = 0        ;
83*cdf0e10cSrcweir         m_bWasUsed = false;
84*cdf0e10cSrcweir     }
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir     /**
87*cdf0e10cSrcweir      * Called to start the interaction, because the outside code whish to solve
88*cdf0e10cSrcweir      * a detected problem or to inform the user about something.
89*cdf0e10cSrcweir      * We safe the informations here and can handle two well known continuations
90*cdf0e10cSrcweir      * only.
91*cdf0e10cSrcweir      * [abort and retry].
92*cdf0e10cSrcweir      *
93*cdf0e10cSrcweir      * @param xRequest
94*cdf0e10cSrcweir      *          describe the interaction
95*cdf0e10cSrcweir      */
96*cdf0e10cSrcweir     public void handle(com.sun.star.task.XInteractionRequest xRequest)
97*cdf0e10cSrcweir     {
98*cdf0e10cSrcweir         m_bWasUsed = true;
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir         // first sav thje original request
101*cdf0e10cSrcweir         // Our user can use this information later for some debug analyzing
102*cdf0e10cSrcweir         Object aRequest = xRequest.getRequest();
103*cdf0e10cSrcweir         synchronized(this)
104*cdf0e10cSrcweir         {
105*cdf0e10cSrcweir             m_aRequest = aRequest;
106*cdf0e10cSrcweir         }
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir         // analyze the possible continuations.
109*cdf0e10cSrcweir         // We can abort all incoming interactions only.
110*cdf0e10cSrcweir         // But additional we can try to continue it several times too.
111*cdf0e10cSrcweir         // Of course after e.g. three loops we have to stop and abort it.
112*cdf0e10cSrcweir         com.sun.star.task.XInteractionContinuation[] lContinuations = xRequest.getContinuations();
113*cdf0e10cSrcweir 
114*cdf0e10cSrcweir         com.sun.star.task.XInteractionAbort xAbort     = null;
115*cdf0e10cSrcweir         com.sun.star.task.XInteractionRetry xRetry     = null;
116*cdf0e10cSrcweir         com.sun.star.uno.Type               xAbortType = new com.sun.star.uno.Type(com.sun.star.task.XInteractionAbort.class);
117*cdf0e10cSrcweir         com.sun.star.uno.Type               xRetryType = new com.sun.star.uno.Type(com.sun.star.task.XInteractionRetry.class);
118*cdf0e10cSrcweir 
119*cdf0e10cSrcweir         for (int i=0; i<lContinuations.length; ++i)
120*cdf0e10cSrcweir         {
121*cdf0e10cSrcweir             try
122*cdf0e10cSrcweir             {
123*cdf0e10cSrcweir                 if (xAbort == null)
124*cdf0e10cSrcweir                     xAbort = (com.sun.star.task.XInteractionAbort)AnyConverter.toObject(xAbortType, lContinuations[i]);
125*cdf0e10cSrcweir                 if (xRetry == null)
126*cdf0e10cSrcweir                     xRetry = (com.sun.star.task.XInteractionRetry)AnyConverter.toObject(xRetryType, lContinuations[i]);
127*cdf0e10cSrcweir             }
128*cdf0e10cSrcweir             catch(com.sun.star.lang.IllegalArgumentException exArg) {}
129*cdf0e10cSrcweir         }
130*cdf0e10cSrcweir 
131*cdf0e10cSrcweir         // try it again, but only if it wasn't tried to much before.
132*cdf0e10cSrcweir         if (xRetry != null)
133*cdf0e10cSrcweir         {
134*cdf0e10cSrcweir             synchronized(this)
135*cdf0e10cSrcweir             {
136*cdf0e10cSrcweir                 if (m_nTry < RETRY_COUNT)
137*cdf0e10cSrcweir                 {
138*cdf0e10cSrcweir                     ++m_nTry;
139*cdf0e10cSrcweir                     xRetry.select();
140*cdf0e10cSrcweir                     return;
141*cdf0e10cSrcweir                 }
142*cdf0e10cSrcweir             }
143*cdf0e10cSrcweir         }
144*cdf0e10cSrcweir 
145*cdf0e10cSrcweir         // otherwhise we can abort this interaction only
146*cdf0e10cSrcweir         if (xAbort != null)
147*cdf0e10cSrcweir         {
148*cdf0e10cSrcweir             xAbort.select();
149*cdf0e10cSrcweir         }
150*cdf0e10cSrcweir     }
151*cdf0e10cSrcweir 
152*cdf0e10cSrcweir     public boolean wasUsed() {
153*cdf0e10cSrcweir         return m_bWasUsed;
154*cdf0e10cSrcweir     }
155*cdf0e10cSrcweir }
156