[jboss-svn-commits] JBL Code SVN: r26769 - in labs/jbosstm/trunk: ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator and 14 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Fri May 29 04:37:36 EDT 2009
Author: jhalliday
Date: 2009-05-29 04:37:35 -0400 (Fri, 29 May 2009)
New Revision: 26769
Modified:
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/AtomicAction.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/CadaverRecord.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/StateManager.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/AbstractRecord.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/ActionHierarchy.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/HeuristicInformation.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/RecordList.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/TwoPhaseCoordinator.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/ObjectStoreImple.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/jdbc/JDBCAccess.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/RecoveryManager.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/TransactionStatusConnectionManager.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/utils/Utility.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/coordinator/ReaperElement.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/JDBCStore.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/VolatileStore.java
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/recovery/PeriodicRecovery.java
labs/jbosstm/trunk/ArjunaCore/tsmx/classes/com/arjuna/ats/internal/tsmx/mbeans/PropertyServiceMBeanWrapper.java
labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/recovery/XAResourceRecovery.java
labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/utils/XAHelper.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/AbstractLogImpl.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/DefaultLog.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/propertyservice/PropertyManagerImpl.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyManager.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyServiceImple.java
labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/propertycontainer/PropertyManagerPluginInterface.java
Log:
Clean up broken javadoc tags. JBTM-562
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/AtomicAction.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/AtomicAction.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/AtomicAction.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Arjuna Solutions Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: AtomicAction.java 2342 2006-03-30 13:06:17Z $
*/
@@ -41,12 +41,12 @@
* This is a user-level transaction class, unlike BasicAction. AtomicAction
* takes care of thread-to-action scoping. This is a "one-shot" object, i.e.,
* once terminated, the instance cannot be re-used for another transaction.
- *
+ *
* An instance of this class is a transaction that can be started and terminated
* (either committed or rolled back). There are also methods to allow
* participants (AbstractRecords) to be enlisted with the transaction and to
* associate/disassociate threads with the transaction.
- *
+ *
* @author Mark Little (mark at arjuna.com)
* @version $Id: AtomicAction.java 2342 2006-03-30 13:06:17Z $
* @since JTS 1.0.
@@ -56,12 +56,12 @@
{
public static final int NO_TIMEOUT = -1;
-
+
/**
* Create a new transaction. If there is already a transaction associated
* with the thread then this new transaction will be automatically nested.
* The transaction is *not* running at this point.
- *
+ *
* No timeout is associated with this transaction, i.e., it will not be
* automatically rolled back by the system.
*/
@@ -100,10 +100,10 @@
/**
* Start the transaction running.
- *
+ *
* If the transaction is already running or has terminated, then an error
* code will be returned. No timeout is associated with the transaction.
- *
+ *
* @return <code>ActionStatus</code> indicating outcome.
*/
@@ -114,22 +114,21 @@
/**
* Start the transaction running.
- *
+ *
* If the transaction is already running or has terminated, then an error
* code will be returned.
- *
- * @param int
- * timeout the timeout associated with the transaction. If the
+ *
+ * @param timeout the timeout associated with the transaction. If the
* transaction is still active when this timeout elapses, the
* system will automatically roll it back.
- *
+ *
* @return <code>ActionStatus</code> indicating outcome.
*/
public int begin (int timeout)
{
int status = super.start();
-
+
if (status == ActionStatus.RUNNING)
{
/*
@@ -139,10 +138,10 @@
ThreadActionData.pushAction(this);
_timeout = timeout;
-
+
if (_timeout == 0)
_timeout = TxControl.getDefaultTimeout();
-
+
if (_timeout > 0)
TransactionReaper.transactionReaper(true).insert(this, _timeout);
}
@@ -153,7 +152,7 @@
/**
* Commit the transaction, and have heuristic reporting. Heuristic reporting
* via the return code is enabled.
- *
+ *
* @return <code>ActionStatus</code> indicating outcome.
*/
@@ -165,10 +164,10 @@
/**
* Commit the transaction. The report_heuristics parameter can be used to
* determine whether or not heuristic outcomes are reported.
- *
+ *
* If the transaction has already terminated, or has not begun, then an
* appropriate error code will be returned.
- *
+ *
* @return <code>ActionStatus</code> indicating outcome.
*/
@@ -189,10 +188,10 @@
/**
* Abort (rollback) the transaction.
- *
+ *
* If the transaction has already terminated, or has not been begun, then an
* appropriate error code will be returned.
- *
+ *
* @return <code>ActionStatus</code> indicating outcome.
*/
@@ -238,7 +237,7 @@
return outcome;
}
-
+
/*
* @return the timeout associated with this instance.
*/
@@ -251,9 +250,9 @@
/**
* The type of the class is used to locate the state of the transaction log
* in the object store.
- *
+ *
* Overloads BasicAction.type()
- *
+ *
* @return a string representation of the hierarchy of the class for storing
* logs in the transaction object store.
*/
@@ -266,7 +265,7 @@
/**
* Register the current thread with the transaction. This operation is not
* affected by the state of the transaction.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -279,7 +278,7 @@
/**
* Register the specified thread with the transaction. This operation is not
* affected by the state of the transaction.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -298,7 +297,7 @@
/**
* Unregister the current thread from the transaction. This operation is not
* affected by the state of the transaction.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -311,7 +310,7 @@
/**
* Unregister the specified thread from the transaction. This operation is
* not affected by the state of the transaction.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -330,13 +329,13 @@
/**
* Suspend all transaction association from the invoking thread. When this
* operation returns, the thread will be associated with no transactions.
- *
+ *
* If the current transaction is not an AtomicAction then this method will
* not suspend.
- *
+ *
* @return a handle on the current AtomicAction (if any) so that the thread
* can later resume association if required.
- *
+ *
* message com.arjuna.ats.atomicaction_1 Attempt to suspend a
* non-AtomicAction transaction. Type is {0}
*/
@@ -369,12 +368,11 @@
* transaction is null, then this is the same as doing a suspend. If the
* current thread is associated with transactions then those associations
* will be lost.
- *
- * @param AtomicAction
- * act the transaction to associate. If this is a nested
+ *
+ * @param act the transaction to associate. If this is a nested
* transaction, then the thread will be associated with all of
* the transactions in the hierarchy.
- *
+ *
* @return <code>true</code> if association is successful,
* <code>false</code> otherwise.
*/
@@ -404,7 +402,7 @@
* By default the BasicAction class only allows the termination of a
* transaction if it's the one currently associated with the thread. We
* override this here.
- *
+ *
* @return <code>true</code> to indicate that this transaction can only be
* terminated by the right thread.
*/
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/CadaverRecord.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/CadaverRecord.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/CadaverRecord.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Arjuna Solutions Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: CadaverRecord.java 2342 2006-03-30 13:06:17Z $
*/
@@ -65,41 +65,41 @@
/**
* Create a new instance, passing in the object that is being managed.
*
- * @param OutputObjectState os the state of the object that is being
+ * @param os the state of the object that is being
* removed.
- * @ObjectStore objStore the object store instance used to manipulate the
+ * @param objStore the object store instance used to manipulate the
* persistent state.
- * @param StateManager sm the object being removed.
+ * @param sm the object being removed.
*/
public CadaverRecord (OutputObjectState os, ObjectStore objStore,
StateManager sm)
{
super(os, objStore, sm);
-
+
newStateIsValid = ((os != null) ? true : false);
oldState = null;
oType = RecordType.NONE_RECORD;
store = objStore; // implicit ref count in Java
-
+
if (store != null)
{
/*
* If the object goes out of scope its object store may
* be inaccessable - increase reference count to compensate
*/
-
+
/*
* Don't need this in Java.
*/
-
+
// ObjectStore.reference(store);
}
if (tsLogger.arjLogger.debugAllowed())
{
- tsLogger.arjLogger.debug(DebugLevel.CONSTRUCTORS, VisibilityLevel.VIS_PUBLIC,
- FacilityCode.FAC_ABSTRACT_REC,
+ tsLogger.arjLogger.debug(DebugLevel.CONSTRUCTORS, VisibilityLevel.VIS_PUBLIC,
+ FacilityCode.FAC_ABSTRACT_REC,
"CadaverRecord::CadaverRecord("+os+", "+sm.get_uid()+")");
}
}
@@ -127,7 +127,7 @@
{
return RecordType.PERSISTENCE;
}
-
+
/**
* The ClassName representation of this class.
*/
@@ -136,7 +136,7 @@
{
return ArjunaNames.Implementation_AbstractRecord_CadaverRecord();
}
-
+
/**
* The nested transaction has aborted. The record will invalidate any
* new state.
@@ -151,10 +151,10 @@
tsLogger.arjLogger.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::nestedAbort() for "+order());
}
-
+
if (oldState != null)
newStateIsValid = false;
-
+
if (oType == RecordType.RECOVERY)
{
if (tsLogger.arjLoggerI18N.isWarnEnabled())
@@ -163,18 +163,18 @@
new Object[]{ order(), getTypeOfObject() } );
}
}
-
+
/*
* No need to forget the action since this object is
* being deleted so it is unlikely to have modified called
* on it!
*/
-
+
// super.forgetAction(false);
-
+
return TwoPhaseOutcome.FINISH_OK;
}
-
+
/**
* The nested transaction is preparing. If there is any new state for
* the object being removed, and that state is valid, then this record
@@ -183,7 +183,7 @@
* If we have no new state then we cannot commit and must force an
* abort. Do this by failing the prepare phase.
*/
-
+
public int nestedPrepare ()
{
if (tsLogger.arjLogger.debugAllowed())
@@ -191,7 +191,7 @@
tsLogger.arjLogger.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::nestedPrepare() for "+order());
}
-
+
if (newStateIsValid)
return super.nestedPrepare();
else
@@ -209,9 +209,9 @@
tsLogger.arjLogger.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::topLevelAbort() for "+order());
}
-
+
newStateIsValid = false;
-
+
if (oType == RecordType.RECOVERY)
{
if (tsLogger.arjLoggerI18N.isWarnEnabled())
@@ -220,19 +220,19 @@
new Object[]{ order(), getTypeOfObject() } );
}
}
-
+
// super.forgetAction(false);
-
+
return TwoPhaseOutcome.FINISH_OK;
}
-
+
/**
* At topLevelCommit we commit the uncommitted version already saved
* into object store.
* Cannot use inherited version since that assumes object is alive
* instead talk directly to the object store itself.
*/
-
+
public int topLevelCommit ()
{
if (tsLogger.arjLogger.debugAllowed())
@@ -240,15 +240,15 @@
tsLogger.arjLogger.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::topLevelCommit() for "+order());
}
-
+
boolean res = true;
OutputObjectState oState = super.state;
-
+
if ((oState != null) && (oType == RecordType.PERSISTENCE))
{
if (store == null)
return TwoPhaseOutcome.FINISH_ERROR;
-
+
try
{
res = store.commit_state(oState.stateUid(), oState.type());
@@ -258,18 +258,18 @@
res = false;
}
}
-
+
// super.forgetAction(false);
-
+
return ((res) ? TwoPhaseOutcome.FINISH_OK : TwoPhaseOutcome.FINISH_ERROR);
}
-
+
/**
* At topLevelPrepare write uncommitted version into object store.
* Cannot use inherited version since that assumes object is alive
* instead talk directly to the object store itself.
*/
-
+
public int topLevelPrepare ()
{
if (tsLogger.arjLogger.debugAllowed())
@@ -277,10 +277,10 @@
tsLogger.arjLogger.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::topLevelPrepare() for "+order());
}
-
+
int tlpOk = TwoPhaseOutcome.PREPARE_NOTOK;
OutputObjectState oState = (newStateIsValid ? super.state : oldState);
-
+
if (oState != null)
{
if (oType == RecordType.PERSISTENCE)
@@ -303,7 +303,7 @@
else
tlpOk = TwoPhaseOutcome.PREPARE_OK;
}
-
+
return tlpOk;
}
@@ -311,7 +311,7 @@
* Override AbstractRecord.print to write specific information to
* the specified stream.
*
- * @param PrintWriter strm the stream to use.
+ * @param strm the stream to use.
*/
public void print (PrintWriter strm)
@@ -353,12 +353,12 @@
*
* @return a new CadaverRecord.
*/
-
+
public static AbstractRecord create ()
{
return new CadaverRecord();
}
-
+
/**
* merge takes the information from the incoming PersistenceRecord and
* uses it to initialise the oldState information. This is required
@@ -366,20 +366,20 @@
* final state of an object normally - which is required if the action
* commits.
*
- * @param AbstractRecord mergewith The record to merge with.
+ * @param mergewith The record to merge with.
*/
-
+
public void merge (AbstractRecord mergewith)
{
/*
- * Following assumes that value returns a pointer to the
+ * Following assumes that value returns a pointer to the
* old state maintained in the PersistenceRecord (as an ObjectState).
* Here we create a copy of that state allowing the original
* to be deleted
*/
oType = mergewith.typeIs();
-
+
if (oldState != null)
{
if (newStateIsValid)
@@ -387,19 +387,19 @@
oldState = null;
}
else
- {
+ {
setValue(oldState);
newStateIsValid = true;
}
}
-
+
oldState = new OutputObjectState((OutputObjectState)(mergewith.value()));
}
/**
* Overrides AbstractRecord.shouldMerge
*
- * @param AbstractRecord ar the record to potentially merge with.
+ * @param ar the record to potentially merge with.
*
* @return <code>true</code> if this instance and the parameter have the
* same id (order()) and the parameter is either persistent or recoverable.
@@ -418,7 +418,7 @@
/**
* Overrides AbstractRecord.shouldReplace
*
- * @param AbstractRecord ar the record to potentially replace this
+ * @param ar the record to potentially replace this
* instance.
*
* @return <code>true</code> if this instance and the parameter have the
@@ -426,7 +426,7 @@
* <code>false</code> otherwise.
* @see com.arjuna.ats.arjuna.coordinator.RecordType
*/
-
+
public boolean shouldReplace (AbstractRecord ar)
{
return (((order().equals(ar.order())) &&
@@ -455,10 +455,10 @@
FacilityCode.FAC_ABSTRACT_REC, "CadaverRecord::CadaverRecord ()");
}
}
-
+
private boolean newStateIsValid;
private OutputObjectState oldState;
private int oType;
private ObjectStore store;
-
+
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/StateManager.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/StateManager.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/StateManager.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -726,8 +726,6 @@
* @since JTS 2.1.
* @param txId the identity of the transaction that last caused the
* state to be written to the object store.
- * @return the <code>Uid</code> of the process that last managed this
- * state.
*/
protected void unpackHeader (InputObjectState os, Uid txId,
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/AbstractRecord.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/AbstractRecord.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/AbstractRecord.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Hewlett Packard Arjuna Labs,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: AbstractRecord.java 2342 2006-03-30 13:06:17Z $
*/
@@ -47,14 +47,14 @@
/**
* Abstract Record Class
- *
+ *
* This class provides an abstract template that defines the interface that the
* atomic action system uses to notify objects that various state transitions
* have occurred as the 2PC protocol executes. Record types derived from this
* class manage certain properties of objects such as recovery information,
* concurrency control information etc, and all must redifine the operations
* defined here as abstract to take appropriate action.
- *
+ *
* Many functions are declared pure virtual to force a definition to occur in
* any derived class. These are currently all functions dealing with atomic
* action coordination as well as the following list management functions:
@@ -67,7 +67,7 @@
* records should be merged into a single record, FALSE if it should be
* discarded shouldReplace: returns TRUE if the record should replace an
* existing one, FALSE otherwise.
- *
+ *
* @author Mark Little (mark at arjuna.com)
* @version $Id: AbstractRecord.java 2342 2006-03-30 13:06:17Z $
* @since 1.0.
@@ -85,7 +85,7 @@
/**
* If this abstract record caused a heuristic then it should return an
* object which implements <code>HeuristicInformation</code>
- *
+ *
* @return <code>Object</code> to be used to order.
*/
@@ -95,7 +95,7 @@
/**
* Only used for crash recovery, so most records don't need it.
- *
+ *
* @return <code>ClassName</code> to identify this abstract record.
*/
@@ -110,7 +110,7 @@
/**
* A rollback of a nested transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -119,7 +119,7 @@
/**
* A commit of a nested transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -128,7 +128,7 @@
/**
* A prepare for a nested transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -137,7 +137,7 @@
/**
* A rollback of a top-level transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -146,7 +146,7 @@
/**
* A commit of a top-level transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -155,7 +155,7 @@
/**
* A prepare for a top-level transaction has occurred.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -166,7 +166,7 @@
* Return the Uid of this abstract record so that it can be ordered in the
* intentions list. This is also the Uid that the record was saved with in
* the object store.
- *
+ *
* @return <code>Uid</Uid> for this instance.
* @see com.arjuna.ats.arjuna.common.Uid
*/
@@ -186,7 +186,7 @@
* Return the type of the abstract record. Used in ordering the instances in
* the intentions list. This is also the type that the record was saved with
* in the object store.
- *
+ *
* @return <code>String</code> representing type.
*/
@@ -198,7 +198,7 @@
/**
* Determine if records are discarded on action abort or must be propagated
* to parents.
- *
+ *
* @return <code>true</code> if the record should be propagated to the
* parent transaction if the current transaction rolls back,
* <code>false</code> otherwise. The default is <code>false</code>.
@@ -212,7 +212,7 @@
/**
* Determine if records are discarded on action commit or must be propagated
* to parents.
- *
+ *
* @return <code>true</code> if the record should be propagated to the
* parent transaction if the current transaction commits,
* <code>false</code> otherwise. The default is <code>true</code>.
@@ -232,7 +232,7 @@
/**
* Determine if two records are equal in that both are the same type and
* have the same order value (determined via 'order()').
- *
+ *
* @return <code>true</code> if equal, <code>false</code> otherwise.
*/
@@ -245,7 +245,7 @@
/**
* Determine if two records are less than in that both are the same type and
* their Uids are less than.
- *
+ *
* @return <code>true</code> if equal, <code>false</code> otherwise.
*/
@@ -258,7 +258,7 @@
/**
* Determine if two records are greater than in that both are the same type
* and their Uids are greater than.
- *
+ *
* @return <code>true</code> if equal, <code>false</code> otherwise.
*/
@@ -270,10 +270,10 @@
/**
* Cleanup is called if a top-level action is detected to be an orphan.
- *
+ *
* NOTE nested actions are never orphans since their parents would be
* aborted we may as well abort them as well.
- *
+ *
* @return <code>TwoPhaseOutcome</code> as default is the same as
* topLevelAbort.
*/
@@ -285,10 +285,10 @@
/**
* Cleanup is called if a nested is detected to be an orphan.
- *
+ *
* NOTE nested actions are never orphans since their parents would be
* aborted we may as well abort them as well.
- *
+ *
* @return <code>TwoPhaseOutcome</code> as default is the same as
* nestedAbort.
*/
@@ -303,7 +303,7 @@
* saved, then it may be recovered later in the event of a failure. Note,
* however, that the size of the intentions list on disk is critical to the
* performance of the system (disk I/O is a bottleneck).
- *
+ *
* @return <code>true</code> if it should be saved, <code>false</code>
* otherwise. <code>false</code> is the default.
*/
@@ -324,9 +324,8 @@
/**
* Write information about this specific instance to the specified stream.
- *
- * @param PrintWriter
- * strm the stream on which to output.
+ *
+ * @param strm the stream on which to output.
*/
public void print (PrintWriter strm)
@@ -343,7 +342,7 @@
* called and the record instance must save enough information to enable it
* to be restored from that state later. The basic AbstractRecord save_state
* will save common data that is required by the base class during recovery.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -370,7 +369,7 @@
* recreated AbstractRecord the state that that was saved during transaction
* persistence. The base class will restore information that it needs from
* the log.
- *
+ *
* @return <code>true</code> if successful, <code>false</code>
* otherwise.
*/
@@ -394,7 +393,7 @@
/**
* Forget any heuristic outcome which this implementation may have produced.
- *
+ *
* @return <code>true</code> by default. If <code>false</code> is
* returned then the instance must be remembered by the transaction
* (in the log) in order for recovery to retry later or for a system
@@ -409,7 +408,7 @@
/**
* Perform a nested one phase commit.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -431,7 +430,7 @@
/**
* Perform a top-level one phase commit.
- *
+ *
* @return <code>TwoPhaseOutcome</code> to indicate success/failure.
* @see com.arjuna.ats.arjuna.coordinator.TwoPhaseOutcome
*/
@@ -484,27 +483,24 @@
/**
* Merge the current record with the one presented.
- *
- * @param AbstractRecord
- * a the record with which to merge.
+ *
+ * @param a the record with which to merge.
*/
public abstract void merge (AbstractRecord a);
/**
* Alter the current record with the one presented.
- *
- * @param AbstractRecord
- * a the record with which to alter.
+ *
+ * @param a the record with which to alter.
*/
public abstract void alter (AbstractRecord a);
/**
* Should we add the record presented to the intentions list?
- *
- * @param AbstractRecord
- * a The record to try to add.
+ *
+ * @param a The record to try to add.
* @return <code>true</code> if the record should be added,
* <code>false</code> otherwise.
*/
@@ -513,9 +509,8 @@
/**
* Should we alter the current record with the one presented?
- *
- * @param AbstractRecord
- * a The record to try to alter.
+ *
+ * @param a The record to try to alter.
* @return <code>true</code> if the record should be altered,
* <code>false</code> otherwise.
*/
@@ -524,9 +519,8 @@
/**
* Should we merge the current record with the one presented?
- *
- * @param AbstractRecord
- * a The record to try to merge.
+ *
+ * @param a The record to try to merge.
* @return <code>true</code> if the record should be merged,
* <code>false</code> otherwise.
*/
@@ -535,9 +529,8 @@
/**
* Should we replace the record presented with the current record?
- *
- * @param AbstractRecord
- * a The record to try to replace.
+ *
+ * @param a The record to try to replace.
* @return <code>true</code> if the record should be replaced,
* <code>false</code> otherwise.
*/
@@ -548,9 +541,8 @@
* The current record is about to replace the one presented. This method is
* invoked to give the current record a chance to copy information, for
* example, from the record being replaced.
- *
- * @param AbstractRecord
- * a the record that will replace this instance.
+ *
+ * @param a the record that will replace this instance.
*/
public void replace (AbstractRecord a)
@@ -560,7 +552,7 @@
/**
* These few functions are link manipulation primitives used by the
* RecordList processing software to chain instances together.
- *
+ *
* @return the previous element in the intentions list, or null.
*/
@@ -580,9 +572,8 @@
/**
* Set the previous element in the list to the specified instance.
- *
- * @param AbstractRecord
- * ar the instance to become previous.
+ *
+ * @param ar the instance to become previous.
*/
protected final void setPrevious (AbstractRecord ar)
@@ -592,9 +583,8 @@
/**
* Set the next element in the list to the specified instance.
- *
- * @param AbstractRecord
- * ar the instance to become next.
+ *
+ * @param ar the instance to become next.
*/
protected final void setNext (AbstractRecord ar)
@@ -604,13 +594,10 @@
/**
* Create a new instance with the specified paramaters.
- *
- * @param Uid
- * storeUid the unique id for this instance.
- * @param String
- * objType the type of the instance.
- * @param int
- * otype the ObjectType of the object.
+ *
+ * @param storeUid the unique id for this instance.
+ * @param objType the type of the instance.
+ * @param otype the ObjectType of the object.
* @see com.arjuna.ats.arjuna.ObjectType
*/
@@ -632,9 +619,8 @@
/**
* Create a new instance with the specified paramaters.
- *
- * @param Uid
- * storeUid the unique id for this instance.
+ *
+ * @param storeUid the unique id for this instance.
*/
protected AbstractRecord (Uid storeUid)
@@ -656,7 +642,7 @@
/**
* Creates a 'blank' abstract record. This is used during crash recovery
* when recreating the prepared list of a server atomic action.
- *
+ *
* @message com.arjuna.ats.arjuna.coordinator.AbstractRecord_1
* [com.arjuna.ats.arjuna.coordinator.AbstractRecord_1] -
* AbstractRecord::AbstractRecord () - crash recovery constructor
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/ActionHierarchy.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/ActionHierarchy.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/ActionHierarchy.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -432,7 +432,7 @@
}
/**
- * @eturn the ActionInfo for the transaction at the
+ * @return the ActionInfo for the transaction at the
* specified level. ActionInfo is not a public class so this is of
* limited use outside of the transaction system.
*/
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/HeuristicInformation.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/HeuristicInformation.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/HeuristicInformation.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -42,13 +42,13 @@
{
/**
* The type of heuristic.
- * @return
+ * @return the heuristic type
*/
public int getHeuristicType();
/**
* A reference to the entity that caused the heuristic.
- * @return
+ * @return the entity reference
*/
public Object getEntityReference();
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/RecordList.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/RecordList.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/RecordList.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Arjuna Solutions Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: RecordList.java 2342 2006-03-30 13:06:17Z $
*/
@@ -64,7 +64,7 @@
* @message com.arjuna.ats.arjuna.coordinator.RecordList_2 [com.arjuna.ats.arjuna.coordinator.RecordList_2] - RecordList::insert({0}) : replacing {1} and {2} for {3}
* @message com.arjuna.ats.arjuna.coordinator.RecordList_3 [com.arjuna.ats.arjuna.coordinator.RecordList_3] - RecordList::insert({0}) : adding extra record of type {1} before {2} for {3}
* @message com.arjuna.ats.arjuna.coordinator.RecordList_4 [com.arjuna.ats.arjuna.coordinator.RecordList_4] - RecordList::insert({0}) : inserting {1} for {2} before {3}
- * @message com.arjuna.ats.arjuna.coordinator.RecordList_5 [com.arjuna.ats.arjuna.coordinator.RecordList_5] - RecordList::insert({0}) : appending {1} for {2}
+ * @message com.arjuna.ats.arjuna.coordinator.RecordList_5 [com.arjuna.ats.arjuna.coordinator.RecordList_5] - RecordList::insert({0}) : appending {1} for {2}
* @message com.arjuna.ats.arjuna.coordinator.RecordList_6 [com.arjuna.ats.arjuna.coordinator.RecordList_6] - RecordList::insert({0}) : inserting {1} for {2} before {3} for {4}
*/
@@ -77,14 +77,14 @@
listTail = null;
noEntries = 0;
}
-
+
public RecordList (RecordList copy)
{
listHead = copy.listHead;
listTail = copy.listTail;
noEntries = copy.noEntries;
}
-
+
/**
* Remove and return the element at the front of the list.
*
@@ -141,7 +141,7 @@
public AbstractRecord getNext (AbstractRecord current)
{
AbstractRecord rec = current.getNext();
-
+
if (remove(rec))
return rec;
else
@@ -188,7 +188,7 @@
newRecord.setNext(listHead);
listHead = newRecord;
}
-
+
noEntries++;
}
@@ -211,7 +211,7 @@
newRecord.setNext(null);
listTail = newRecord;
}
-
+
noEntries++;
}
@@ -229,7 +229,7 @@
{
return curr.getNext();
}
-
+
/*
* Assume it's in this list!
*/
@@ -238,7 +238,7 @@
{
if (oldRecord == null)
return false;
-
+
if (noEntries == 1)
{
listHead = listTail = null;
@@ -266,7 +266,7 @@
{
if (oldRecord.getPrevious() != null)
oldRecord.getPrevious().setNext(oldRecord.getNext());
-
+
if (oldRecord.getNext() != null)
oldRecord.getNext().setPrevious(oldRecord.getPrevious());
}
@@ -302,10 +302,10 @@
rec = rec.getNext();
}
}
-
+
return s;
}
-
+
/**
* This is a variation on ordered insertion.
* Insertion obeys the following algorithm.
@@ -319,7 +319,7 @@
* INSERT the new record IN PLACE OF the old and exit
* 3) If the new record should be added in addition to the old then
* INSERT the new record BEFORE the old and exit
- * 4) If the two records are the same (determined by the
+ * 4) If the two records are the same (determined by the
* == operator) simply exit
* 5) Otherwise determine if the new record should be added here
* regardless due to the ordering constraints on the list and if so
@@ -333,7 +333,7 @@
* Step 5 ensures that if no existing record exists insertion takes
* place at the correct point
*
- * @returns <code>true</code> if insertion/replacement took place,
+ * @return <code>true</code> if insertion/replacement took place,
* <code>false</code> otherwise.
*/
@@ -352,7 +352,7 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PRIVATE,
- FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_1",
+ FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_1",
new Object[]{this, newRecord.type(),
current.type(), newRecord.order()});
}
@@ -369,7 +369,7 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PRIVATE,
- FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_2",
+ FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_2",
new Object[]{this, current.type(),
newRecord.type(), newRecord.order()});
}
@@ -385,7 +385,7 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PRIVATE,
- FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_3",
+ FacilityCode.FAC_ABSTRACT_REC, "com.arjuna.ats.arjuna.coordinator.RecordList_3",
new Object[]{this, newRecord.type(),
current.type(), newRecord.order()});
}
@@ -429,7 +429,7 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PRIVATE,
- FacilityCode.FAC_ABSTRACT_REC,
+ FacilityCode.FAC_ABSTRACT_REC,
"com.arjuna.ats.arjuna.coordinator.RecordList_5",new Object[]{this,newRecord.type(),newRecord.order()});
}
@@ -440,14 +440,14 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PRIVATE,
- FacilityCode.FAC_ABSTRACT_REC,
+ FacilityCode.FAC_ABSTRACT_REC,
"com.arjuna.ats.arjuna.coordinator.RecordList_6", new Object[]{this, newRecord.type(),newRecord.order(),
current.type(), current.order()});
}
insertBefore(newRecord, current);
}
-
+
return true;
}
@@ -470,7 +470,7 @@
else
/* must be pointing to the head of the list */
listHead = newRecord;
-
+
noEntries++;
}
@@ -478,12 +478,12 @@
{
newRecord.setPrevious(oldRecord.getPrevious());
newRecord.setNext(oldRecord.getNext());
-
+
if (newRecord.getPrevious() != null)
(newRecord.getPrevious()).setNext(newRecord);
else
listHead = newRecord;
-
+
if (newRecord.getNext() != null)
(newRecord.getNext()).setPrevious(newRecord);
else
@@ -491,10 +491,10 @@
oldRecord = null;
}
-
+
protected AbstractRecord listHead;
-
+
private AbstractRecord listTail;
private int noEntries;
-
+
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/TwoPhaseCoordinator.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/TwoPhaseCoordinator.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/coordinator/TwoPhaseCoordinator.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -82,13 +82,13 @@
if (parent() != null)
parent().removeChildAction(this);
-
+
boolean canEnd = true;
if(status() != ActionStatus.ABORT_ONLY || TxControl.isBeforeCompletionWhenRollbackOnly())
{
canEnd = beforeCompletion();
}
-
+
if (canEnd)
{
outcome = super.End(report_heuristics);
@@ -105,7 +105,7 @@
{
if (TxControl.enableStatistics)
TxStats.incrementApplicationRollbacks();
-
+
if (parent() != null)
parent().removeChildAction(this);
@@ -188,7 +188,7 @@
/**
* Get any Throwable that was caught during commit processing but not directly rethrown.
- * @return
+ * @return the Throwable, if any
*/
public Throwable getDeferredThrowable() {
return _deferredThrowable;
@@ -223,7 +223,7 @@
if (!_beforeCalled)
{
_beforeCalled = true;
-
+
/*
* If we have a synchronization list then we must be top-level.
*/
@@ -365,9 +365,9 @@
while(iterator.hasNext()) {
stack.push(iterator.next());
}
-
+
iterator = stack.iterator();
-
+
/*
* Regardless of failures, we must tell all synchronizations what
* happened.
@@ -375,14 +375,14 @@
while(!stack.isEmpty())
{
SynchronizationRecord record = (SynchronizationRecord)stack.pop();
-
+
try
{
if (!record.afterCompletion(myStatus))
{
tsLogger.arjLoggerI18N.warn("com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator_4", new Object[]
{ record });
-
+
problem = true;
}
}
@@ -399,14 +399,14 @@
problem = true;
}
}
-
+
_synchs = null;
_currentRecord = null;
}
}
else
{
-
+
}
}
@@ -435,9 +435,9 @@
private SortedSet _synchs;
private SynchronizationRecord _currentRecord; // the most recently processed Synchronization.
private Throwable _deferredThrowable;
-
+
private Object _syncLock = new Object();
-
+
private boolean _beforeCalled = false;
private boolean _afterCalled = false;
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/ObjectStoreImple.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/ObjectStoreImple.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/ObjectStoreImple.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Arjuna Solutions Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: ObjectStoreImple.java 2342 2006-03-30 13:06:17Z $
*/
@@ -74,9 +74,9 @@
/**
* Obtain all of the Uids for a specified type.
*
- * @param String s The type to scan for.
- * @param InputObjectState buff The object state in which to store the Uids
- * @param int m The file type to look for (e.g., committed, shadowed).
+ * @param s The type to scan for.
+ * @param buff The object state in which to store the Uids
+ * @param m The file type to look for (e.g., committed, shadowed).
*
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
@@ -87,7 +87,7 @@
/**
* Obtain all types of objects stored in the object store.
*
- * @param InputObjectState buff The state in which to store the types.
+ * @param buff The state in which to store the types.
*
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
@@ -96,8 +96,8 @@
public abstract boolean allTypes (InputObjectState buff) throws ObjectStoreException;
/**
- * @param Uid u The object to query.
- * @param String tn The type of the object to query.
+ * @param u The object to query.
+ * @param tn The type of the object to query.
*
* @return the current state of the object's state (e.g., shadowed,
* committed ...)
@@ -114,8 +114,8 @@
/**
* Commit the object's state in the object store.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
*
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
@@ -127,9 +127,9 @@
* Hide the object's state in the object store. Used by crash
* recovery.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -139,9 +139,9 @@
/**
* Reveal a hidden object's state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -151,20 +151,20 @@
/**
* Read the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return the state of the object.
*/
public abstract InputObjectState read_committed (Uid u, String tn) throws ObjectStoreException;
-
+
/**
* Read the object's shadowed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return the state of the object.
*/
@@ -173,9 +173,9 @@
/**
* Remove the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -185,9 +185,9 @@
/**
* Remove the object's uncommitted state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -197,10 +197,10 @@
/**
* Write a new copy of the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- * @param OutputObjectState buff The state to write.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ * @param buff The state to write.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -210,10 +210,10 @@
/**
* Write a copy of the object's uncommitted state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- * @param OutputObjectState buff The state to write.
- *
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ * @param buff The state to write.
+ *
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -229,9 +229,9 @@
public void sync () throws java.io.SyncFailedException, ObjectStoreException
{
}
-
+
/**
- * @param String localOSRoot the root of the store.
+ * @param localOSRoot the root of the store.
*
* @return the full path of the store. localOSRoot is always a relative
* name. NOTE this path always ends in a /
@@ -250,7 +250,7 @@
if (_objectStoreDir == null || _objectStoreDir.length() == 0)
throw new ObjectStoreException(Environment.OBJECTSTORE_DIR+" not set.");
-
+
if (!_objectStoreDir.endsWith(File.separator))
_objectStoreDir = _objectStoreDir + File.separator;
@@ -258,12 +258,12 @@
* We use the classname of the object store implementation to
* specify the directory for the object store.
*/
-
+
_objectStoreDir = _objectStoreDir + className().stringForm();
}
String toReturn = null;
-
+
if ((localOSRoot == null) || (localOSRoot.length() == 0))
{
if ((_objectStoreRoot != null) && (_objectStoreRoot.length() > 0))
@@ -271,16 +271,16 @@
else
localOSRoot = "defaultStore"+File.separator;
}
-
+
if ((localOSRoot != null) && (localOSRoot.length() > 0))
toReturn = _objectStoreDir + File.separator+localOSRoot;
if (!toReturn.endsWith(File.separator))
toReturn = toReturn + File.separator;
-
+
return toReturn;
}
-
+
/**
* Does this store need to do the full write_uncommitted/commit protocol?
*
@@ -297,9 +297,9 @@
* Is the current state of the object the same as that provided as the last
* parameter?
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object.
- * @param int st The expected type of the object.
+ * @param u The object to work on.
+ * @param tn The type of the object.
+ * @param st The expected type of the object.
*
* @return <code>true</code> if the current state is as expected,
* <code>false</code> otherwise.
@@ -345,27 +345,27 @@
{
return shareStatus;
}
-
+
public final String storeDir ()
{
return _objectStoreDir;
}
-
+
public final String storeRoot ()
{
return _objectStoreRoot;
}
-
+
public static ClassName name ()
{
return ObjectStoreImple._className;
}
-
+
protected ObjectStoreImple ()
{
this(ObjectStore.OS_UNSHARED);
}
-
+
protected ObjectStoreImple (int ss)
{
shareStatus = ss;
@@ -375,7 +375,7 @@
{
parseObjectName(objName);
}
-
+
/**
* Suppress directories of the specified type from
* allTypes etc?
@@ -433,7 +433,7 @@
private String _objectStoreRoot = null;
private String _objectStoreDir = null;
-
+
private static final ClassName _className = new ClassName("ObjectStoreImple");
-
+
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/jdbc/JDBCAccess.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/jdbc/JDBCAccess.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/objectstore/jdbc/JDBCAccess.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -24,7 +24,7 @@
* Arjuna Solutions Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
- * UK.
+ * UK.
*
* $Id: JDBCAccess.java 2342 2006-03-30 13:06:17Z $
*/
@@ -56,13 +56,13 @@
*/
public Connection getConnection () throws SQLException;
-
+
/**
- * @called from the object store when a connection is no longer used.
+ * Called from the object store when a connection is no longer used.
*/
public void putConnection (Connection conn);
-
+
/**
* @return the name of the table to use for storing the state.
* @deprecated
@@ -84,5 +84,5 @@
*/
public void initialise (ObjectName objName);
-
+
}
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/RecoveryManager.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/RecoveryManager.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/RecoveryManager.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -106,7 +106,7 @@
* been created yet then it will be. The manager will be created in the
* INDIRECT_MANAGEMENT mode.
*
- * @throw IllegalArgumentException thrown if the manager has already been
+ * @throws IllegalArgumentException thrown if the manager has already been
* created in a different mode to that requested.
*
* @return the manager.
@@ -124,7 +124,7 @@
*
* @param mode the management mode for the manager.
*
- * @throw IllegalArgumentException thrown if the manager has already been
+ * @throws IllegalArgumentException thrown if the manager has already been
* created in a different mode to that requested.
*
* @return the manager.
@@ -154,14 +154,14 @@
/**
* Force a recovery scan now. This is a blocking operation
* and will only return once the recovery scan has completed.
- *
+ *
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
public final void scan ()
{
checkState();
-
+
_theImple.scan();
}
@@ -173,14 +173,14 @@
* @param callback callback The callback mechanism used to
* inform users that the scan has completed. If this is <code>null</code>
* then no callback will happen and asynchronous scanning will occur.
- *
+ *
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
public final void scan (RecoveryScan callback)
{
checkState();
-
+
ScanThread st = new ScanThread(_theImple, callback);
st.start();
@@ -188,9 +188,9 @@
/**
* Stop the periodic recovery manager waiting for any recovery scan in progress to complete.
- *
+ *
* @throws IllegalStateException if the recovery manager has been shutdown.
- *
+ *
* @deprecated use terminate instead.
*/
@@ -203,51 +203,51 @@
* Stop the periodic recovery manager.
* @param async false means wait for any recovery scan in progress to complete.
* @throws IllegalStateException if the recovery manager has been shutdown.
- *
+ *
* @deprecated use terminate instead.
*/
public final void stop (boolean async)
{
checkState();
-
+
_theImple.stop(async);
}
-
+
/**
* Terminate and cleanup the recovery manager. There is no going back from this. This is a
* synchronous operation so return means that the recovery has completed.
- *
+ *
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
-
+
public final void terminate ()
{
terminate(false);
}
-
+
/**
* Terminate and cleanup the recovery manager. There is no going back from this. Can be called
* synchronous or asynchronously. If you have any intention of restarting the recovery manager
* later then you MUST use the async=false option.
- *
+ *
* @param async false means wait for any recovery scan in progress to complete.
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
-
+
public final synchronized void terminate (boolean async)
{
checkState();
-
+
_theImple.stop(async);
_theImple = null;
}
-
+
/**
* If the recovery manager has been shutdown previously then recreate it in
* the same mode as before. Otherwise ignore.
*/
-
+
public final synchronized void initialize ()
{
if (_theImple == null)
@@ -258,21 +258,21 @@
_theImple = new RecoveryManagerImple(false);
}
}
-
+
// does nothing when running embedded.
-
+
/**
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
-
+
public void waitForTermination ()
{
checkState();
-
+
_theImple.waitForTermination();
_theImple = null;
}
-
+
/**
* Suspend the recovery manager. If the recovery manager is in the process of
* doing recovery scans then it will be suspended afterwards, in order to
@@ -296,19 +296,19 @@
* @param async false means wait for the recovery manager to finish any scans before returning.
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
-
+
public void suspend (boolean async)
{
checkState();
-
+
_theImple.suspendScan(async);
}
-
+
/**
* @throws IllegalStateException if the recovery manager has been shutdown.
* @deprecated use resume
*/
-
+
public void resumeScan ()
{
resume();
@@ -317,23 +317,23 @@
/**
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
-
+
public void resume ()
{
checkState();
-
+
_theImple.resumeScan();
}
-
+
/**
* Start the recovery manager thread.
- *
+ *
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
public void startRecoveryManagerThread()
{
checkState();
-
+
_theImple.start() ;
}
@@ -347,7 +347,7 @@
public final void addModule (RecoveryModule module)
{
checkState();
-
+
_theImple.addModule(module);
}
@@ -362,13 +362,13 @@
public final void removeModule (RecoveryModule module, boolean waitOnScan)
{
checkState();
-
+
_theImple.removeModule(module, waitOnScan);
}
/**
* Obtain a snapshot list of available recovery modules.
- *
+ *
* @return a snapshot list of the currently installed recovery modules
* @throws IllegalStateException if the recovery manager has been shutdown.
*/
@@ -376,7 +376,7 @@
public final Vector getModules ()
{
checkState();
-
+
return _theImple.getModules();
}
@@ -534,7 +534,7 @@
_mode = mode;
}
-
+
private final void checkState ()
{
if (_theImple == null)
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/TransactionStatusConnectionManager.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/TransactionStatusConnectionManager.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/recovery/TransactionStatusConnectionManager.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -28,7 +28,7 @@
*
* $Id: TransactionStatusConnectionManager.java 2342 2006-03-30 13:06:17Z $
*/
-
+
package com.arjuna.ats.arjuna.recovery ;
import java.util.* ;
@@ -50,7 +50,7 @@
/**
* @message com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_1 [com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_1] - Exception when accessing data store {0}
* @message com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_2 [com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_2] - Object store exception {0}
- * @message com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_3 [com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_3] - found process uid {0}
+ * @message com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_3 [com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_3] - found process uid {0}
* @message com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_4 [com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_4] - added TransactionStatusConnector to table for process uid {0}
*/
@@ -68,7 +68,7 @@
updateTSMI() ;
}
-
+
/**
* Obtain the transaction status for the specified transaction.
* At this point we don't know the type of the transaction, only it's
@@ -82,9 +82,9 @@
public int getTransactionStatus( Uid tranUid )
{
String transactionType = "" ;
-
+
int status = getTransactionStatus( transactionType, tranUid );
-
+
return status ;
}
@@ -140,10 +140,10 @@
/**
* Use the TransactionStatusConnector to remotly query a transaction manager to get the tx status.
*
- * @param process_id
- * @param transactionType
- * @param tranUid
- * @return
+ * @param process_id the process identifier
+ * @param transactionType the type of the transaction
+ * @param tranUid the Uid of the transaction
+ * @return the remote transaction status
*/
private int getRemoteTransactionStatus(String process_id, String transactionType, Uid tranUid ) {
@@ -179,7 +179,7 @@
return status;
}
-
+
/**
* Examine the Object Store for any new TrasactionStatusManagerItem
* objects, and add to local hash table.
@@ -188,10 +188,10 @@
public void updateTSMI()
{
boolean tsmis = false ;
-
+
InputObjectState uids = new InputObjectState() ;
Vector tsmiVector = new Vector() ;
-
+
try
{
tsmis = _objStore.allObjUids( _typeName, uids ) ;
@@ -203,22 +203,22 @@
tsLogger.arjLoggerI18N.warn("com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_2", new Object[]{ex});
}
}
-
+
// cycle through each item, and update tsmTable with any
// new TransactionStatusManagerItems
if ( tsmis )
{
Uid theUid = new Uid(Uid.nullUid()) ;
-
+
boolean moreUids = true ;
-
+
while (moreUids)
{
try
{
theUid.unpack( uids ) ;
-
+
if ( theUid.equals( Uid.nullUid() ) )
{
moreUids = false ;
@@ -229,9 +229,9 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
- tsLogger.arjLoggerI18N.debug( DebugLevel.FUNCTIONS,
+ tsLogger.arjLoggerI18N.debug( DebugLevel.FUNCTIONS,
VisibilityLevel.VIS_PUBLIC,
- FacilityCode.FAC_CRASH_RECOVERY,
+ FacilityCode.FAC_CRASH_RECOVERY,
"com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_3", new Object[]{newUid});
}
tsmiVector.addElement(newUid) ;
@@ -243,21 +243,21 @@
}
}
}
-
+
// for each TransactionStatusManager found, if their is
// not an entry in the local hash table for it then add it.
Enumeration tsmiEnum = tsmiVector.elements() ;
-
+
while ( tsmiEnum.hasMoreElements() )
{
Uid currentUid = (Uid) tsmiEnum.nextElement() ;
-
+
String process_id = get_process_id( currentUid ) ;
-
+
if ( ! _tscTable.containsKey( process_id ) )
{
TransactionStatusConnector tsc = new TransactionStatusConnector ( process_id, currentUid ) ;
-
+
if ( tsc.isDead() )
{
tsc.delete() ;
@@ -271,13 +271,13 @@
if (tsLogger.arjLoggerI18N.debugAllowed())
{
tsLogger.arjLoggerI18N.debug(DebugLevel.FUNCTIONS, VisibilityLevel.VIS_PUBLIC,
- FacilityCode.FAC_CRASH_RECOVERY,
+ FacilityCode.FAC_CRASH_RECOVERY,
"com.arjuna.ats.arjuna.recovery.TransactionStatusConnectionManager_4", new Object[]{process_id});
}
}
}
}
-
+
/**
* Extract the process identifier from the supplied Uid.
*/
@@ -289,24 +289,24 @@
StringTokenizer st = new StringTokenizer( strUid, ":" ) ;
st.nextToken() ;
String process_id_in_Hex = st.nextToken() ;
-
+
return process_id_in_Hex ;
}
-
+
// Type within ObjectStore.
private static String _typeName = TransactionStatusManagerItem.typeName() ;
-
+
// Table of process ids and their transaction status managers items.
private Hashtable _tscTable = new Hashtable() ;
-
+
// Reference to object store.
private static ObjectStore _objStore = null ;
-
+
private static Uid _localUid = new Uid();
}
-
+
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/utils/Utility.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/utils/Utility.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/utils/Utility.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -45,7 +45,7 @@
* Various useful functions that we wrap in a single class. Some of these
* functions are needed simply for backwards compatibility with older versions
* of Java.
- *
+ *
* @author Mark Little (mark at arjuna.com)
* @version $Id: Utility.java 2342 2006-03-30 13:06:17Z $
* @since JTS 1.0.
@@ -199,7 +199,7 @@
/**
* Convert a host name into an InetAddress object
- *
+ *
* @param host
* if empty or null then the loopback address is used
* @param messageKey
@@ -229,13 +229,13 @@
/**
* Lookup and valid a port number.
- *
+ *
* @param intProperty
* property name of an integer valued property
* @param defValue
* a value to return if intProperty is invalid. If a null value
* is used and intProperty is invalid then
- * @com.arjuna.ats.arjuna.exceptions.FatalError is thrown
+ * @see com.arjuna.ats.arjuna.exceptions.FatalError is thrown
* @param warnMsgKey
* message key to report a warning if property values is invalid
* @param minValue
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/coordinator/ReaperElement.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/coordinator/ReaperElement.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/coordinator/ReaperElement.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -74,8 +74,8 @@
* This is required so that the set maintained by the TransactionReaper
* is in timeout order for efficient processing.
*
- * @param o
- * @return
+ * @param o the Object to compare
+ * @return 0 if equal, 1 if this is greater, -1 if this is smaller
*/
public int compareTo(Object o)
{
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/JDBCStore.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/JDBCStore.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/JDBCStore.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -459,8 +459,7 @@
/**
* Set the JDBC access class name.
*
- * @param The
- * access class name.
+ * @param jdbcAccessClassName access class name.
*/
protected void setAccessClassName(String jdbcAccessClassName)
{
@@ -480,8 +479,7 @@
/**
* Get the JDBC access class name from an object.
*
- * @param The
- * object name.
+ * @param objName the object name.
* @return The access class name.
*/
protected String getAccessClassNameFromObject(ObjectName objName)
@@ -493,8 +491,7 @@
/**
* Get the JDBC table name from an object.
*
- * @param The
- * object name.
+ * @param objName the object name.
* @return The table name.
*/
protected String getTableNameFromObject(ObjectName objName)
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/VolatileStore.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/VolatileStore.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/objectstore/VolatileStore.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -61,9 +61,9 @@
/**
* Obtain all of the Uids for a specified type.
*
- * @param String s The type to scan for.
- * @param InputObjectState buff The object state in which to store the Uids
- * @param int m The file type to look for (e.g., committed, shadowed).
+ * @param s The type to scan for.
+ * @param buff The object state in which to store the Uids
+ * @param m The file type to look for (e.g., committed, shadowed).
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -76,7 +76,7 @@
/**
* Obtain all types of objects stored in the object store.
*
- * @param InputObjectState buff The state in which to store the types.
+ * @param buff The state in which to store the types.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -87,8 +87,8 @@
}
/**
- * @param Uid u The object to query.
- * @param String tn The type of the object to query.
+ * @param u The object to query.
+ * @param tn The type of the object to query.
* @return the current state of the object's state (e.g., shadowed,
* committed ...)
*/
@@ -117,8 +117,8 @@
/**
* Commit the object's state in the object store.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -132,8 +132,8 @@
* Hide the object's state in the object store. Used by crash
* recovery.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -146,8 +146,8 @@
/**
* Reveal a hidden object's state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -160,8 +160,8 @@
/**
* Read the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return the state of the object.
*/
@@ -180,8 +180,8 @@
/**
* Read the object's shadowed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return the state of the object.
*/
@@ -193,8 +193,8 @@
/**
* Remove the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -214,8 +214,8 @@
/**
* Remove the object's uncommitted state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -228,9 +228,9 @@
/**
* Write a new copy of the object's committed state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- * @param OutputObjectState buff The state to write.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ * @param buff The state to write.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
@@ -250,9 +250,9 @@
/**
* Write a copy of the object's uncommitted state.
*
- * @param Uid u The object to work on.
- * @param String tn The type of the object to work on.
- * @param OutputObjectState buff The state to write.
+ * @param u The object to work on.
+ * @param tn The type of the object to work on.
+ * @param buff The state to write.
* @return <code>true</code> if no errors occurred, <code>false</code>
* otherwise.
*/
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/recovery/PeriodicRecovery.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/recovery/PeriodicRecovery.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/internal/arjuna/recovery/PeriodicRecovery.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -448,7 +448,7 @@
/**
* Perform a recovery scan on all registered modules.
*
- * @caveats if a scan is already in progress this method will wait for it to complete otherwise it will
+ * <b>Caveats:</b> if a scan is already in progress this method will wait for it to complete otherwise it will
* perform its own scan before returning. If scanning is suspended this will require waiting for scanning
* to resume.
*/
@@ -611,7 +611,7 @@
/**
* fetch the current activity status either INACTIVE or SCANNING
*
- * @caveats must only be called while synchronized on {@link PeriodicRecovery#_stateLock}
+ * <b>Caveats:</b> must only be called while synchronized on {@link PeriodicRecovery#_stateLock}
* @return INACTIVE if no scan is in progress or SCANNING if some thread is performing a scan
*/
private int getStatus ()
@@ -622,7 +622,7 @@
/**
* fetch the current recovery operation mode either ENABLED, SUSPENDED or TERMINATED
*
- * @caveats must only be called while synchronized on {@link PeriodicRecovery#_stateLock}
+ * <b>Caveats:</b> must only be called while synchronized on {@link PeriodicRecovery#_stateLock}
* @return the current recovery operation mode
*/
private int getMode ()
@@ -651,7 +651,7 @@
/**
* wait for the required backoff period or less if the scanning status or scan mode changes
*
- * @caveats this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
+ * <b>Caveats:</b> this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
* _currentStatus is SCANNING and _currentMode is ENABLED
*/
private void doBackoffWait()
@@ -666,7 +666,7 @@
/**
* wait for the required recovery period or less if the scanning status or scan mode changes
*
- * @caveats this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
+ * <b>Caveats:</b> this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
* _currentStatus is INACTIVE and _currentMode is ENABLED
*/
private void doPeriodicWait()
@@ -681,7 +681,7 @@
/**
* wait until the we move out of SUSPENDED mode
*
- * @caveats this must only be called when synchronized on {@link PeriodicRecovery#_stateLock}
+ * <b>Caveats:</b> this must only be called when synchronized on {@link PeriodicRecovery#_stateLock}
*/
private void doSuspendedWait()
{
@@ -697,7 +697,7 @@
/**
* wait until some other thread stops scanning
*
- * @caveats this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
+ * <b>Caveats:</b> this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} and when
* _currentStatus is SCANNING
*/
private void doScanningWait()
@@ -714,7 +714,7 @@
/**
* start performing a scan continuing to completion unless we are terminating
*
- * @caveats this must only be called when _currentStatus is SCANNING. on return _currentStatus is always
+ * <b>Caveats:</b> this must only be called when _currentStatus is SCANNING. on return _currentStatus is always
* still SCANNING
*/
@@ -813,7 +813,7 @@
/**
* notify the listener worker that a scan has completed
*
- * @caveats this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} at the point
+ * <b>Caveats:</b> this must only be called when synchronized on {@link PeriodicRecovery#_stateLock} at the point
* where Status transitions from SCANNING to INACTIVE
*/
Modified: labs/jbosstm/trunk/ArjunaCore/tsmx/classes/com/arjuna/ats/internal/tsmx/mbeans/PropertyServiceMBeanWrapper.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/tsmx/classes/com/arjuna/ats/internal/tsmx/mbeans/PropertyServiceMBeanWrapper.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaCore/tsmx/classes/com/arjuna/ats/internal/tsmx/mbeans/PropertyServiceMBeanWrapper.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -333,7 +333,7 @@
/**
* Get the object name for this MBean
- * @return
+ * @return the ObjectName
* @throws MalformedObjectNameException
*/
public ObjectName getObjectName() throws MalformedObjectNameException
Modified: labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/recovery/XAResourceRecovery.java
===================================================================
--- labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/recovery/XAResourceRecovery.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/recovery/XAResourceRecovery.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -59,7 +59,7 @@
/**
* Initialise with all properties required to create the resource(s).
*
- * @param String p An arbitrary string from which initialization data
+ * @param p An arbitrary string from which initialization data
* is obtained.
*
* @return <code>true</code> if initialization happened successfully,
@@ -75,8 +75,8 @@
* @return <code>true</code> if this instance can provide more
* resources, <code>false</code> otherwise.
*/
-
+
public boolean hasMoreResources ();
-
+
}
Modified: labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/utils/XAHelper.java
===================================================================
--- labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/utils/XAHelper.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/jta/utils/XAHelper.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -114,10 +114,8 @@
/**
* Compares two Xid instances.
*
- * @param Xid
- * x1 first Xid
- * @param Xid
- * x2 second Xid
+ * @param x1 first Xid
+ * @param x2 second Xid
*
* @return <code>true</code> if the two instances are the same,
* <code>false</code> otherwise.
@@ -171,10 +169,8 @@
/**
* Compares two Xid instances at the gtid level only.
*
- * @param Xid
- * x1 first Xid
- * @param Xid
- * x2 second Xid
+ * @param x1 first Xid
+ * @param x2 second Xid
*
* @return <code>true</code> if the two instances are the same,
* <code>false</code> otherwise.
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/AbstractLogImpl.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/AbstractLogImpl.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/AbstractLogImpl.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -39,10 +39,8 @@
/**
* Abstract implementation of the Log interface.
*
- * Abstract superclass for {@link LogImpl LogImpl (without i18n support)}
- * and the {@link Logi18nImpl Logi18nImpl (built-in i18n support if the logger
- * does not provide this}. This contains the functionality common to both,
- * essentially support for finer-grained logging and guards (e.g.,
+ * Abstract superclass for {@link LogImpl LogImpl}
+ * This contains the support for finer-grained logging and guards (e.g.,
* isWarnEnabled(), etc.).
*
* @author Thomas Rischbeck <thomas.rischbeck at arjuna.com>
@@ -64,7 +62,7 @@
*
* Note that there is a performance issue when more than one resource bundles is in use.
*
- * @see #m_defaultResourceBundle.
+ * @see #m_defaultResourceBundle
*/
private ResourceBundle[] m_extraResourceBundles = null;
@@ -93,7 +91,7 @@
/**
* constructor
*
- * @param logInterface
+ * @param logInterface the AbstractLogInterface
*/
public AbstractLogImpl(AbstractLogInterface logInterface)
{
@@ -103,7 +101,7 @@
/**
* constructor
*
- * @param logInterface
+ * @param logInterface the AbstractLogInterface
* @param resBundle bundle used for this logger (if a resource bundle is used per logger)
*/
public AbstractLogImpl(AbstractLogInterface logInterface, String resBundle)
@@ -676,7 +674,7 @@
/**
*
* @param key
- * @return
+ * @return the resource bundle String
* @throws MissingResourceException
*/
protected synchronized String getResourceBundleString(String key) throws MissingResourceException
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/DefaultLog.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/DefaultLog.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/logging/DefaultLog.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -269,6 +269,7 @@
/**
* <p> Get logging level. </p>
+ * @return the current logging level
*/
public int getLevel() {
@@ -363,6 +364,7 @@
* Is the given log level currently enabled?
*
* @param logLevel is this level enabled?
+ * @return true is enabled, false otherwise
*/
protected boolean isLevelEnabled(int logLevel) {
// log level are numerically ordered so can use simple numeric
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/propertyservice/PropertyManagerImpl.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/propertyservice/PropertyManagerImpl.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/internal/util/propertyservice/PropertyManagerImpl.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -94,7 +94,7 @@
/**
* Retrieve the name of this property manager
- * @return
+ * @return the property manager name
*/
public String getName()
{
@@ -103,7 +103,7 @@
/**
* Retrieves the URI associated with this property manager
- * @return
+ * @return the URI
*/
public String getUri()
{
@@ -112,7 +112,7 @@
/**
* Set the URI associated with this property manager
- * @param uri
+ * @param uri the URI
*/
public void setUri(String uri)
{
@@ -149,8 +149,8 @@
/**
* Get the property from the sub-tree without checking the system
* properties.
- * @param name
- * @return
+ * @param name the property name
+ * @return the property value
*/
private String getPropertyFromSubTree(String name)
{
@@ -204,7 +204,7 @@
* @param name The name of the property to set.
* @param value The value of the property being set.
* @param setSystemProperty True - set the system property if it has a value
- * @return
+ * @return the previous value of the property
*/
public String setProperty(String name, String value, boolean setSystemProperty)
{
@@ -227,7 +227,7 @@
/**
* Removes the property from the property manager.
* @param name The name of the property to remove.
- * @return
+ * @return previous value of the property
*/
public String removeProperty(String name)
{
@@ -284,7 +284,7 @@
/**
* Get the properties stored in this property manager only.
- * @return
+ * @return the Properties
*/
public Properties getLocalProperties()
{
@@ -295,7 +295,7 @@
* Get all the properties stored in this property manager and it's parents.
* It also includes the system properties.
*
- * @return
+ * @return the Properties
*/
public Properties getProperties()
{
@@ -311,7 +311,7 @@
* in this property manager and it's parents. But it does not include
* the properties stored in system.
*
- * @return
+ * @return the Properties
*/
public Properties getAllProperties()
{
@@ -331,7 +331,7 @@
/**
* Returns an enumeration of the property names
- * @return
+ * @return the enumeration
*/
public Enumeration propertyNames()
{
@@ -444,8 +444,8 @@
/**
* This method creates a property manager with the name <code>moduleName</code>.
- * @param modulename
- * @return
+ * @param modulename the name of the module
+ * @return the PropertyManagerPluginInterface
*/
public PropertyManagerPluginInterface createPropertyManager(String modulename)
{
@@ -454,7 +454,7 @@
/**
* This method returns an array of parents to the property manager.
- * @return
+ * @return a PropertyManagerPluginInterface[]
*/
public PropertyManagerPluginInterface[] getParents()
{
@@ -465,7 +465,7 @@
/**
* This method returns an array of the children of the current property manager.
- * @return
+ * @return a PropertyManagerPluginInterface[]
*/
public PropertyManagerPluginInterface[] getChildren()
{
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyManager.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyManager.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyManager.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -65,7 +65,7 @@
* @param name The name of the property to set.
* @param value The value of the property being set.
* @param setSystemProperty True - set the system property if it has a value
- * @return
+ * @return The previous value of the property.
*/
public String setProperty(String name, String value, boolean setSystemProperty);
@@ -73,27 +73,27 @@
* Set the value of the property <code>name</code> to <code>value</code>
* @param name The name of the property to set.
* @param value The value of the property to set.
- * @return
+ * @return The previous value of the property.
*/
public String setProperty(String name, String value);
/**
* Removes the property from the property manager.
* @param name The name of the property to remove.
- * @return
+ * @return The previous value of the property.
*/
public String removeProperty(String name);
/**
* Get all the properties stored in this property manager
*
- * @return
+ * @return the Properties
*/
public Properties getProperties();
/**
* Returns an enumeration of the property names
- * @return
+ * @return the Enumeration
*/
public Enumeration propertyNames();
@@ -134,7 +134,7 @@
/**
* Returns true if the property manager is in verbose mode
- * @return
+ * @return true if verbose, false otherwise
*/
public boolean verbose();
}
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyServiceImple.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyServiceImple.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/PropertyServiceImple.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -65,10 +65,7 @@
/**
* Read in the properties file, if present.
*
- * @param force if this is <code>true</code> the property files will
- * be resourced, i.e., properties will be re-loaded.
*/
-
public void loadProperties () throws SecurityException, IOException;
/**
Modified: labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/propertycontainer/PropertyManagerPluginInterface.java
===================================================================
--- labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/propertycontainer/PropertyManagerPluginInterface.java 2009-05-29 06:33:32 UTC (rev 26768)
+++ labs/jbosstm/trunk/common/classes/com/arjuna/common/util/propertyservice/propertycontainer/PropertyManagerPluginInterface.java 2009-05-29 08:37:35 UTC (rev 26769)
@@ -1,20 +1,20 @@
/*
* JBoss, Home of Professional Open Source
- * Copyright 2006, Red Hat Middleware LLC, and individual contributors
- * as indicated by the @author tags.
+ * Copyright 2006, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags.
* See the copyright.txt in the distribution for a
- * full listing of individual contributors.
+ * full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
- * This program is distributed in the hope that it will be useful, but WITHOUT A
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
- *
+ *
* (C) 2005-2006,
* @author JBoss Inc.
*/
@@ -41,14 +41,14 @@
/**
* Get the top-level property manager for this property manager
- * @return
+ * @return the PropertyManagerPluginInterface
*/
public PropertyManagerPluginInterface getTopLevelPropertyManager();
/**
* This method creates a property manager with the name <code>moduleName</code>.
* @param modulename
- * @return
+ * @return the PropertyManagerPluginInterface
*/
public PropertyManagerPluginInterface createPropertyManager(String modulename);
@@ -65,51 +65,51 @@
/**
* This method returns an array of parents to the property manager.
- * @return
+ * @return a PropertyManagerPluginInterface[]
*/
public PropertyManagerPluginInterface[] getParents();
/**
* This method returns an array of the children of the current property manager.
- * @return
+ * @return a PropertyManagerPluginInterface[]
*/
public PropertyManagerPluginInterface[] getChildren();
/**
* Get the child module.
*
- * @param moduleName
- * @return
+ * @param moduleName the name of the module
+ * @return the PropertyManagerPluginInterface
*/
public PropertyManagerPluginInterface getChild(String moduleName);
/**
* Get the properties stored in this property manager only.
- * @return
+ * @return the properties
*/
public Properties getLocalProperties();
/**
* Retrieves the URI associated with this property manager
- * @return
+ * @return the URI
*/
public String getUri();
/**
* Set the URI associated with this property manager
- * @param uri
+ * @param uri the URI
*/
public void setUri(String uri);
/**
* Get the IO plugin classname associated with this property manager.
- * @return
+ * @return the plugin classname
*/
public String getIOPluginClassname();
/**
* Set the IO plugin classname associated with this property manager.
- * @param classname
+ * @param classname the plugin classname
*/
public void setIOPluginClassname(String classname);
}
More information about the jboss-svn-commits
mailing list