You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@oozie.apache.org by km...@apache.org on 2019/03/04 13:27:15 UTC
[oozie] branch master updated: OOZIE-1702 [build] Fix Javadoc
warnings (dionusos via kmarton)
This is an automated email from the ASF dual-hosted git repository.
kmarton pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/oozie.git
The following commit(s) were added to refs/heads/master by this push:
new 76143a1 OOZIE-1702 [build] Fix Javadoc warnings (dionusos via kmarton)
76143a1 is described below
commit 76143a11ac765d786644e49c34f760c89a364d88
Author: Julia Kinga Marton <km...@apache.org>
AuthorDate: Mon Mar 4 14:27:03 2019 +0100
OOZIE-1702 [build] Fix Javadoc warnings (dionusos via kmarton)
---
.../org/apache/oozie/action/ActionExecutor.java | 6 +-
.../action/hadoop/CredentialsProviderFactory.java | 6 +-
.../oozie/action/hadoop/DistcpActionExecutor.java | 2 +-
.../oozie/action/hadoop/FsActionExecutor.java | 70 ++++++++---------
.../apache/oozie/action/hadoop/FsELFunctions.java | 16 ++--
.../oozie/action/hadoop/HCatCredentialHelper.java | 12 +--
.../oozie/action/hadoop/Hive2ActionExecutor.java | 2 +-
.../oozie/action/hadoop/HiveActionExecutor.java | 2 +-
.../oozie/action/hadoop/JavaActionExecutor.java | 32 ++++----
.../apache/oozie/action/hadoop/LauncherHelper.java | 31 +++-----
.../action/hadoop/MapReduceActionExecutor.java | 2 +-
.../apache/oozie/action/hadoop/OozieJobInfo.java | 2 +-
.../oozie/action/hadoop/PigActionExecutor.java | 2 +-
.../oozie/action/hadoop/ShellActionExecutor.java | 22 +++---
.../oozie/action/hadoop/SparkActionExecutor.java | 2 +-
.../oozie/action/hadoop/SqoopActionExecutor.java | 4 +-
.../apache/oozie/action/ssh/SshActionExecutor.java | 10 +--
.../oozie/command/RerunTransitionXCommand.java | 2 +-
.../oozie/command/ResumeTransitionXCommand.java | 2 +-
.../oozie/command/SuspendTransitionXCommand.java | 2 +-
.../apache/oozie/command/TransitionXCommand.java | 16 ++--
.../java/org/apache/oozie/command/XCommand.java | 9 ++-
.../oozie/command/coord/BulkCoordXCommand.java | 1 +
.../coord/CoordActionInputCheckXCommand.java | 4 +
.../command/coord/CoordActionsKillXCommand.java | 2 +-
.../oozie/command/coord/CoordCommandUtils.java | 87 +++++++++++-----------
.../oozie/command/coord/CoordJobXCommand.java | 2 +-
.../coord/CoordMaterializeTransitionXCommand.java | 1 +
.../oozie/command/coord/CoordSubmitXCommand.java | 2 +
.../oozie/command/coord/SLAEventsXCommand.java | 2 +-
.../oozie/command/sla/SLAJobHistoryXCommand.java | 2 +
.../oozie/command/wf/ActionStartXCommand.java | 4 +-
.../apache/oozie/command/wf/ActionXCommand.java | 44 +++++++----
.../oozie/command/wf/BulkWorkflowXCommand.java | 1 +
.../org/apache/oozie/command/wf/ReRunXCommand.java | 4 +-
.../apache/oozie/command/wf/SubmitXCommand.java | 2 +-
.../apache/oozie/command/wf/SuspendXCommand.java | 1 +
.../apache/oozie/command/wf/WorkflowXCommand.java | 2 +-
.../org/apache/oozie/coord/CoordELEvaluator.java | 10 +--
.../org/apache/oozie/coord/CoordELFunctions.java | 62 +++++++--------
.../java/org/apache/oozie/coord/CoordUtils.java | 14 ++--
.../org/apache/oozie/coord/HCatELFunctions.java | 30 +++++---
.../input/logic/CoordInputLogicEvaluatorUtil.java | 2 +-
.../apache/oozie/dependency/DependencyChecker.java | 4 +-
.../org/apache/oozie/dependency/URIHandler.java | 20 ++---
.../java/org/apache/oozie/event/EventQueue.java | 4 +-
.../oozie/event/listener/JobEventListener.java | 12 +--
.../oozie/executor/jpa/BinaryBlobValueHandler.java | 2 +
.../executor/jpa/BundleJobsDeleteJPAExecutor.java | 4 +-
.../executor/jpa/CoordActionRemoveJPAExecutor.java | 2 +-
.../jpa/CoordActionsDeleteJPAExecutor.java | 4 +-
.../executor/jpa/CoordJobsDeleteJPAExecutor.java | 4 +-
.../jpa/CoordJobsToBeMaterializedJPAExecutor.java | 4 +-
.../oozie/executor/jpa/StringBlobValueHandler.java | 2 +
.../jpa/WorkflowActionDeleteJPAExecutor.java | 2 +-
.../WorkflowActionRetryManualGetJPAExecutor.java | 2 +-
.../jpa/WorkflowActionSubsetGetJPAExecutor.java | 6 +-
...orkflowInfoWithActionsSubsetGetJPAExecutor.java | 6 +-
.../jpa/WorkflowJobsDeleteJPAExecutor.java | 4 +-
.../executor/jpa/WorkflowsJobGetJPAExecutor.java | 6 +-
.../org/apache/oozie/jms/ConnectionContext.java | 33 ++++----
.../org/apache/oozie/jms/JMSExceptionListener.java | 1 +
.../java/org/apache/oozie/local/LocalOozie.java | 1 +
.../apache/oozie/service/AuthorizationService.java | 8 +-
.../apache/oozie/service/CallableQueueService.java | 9 ++-
.../oozie/service/HadoopAccessorService.java | 13 +++-
.../org/apache/oozie/service/JMSTopicService.java | 12 +--
.../java/org/apache/oozie/service/JPAService.java | 7 +-
.../service/MetricsInstrumentationService.java | 2 +-
.../org/apache/oozie/service/ProxyUserService.java | 3 +-
.../org/apache/oozie/service/SLAStoreService.java | 2 +
.../org/apache/oozie/service/SchedulerService.java | 2 +-
.../org/apache/oozie/service/SchemaService.java | 12 +--
.../java/org/apache/oozie/service/Services.java | 1 +
.../org/apache/oozie/service/StoreService.java | 11 +++
.../apache/oozie/service/URIHandlerService.java | 2 +-
.../apache/oozie/service/WorkflowAppService.java | 7 +-
.../apache/oozie/service/WorkflowStoreService.java | 2 +
.../java/org/apache/oozie/service/XLogService.java | 1 -
.../org/apache/oozie/servlet/BaseAdminServlet.java | 1 +
.../org/apache/oozie/servlet/BaseJobServlet.java | 3 +
.../org/apache/oozie/servlet/BaseJobsServlet.java | 46 ++++++------
.../org/apache/oozie/servlet/V0JobsServlet.java | 30 +++-----
.../org/apache/oozie/servlet/V1AdminServlet.java | 3 +-
.../org/apache/oozie/servlet/V1JobServlet.java | 73 +++++++++---------
.../org/apache/oozie/servlet/V1JobsServlet.java | 27 ++++---
.../org/apache/oozie/servlet/V2JobServlet.java | 6 +-
.../java/org/apache/oozie/sla/SLACalcStatus.java | 2 +
.../java/org/apache/oozie/sla/SLACalculator.java | 8 +-
.../java/org/apache/oozie/sla/SLAOperations.java | 4 +-
.../oozie/sla/listener/SLAEventListener.java | 15 ++--
.../java/org/apache/oozie/store/OozieSchema.java | 8 +-
.../main/java/org/apache/oozie/store/SLAStore.java | 6 +-
.../main/java/org/apache/oozie/store/Store.java | 4 +
.../java/org/apache/oozie/store/WorkflowStore.java | 23 +++---
.../java/org/apache/oozie/util/BufferDrainer.java | 2 +-
.../java/org/apache/oozie/util/ConfigUtils.java | 2 +-
.../java/org/apache/oozie/util/StringUtils.java | 1 +
.../java/org/apache/oozie/util/XConfiguration.java | 4 +-
.../oozie/util/db/FailingDBHelperForTest.java | 2 +-
.../org/apache/oozie/util/db/SLADbXOperations.java | 7 +-
.../org/apache/oozie/util/db/SqlStatement.java | 30 +++++---
.../apache/oozie/workflow/WorkflowInstance.java | 2 +
.../oozie/workflow/lite/DBLiteWorkflowLib.java | 16 ++--
.../oozie/workflow/lite/LiteWorkflowAppParser.java | 24 +++---
release-log.txt | 1 +
.../org/apache/oozie/action/hadoop/JavaMain.java | 2 +-
.../oozie/action/hadoop/LauncherURIHandler.java | 4 +-
.../action/hadoop/LauncherURIHandlerFactory.java | 2 +-
.../oozie/action/hadoop/PrepareActionsHandler.java | 2 +-
.../org/apache/oozie/action/hadoop/ShellMain.java | 4 +-
111 files changed, 598 insertions(+), 516 deletions(-)
diff --git a/core/src/main/java/org/apache/oozie/action/ActionExecutor.java b/core/src/main/java/org/apache/oozie/action/ActionExecutor.java
index 1770b97..02af319 100644
--- a/core/src/main/java/org/apache/oozie/action/ActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/ActionExecutor.java
@@ -208,9 +208,9 @@ public abstract class ActionExecutor {
/**
* @return filesystem handle for the application deployment fs.
- * @throws IOException
- * @throws URISyntaxException
- * @throws HadoopAccessorException
+ * @throws IOException if IO error occurs
+ * @throws URISyntaxException if processed uri is not a proper URI
+ * @throws HadoopAccessorException if accessing hadoop fails
*/
FileSystem getAppFileSystem() throws HadoopAccessorException, IOException, URISyntaxException;
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/CredentialsProviderFactory.java b/core/src/main/java/org/apache/oozie/action/hadoop/CredentialsProviderFactory.java
index 095cdd2..e45f58e 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/CredentialsProviderFactory.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/CredentialsProviderFactory.java
@@ -89,9 +89,9 @@ public class CredentialsProviderFactory {
/**
* Create Credential object
*
- * @param type
+ * @param type provider type
* @return Credential object
- * @throws Exception
+ * @throws Exception if provider cannot be created
*/
public CredentialsProvider createCredentialsProvider(String type) throws Exception {
Class<? extends CredentialsProvider> providerClass = providerCache.get(type);
@@ -106,7 +106,7 @@ public class CredentialsProviderFactory {
* tokens via {@link CredentialsProvider} implementations to ensure that the Kerberos credentials are current and won't expire
* too soon.
*
- * @throws IOException
+ * @throws IOException if login fails
*/
public static void ensureKerberosLogin() throws IOException {
LOG.debug("About to relogin from keytab");
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/DistcpActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/DistcpActionExecutor.java
index a64d128..a3daaa7 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/DistcpActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/DistcpActionExecutor.java
@@ -99,7 +99,7 @@ public class DistcpActionExecutor extends JavaActionExecutor{
* Return the sharelib name for the action.
*
* @return returns <code>distcp</code>.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java
index 634d3b8..f68d3a3 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java
@@ -362,11 +362,11 @@ public class FsActionExecutor extends ActionExecutor {
}
/**
- * @param path
- * @param context
- * @param fsConf
+ * @param path file path
+ * @param context executor context
+ * @param fsConf file system configuration
* @return FileSystem
- * @throws HadoopAccessorException
+ * @throws HadoopAccessorException if FS is not accessible
*/
private FileSystem getFileSystemFor(Path path, Context context, XConfiguration fsConf) throws HadoopAccessorException {
String user = context.getWorkflow().getUser();
@@ -380,10 +380,10 @@ public class FsActionExecutor extends ActionExecutor {
}
/**
- * @param path
- * @param user
+ * @param path file path
+ * @param user user
* @return FileSystem
- * @throws HadoopAccessorException
+ * @throws HadoopAccessorException if FS is not accessible
*/
private FileSystem getFileSystemFor(Path path, String user) throws HadoopAccessorException {
HadoopAccessorService has = Services.get().get(HadoopAccessorService.class);
@@ -418,9 +418,9 @@ public class FsActionExecutor extends ActionExecutor {
/**
* Delete path
*
- * @param context
- * @param path
- * @throws ActionExecutorException
+ * @param context executor context
+ * @param path file path
+ * @throws ActionExecutorException if FS error occurs
*/
public void delete(Context context, Path path) throws ActionExecutorException {
delete(context, null, null, path, true);
@@ -429,12 +429,12 @@ public class FsActionExecutor extends ActionExecutor {
/**
* Delete path
*
- * @param context
- * @param fsConf
- * @param nameNodePath
- * @param path
+ * @param context executor context
+ * @param fsConf file system configuration
+ * @param nameNodePath configured name node path
+ * @param path file path
* @param skipTrash flag to skip the trash.
- * @throws ActionExecutorException
+ * @throws ActionExecutorException if FS error occurs
*/
public void delete(Context context, XConfiguration fsConf, Path nameNodePath, Path path, boolean skipTrash)
throws ActionExecutorException {
@@ -494,10 +494,10 @@ public class FsActionExecutor extends ActionExecutor {
/**
* Delete path
*
- * @param user
- * @param group
- * @param path
- * @throws ActionExecutorException
+ * @param user user
+ * @param group group
+ * @param path file path
+ * @throws ActionExecutorException if FS error occurs
*/
public void delete(String user, String group, Path path) throws ActionExecutorException {
try {
@@ -519,11 +519,11 @@ public class FsActionExecutor extends ActionExecutor {
/**
* Move source to target
*
- * @param context
- * @param source
- * @param target
- * @param recovery
- * @throws ActionExecutorException
+ * @param context executor context
+ * @param source source path
+ * @param target target path
+ * @param recovery set to true if in recovery mode
+ * @throws ActionExecutorException if FS error occurs
*/
public void move(Context context, Path source, Path target, boolean recovery) throws ActionExecutorException {
move(context, null, null, source, target, recovery);
@@ -532,13 +532,13 @@ public class FsActionExecutor extends ActionExecutor {
/**
* Move source to target
*
- * @param context
- * @param fsConf
- * @param nameNodePath
- * @param source
- * @param target
- * @param recovery
- * @throws ActionExecutorException
+ * @param context executor context
+ * @param fsConf file system configuration
+ * @param nameNodePath configured name node path
+ * @param source source path
+ * @param target target path
+ * @param recovery set to true if in recovery mode
+ * @throws ActionExecutorException if FS error occurs
*/
public void move(Context context, XConfiguration fsConf, Path nameNodePath, Path source, Path target, boolean recovery)
throws ActionExecutorException {
@@ -703,11 +703,11 @@ public class FsActionExecutor extends ActionExecutor {
}
/**
- * @param context
+ * @param context executor context
* @return Path returns recovery path
- * @throws HadoopAccessorException
- * @throws IOException
- * @throws URISyntaxException
+ * @throws HadoopAccessorException if accessing file system fails
+ * @throws IOException in case of IO error
+ * @throws URISyntaxException if the processed uri is not a valid URI
*/
public Path getRecoveryPath(Context context) throws HadoopAccessorException, IOException, URISyntaxException {
return new Path(context.getActionDir(), "fs-" + context.getRecoveryId());
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/FsELFunctions.java b/core/src/main/java/org/apache/oozie/action/hadoop/FsELFunctions.java
index 031be25..55be949 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/FsELFunctions.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/FsELFunctions.java
@@ -53,9 +53,9 @@ public class FsELFunctions {
*
* @param pathUri fs path uri
* @return file status
- * @throws URISyntaxException
- * @throws IOException
- * @throws Exception
+ * @throws URISyntaxException if pathUri is not a proper URI
+ * @throws IOException in case of file system issue
+ * @throws Exception in case of file system issue
*/
private static FileStatus getFileStatus(String pathUri) throws Exception {
URI uri = new URI(pathUri);
@@ -70,7 +70,7 @@ public class FsELFunctions {
*
* @param pathUri file system path uri.
* @return <code>true</code> if the path exists, <code>false</code> if it does not.
- * @throws Exception
+ * @throws Exception in case of file system issue
*/
public static boolean fs_exists(String pathUri) throws Exception {
Path path = new Path(pathUri);
@@ -91,7 +91,7 @@ public class FsELFunctions {
*
* @param pathUri fs path uri.
* @return <code>true</code> if the path exists and it is a directory, <code>false</code> otherwise.
- * @throws Exception
+ * @throws Exception in case of file system issue
*/
public static boolean fs_isDir(String pathUri) throws Exception {
boolean isDir = false;
@@ -107,7 +107,7 @@ public class FsELFunctions {
*
* @param pathUri file system path uri.
* @return the file len in bytes, -1 if the file does not exist or if it is a directory.
- * @throws Exception
+ * @throws Exception in case of file system issue
*/
public static long fs_fileSize(String pathUri) throws Exception {
long len = -1;
@@ -123,7 +123,7 @@ public class FsELFunctions {
*
* @param pathUri file system path uri.
* @return the size of all files in the directory, -1 if the directory does not exist or if it is a file.
- * @throws Exception
+ * @throws Exception in case of file system issue
*/
public static long fs_dirSize(String pathUri) throws Exception {
URI uri = new URI(pathUri);
@@ -155,7 +155,7 @@ public class FsELFunctions {
*
* @param pathUri file system path uri.
* @return the block size of the file in bytes, -1 if the file does not exist or if it is a directory.
- * @throws Exception
+ * @throws Exception in case of file system issue
*/
public static long fs_blockSize(String pathUri) throws Exception {
long blockSize = -1;
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java b/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java
index 274db78..cd2c938 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java
@@ -49,7 +49,7 @@ public class HCatCredentialHelper {
* @param launcherConfig - launcher configuration
* @param principal - principal for HCat server
* @param server - Serevr URI for HCat server
- * @throws Exception
+ * @throws Exception in case of HCat client creation or close error
*/
public void set(Credentials credentials, Configuration launcherConfig, String principal, String server) throws Exception {
HCatClient client = null;
@@ -78,11 +78,11 @@ public class HCatCredentialHelper {
/**
* Getting the HCat client.
- * @param launcherConfig
- * @param principal
- * @param server
- * @return HCatClient
- * @throws HCatException
+ * @param launcherConfig - launcher configuration
+ * @param principal - principal for HCat server
+ * @param server - Serevr URI for HCat server
+ * @return HCatClient an HCatClient instance
+ * @throws HCatException if creating client fails
*/
public HCatClient getHCatClient(Configuration launcherConfig,
String principal, String server) throws HCatException {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/Hive2ActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/Hive2ActionExecutor.java
index 0480f06..b30a5ef 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/Hive2ActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/Hive2ActionExecutor.java
@@ -125,7 +125,7 @@ public class Hive2ActionExecutor extends ScriptLanguageActionExecutor {
* Return the sharelib name for the action.
*
* @return returns <code>hive2</code>.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/HiveActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/HiveActionExecutor.java
index f07f431..fe51b5c 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/HiveActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/HiveActionExecutor.java
@@ -115,7 +115,7 @@ public class HiveActionExecutor extends ScriptLanguageActionExecutor {
* Return the sharelib name for the action.
*
* @return returns <code>hive</code>.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java
index 231b38e..0e76a7b 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java
@@ -467,7 +467,7 @@ public class JavaActionExecutor extends ActionExecutor {
/**
* Set root log level property in actionConf
- * @param actionConf
+ * @param actionConf action configuration
*/
void setRootLoggerLevel(Configuration actionConf) {
String oozieActionTypeRootLogger = "oozie.action." + getType() + LauncherAMUtils.ROOT_LOGGER_LEVEL;
@@ -1618,10 +1618,10 @@ public class JavaActionExecutor extends ActionExecutor {
/**
* Create job client object
*
- * @param context
- * @param jobConf
+ * @param context executor context
+ * @param jobConf job configuration
* @return JobClient
- * @throws HadoopAccessorException
+ * @throws HadoopAccessorException if FS is not accessible
*/
protected JobClient createJobClient(Context context, Configuration jobConf) throws HadoopAccessorException {
String user = context.getWorkflow().getUser();
@@ -1631,10 +1631,10 @@ public class JavaActionExecutor extends ActionExecutor {
/**
* Create yarn client object
*
- * @param context
- * @param jobConf
+ * @param context executor context
+ * @param jobConf job configuration
* @return YarnClient
- * @throws HadoopAccessorException
+ * @throws HadoopAccessorException if FS is not accessible
*/
protected YarnClient createYarnClient(Context context, Configuration jobConf) throws HadoopAccessorException {
String user = context.getWorkflow().getUser();
@@ -1645,7 +1645,7 @@ public class JavaActionExecutor extends ActionExecutor {
* Useful for overriding in actions that do subsequent job runs
* such as the MapReduce Action, where the launcher job is not the
* actual job that then gets monitored.
- * @param action
+ * @param action workflow action
* @return external ID.
*/
protected String getActualExternalId(WorkflowAction action) {
@@ -1817,7 +1817,7 @@ public class JavaActionExecutor extends ActionExecutor {
* @param context the execution context
* @param action the workflow action
* @return a {@code String} that depicts the application ID of the launcher ApplicationMaster of this action
- * @throws ActionExecutorException
+ * @throws ActionExecutorException never thrown using current implementation
*/
protected String findYarnApplicationId(final Context context, final WorkflowAction action)
throws ActionExecutorException {
@@ -1830,10 +1830,10 @@ public class JavaActionExecutor extends ActionExecutor {
* @param actionFs the FileSystem object
* @param action the Workflow action
* @param context executor context
- * @throws org.apache.oozie.service.HadoopAccessorException
- * @throws org.jdom.JDOMException
- * @throws java.io.IOException
- * @throws java.net.URISyntaxException
+ * @throws org.apache.oozie.service.HadoopAccessorException if FS is not accessible
+ * @throws org.jdom.JDOMException if XML parsing error occurs
+ * @throws java.io.IOException if IO error occurs
+ * @throws java.net.URISyntaxException if processed uri is not a proper URI
*
*/
protected void getActionData(FileSystem actionFs, WorkflowAction action, Context context)
@@ -1997,9 +1997,9 @@ public class JavaActionExecutor extends ActionExecutor {
*
* @param context executor context
* @param actionFs the FileSystem object
- * @throws java.io.IOException
- * @throws org.apache.oozie.service.HadoopAccessorException
- * @throws java.net.URISyntaxException
+ * @throws java.io.IOException if IO error occurs
+ * @throws org.apache.oozie.service.HadoopAccessorException if FS is not accessible
+ * @throws java.net.URISyntaxException if processed uri is not a proper URI
*/
protected void setActionCompletionData(Context context, FileSystem actionFs) throws IOException,
HadoopAccessorException, URISyntaxException {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/LauncherHelper.java b/core/src/main/java/org/apache/oozie/action/hadoop/LauncherHelper.java
index a71d930..8f98137 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/LauncherHelper.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/LauncherHelper.java
@@ -180,48 +180,35 @@ public class LauncherHelper {
}
/**
- * Determine whether action has external child jobs or not
- * @param actionData
- * @return true/false
- * @throws IOException
- */
- public static boolean hasExternalChildJobs(Map<String, String> actionData) throws IOException {
- return actionData.containsKey(LauncherAMUtils.ACTION_DATA_EXTERNAL_CHILD_IDS);
- }
-
- /**
* Determine whether action has output data or not
- * @param actionData
+ * @param actionData action configuration data
* @return true/false
- * @throws IOException
*/
- public static boolean hasOutputData(Map<String, String> actionData) throws IOException {
+ public static boolean hasOutputData(Map<String, String> actionData) {
return actionData.containsKey(LauncherAMUtils.ACTION_DATA_OUTPUT_PROPS);
}
/**
* Determine whether action has external stats or not
- * @param actionData
+ * @param actionData action configuration data
* @return true/false
- * @throws IOException
*/
- public static boolean hasStatsData(Map<String, String> actionData) throws IOException{
+ public static boolean hasStatsData(Map<String, String> actionData) {
return actionData.containsKey(LauncherAMUtils.ACTION_DATA_STATS);
}
/**
* Determine whether action has new id (id swap) or not
- * @param actionData
+ * @param actionData action configuration data
* @return true/false
- * @throws IOException
*/
- public static boolean hasIdSwap(Map<String, String> actionData) throws IOException {
+ public static boolean hasIdSwap(Map<String, String> actionData) {
return actionData.containsKey(LauncherAMUtils.ACTION_DATA_NEW_ID);
}
/**
* Get the sequence file path storing all action data
- * @param actionDir
+ * @param actionDir directory of action conf
* @return Path returns sequence file path storing all action data
*/
public static Path getActionDataSequenceFilePath(Path actionDir) {
@@ -236,8 +223,8 @@ public class LauncherHelper {
* @param actionDir Path
* @param conf Configuration
* @return Map action data
- * @throws IOException
- * @throws InterruptedException
+ * @throws IOException if an IO error occurred
+ * @throws InterruptedException if UGI action is interrupted
*/
public static Map<String, String> getActionData(final FileSystem fs, final Path actionDir, final Configuration conf)
throws IOException, InterruptedException {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/MapReduceActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/MapReduceActionExecutor.java
index a4dd13b..9b102a5 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/MapReduceActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/MapReduceActionExecutor.java
@@ -319,7 +319,7 @@ public class MapReduceActionExecutor extends JavaActionExecutor {
* Return the sharelib name for the action.
*
* @return returns <code>streaming</code> if mapreduce-streaming action, <code>NULL</code> otherwise.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/OozieJobInfo.java b/core/src/main/java/org/apache/oozie/action/hadoop/OozieJobInfo.java
index d8b1f03..1bf5b41 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/OozieJobInfo.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/OozieJobInfo.java
@@ -63,7 +63,7 @@ public class OozieJobInfo {
* @param actionConf the action conf
* @param context the context
* @param action the action
- * @throws IOException
+ * @throws IOException if creating XConfiguration fails
*/
public OozieJobInfo(Configuration actionConf, Context context, WorkflowAction action) throws IOException {
this.context = context;
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/PigActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/PigActionExecutor.java
index 8465acd..5798eb7 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/PigActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/PigActionExecutor.java
@@ -111,7 +111,7 @@ public class PigActionExecutor extends ScriptLanguageActionExecutor {
* Return the sharelib postfix for the action.
*
* @return returns <code>pig</code>.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/ShellActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/ShellActionExecutor.java
index 9591cd9..cea6fa0 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/ShellActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/ShellActionExecutor.java
@@ -87,12 +87,12 @@ public class ShellActionExecutor extends JavaActionExecutor {
* This method read a list of tag from an XML element and set the
* Configuration accordingly
*
- * @param tag
- * @param actionXml
- * @param actionConf
- * @param key
- * @param checkKeyValue
- * @throws ActionExecutorException
+ * @param tag xml tag to read
+ * @param actionXml action xml element
+ * @param actionConf action configuration
+ * @param key environment variable key
+ * @param checkKeyValue set to true to check key=value syntax
+ * @throws ActionExecutorException if environment variable setting is incorrect
*/
protected void setListInConf(String tag, Element actionXml, Configuration actionConf, String key,
boolean checkKeyValue) throws ActionExecutorException {
@@ -114,8 +114,8 @@ public class ShellActionExecutor extends JavaActionExecutor {
/**
* Check if the key=value pair is appropriately formatted
- * @param pair
- * @throws ActionExecutorException
+ * @param pair key=value pair
+ * @throws ActionExecutorException if environment variable setting is incorrect
*/
private void checkPair(String pair) throws ActionExecutorException {
String[] varValue = pair.split("=");
@@ -133,9 +133,9 @@ public class ShellActionExecutor extends JavaActionExecutor {
/**
* Utility method to append the new value to any property.
*
- * @param conf
- * @param propertyName
- * @param appendValue
+ * @param conf configuration
+ * @param propertyName name of property to update
+ * @param appendValue new value to append to property
*/
private void updateProperty(Configuration conf, String propertyName, String appendValue) {
if (conf != null) {
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/SparkActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/SparkActionExecutor.java
index 5f399c4..7d40bf5 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/SparkActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/SparkActionExecutor.java
@@ -136,7 +136,7 @@ public class SparkActionExecutor extends JavaActionExecutor {
/**
* Return the sharelib name for the action.
*
- * @param actionXml
+ * @param actionXml action xml element
* @return returns <code>spark</code>.
*/
@Override
diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/SqoopActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/SqoopActionExecutor.java
index ffe27e3..4117d8b 100644
--- a/core/src/main/java/org/apache/oozie/action/hadoop/SqoopActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/hadoop/SqoopActionExecutor.java
@@ -157,7 +157,7 @@ public class SqoopActionExecutor extends JavaActionExecutor {
*
* @param context Action context
* @param action Workflow action
- * @throws ActionExecutorException
+ * @throws ActionExecutorException thrown if action end execution fails.
*/
@Override
public void end(Context context, WorkflowAction action) throws ActionExecutorException {
@@ -267,7 +267,7 @@ public class SqoopActionExecutor extends JavaActionExecutor {
* Return the sharelib name for the action.
*
* @return returns <code>sqoop</code>.
- * @param actionXml
+ * @param actionXml action xml element
*/
@Override
protected String getDefaultShareLibName(Element actionXml) {
diff --git a/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java b/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java
index 1e37e80..34a26a9 100644
--- a/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java
+++ b/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java
@@ -51,7 +51,7 @@ import org.jdom.JDOMException;
import org.jdom.Namespace;
/**
- * Ssh action executor. <p> <ul> <li>Execute the shell commands on the remote host</li> <li>Copies the base and wrapper
+ * Ssh action executor. <ul> <li>Execute the shell commands on the remote host</li> <li>Copies the base and wrapper
* scripts on to the remote location</li> <li>Base script is used to run the command on the remote host</li> <li>Wrapper
* script is used to check the status of the submitted command</li> <li>handles the submission failures</li> </ul>
*/
@@ -121,7 +121,7 @@ public class SshActionExecutor extends ActionExecutor {
*
* @param context action execution context.
* @param action action object.
- * @throws org.apache.oozie.action.ActionExecutorException
+ * @throws org.apache.oozie.action.ActionExecutorException in case if action cannot be executed
*/
@SuppressFBWarnings(value = {"COMMAND_INJECTION", "PATH_TRAVERSAL_OUT"},
justification = "Tracker URI is specified in the WF action, and action dir path is from context")
@@ -193,7 +193,7 @@ public class SshActionExecutor extends ActionExecutor {
*
* @param context action execution context.
* @param action object.
- * @throws org.apache.oozie.action.ActionExecutorException
+ * @throws org.apache.oozie.action.ActionExecutorException in case if action cannot be executed
*/
@Override
public void kill(Context context, WorkflowAction action) throws ActionExecutorException {
@@ -212,7 +212,7 @@ public class SshActionExecutor extends ActionExecutor {
*
* @param context action execution context.
* @param action action object.
- * @throws org.apache.oozie.action.ActionExecutorException
+ * @throws org.apache.oozie.action.ActionExecutorException in case if action cannot be executed
*/
@SuppressWarnings("unchecked")
@Override
@@ -547,7 +547,7 @@ public class SshActionExecutor extends ActionExecutor {
/**
* Get action status.
*
- * @param context
+ * @param context executor context
* @param action action object.
* @return status of the action(RUNNING/OK/ERROR).
* @throws ActionExecutorException thrown if there is any error in getting status.
diff --git a/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java
index d3d389e..1e6c5e1 100644
--- a/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java
@@ -29,7 +29,7 @@ import org.apache.oozie.util.StatusUtils;
* rerunChildren() : submit or queue commands to rerun children
* notifyParent() : update the status to upstream if any
*
- * @param <T>
+ * @param <T> template parameter
*/
public abstract class RerunTransitionXCommand<T> extends TransitionXCommand<T> {
protected String jobId;
diff --git a/core/src/main/java/org/apache/oozie/command/ResumeTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/ResumeTransitionXCommand.java
index 61244cc..bd138dd 100644
--- a/core/src/main/java/org/apache/oozie/command/ResumeTransitionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/ResumeTransitionXCommand.java
@@ -25,7 +25,7 @@ public abstract class ResumeTransitionXCommand extends TransitionXCommand<Void>
/**
* Resume all children of the job
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void resumeChildren() throws CommandException;
diff --git a/core/src/main/java/org/apache/oozie/command/SuspendTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/SuspendTransitionXCommand.java
index 6b3a2e5..18dcdd3 100644
--- a/core/src/main/java/org/apache/oozie/command/SuspendTransitionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/SuspendTransitionXCommand.java
@@ -25,7 +25,7 @@ public abstract class SuspendTransitionXCommand extends TransitionXCommand<Void>
/**
* Suspend all children of the job
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void suspendChildren() throws CommandException;
diff --git a/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java
index 0c10103..262a78f 100644
--- a/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java
@@ -34,7 +34,7 @@ import org.apache.oozie.util.ParamChecker;
* This is the base commands for all the jobs related commands . This will drive the statuses for all the jobs and all
* the jobs will follow the same state machine.
*
- * @param <T>
+ * @param <T> return type of execute()
*/
public abstract class TransitionXCommand<T> extends XCommand<T> {
@@ -53,30 +53,30 @@ public abstract class TransitionXCommand<T> extends XCommand<T> {
/**
* Transit to the next status based on the result of the Job.
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void transitToNext() throws CommandException;
/**
* Update the parent job.
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void updateJob() throws CommandException;
/**
* This will be used to notify the parent about the status of that perticular job.
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void notifyParent() throws CommandException;
/**
* This will be used to generate Job Notification events on status changes
*
- * @param coordJob
- * @param startTime
- * @throws CommandException
+ * @param coordJob coordinator job
+ * @param startTime start time
+ * @throws CommandException if command cannot be completed
*/
public void generateEvents(CoordinatorJobBean coordJob, Date startTime) throws CommandException {
for(UpdateEntry entry : updateList){
@@ -93,7 +93,7 @@ public abstract class TransitionXCommand<T> extends XCommand<T> {
/**
* This will be used to perform atomically all the writes within this command.
*
- * @throws CommandException
+ * @throws CommandException if command cannot be completed
*/
public abstract void performWrites() throws CommandException;
diff --git a/core/src/main/java/org/apache/oozie/command/XCommand.java b/core/src/main/java/org/apache/oozie/command/XCommand.java
index 7b2dbd5..28918b6 100644
--- a/core/src/main/java/org/apache/oozie/command/XCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/XCommand.java
@@ -44,7 +44,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
* Base class for synchronous and asynchronous commands.
* <p>
* It enables by API the following pattern:
- * <p>
+ * </p>
* <ul>
* <li>single execution: a command instance can be executed only once</li>
* <li>eager data loading: loads data for eager precondition check</li>
@@ -54,7 +54,6 @@ import java.util.concurrent.atomic.AtomicBoolean;
* <li>locking: obtains exclusive lock on key before executing the command</li>
* <li>execution: command logic</li>
* </ul>
- * <p>
* It has built in instrumentation and logging.
*/
public abstract class XCommand<T> implements XCallable<T> {
@@ -425,6 +424,8 @@ public abstract class XCommand<T> implements XCallable<T> {
* Subclasses should override this method and load the state needed to do an eager precondition check.
* <p>
* A trivial implementation is calling {link #loadState}.
+ *
+ * @throws CommandException thrown if loading state fails
*/
protected void eagerLoadState() throws CommandException {
}
@@ -437,6 +438,7 @@ public abstract class XCommand<T> implements XCallable<T> {
* A trivial implementation is calling {link #verifyPrecondition}.
*
* @throws CommandException thrown if the precondition is not met.
+ * @throws PreconditionException thrown if precondition does not met
*/
protected void eagerVerifyPrecondition() throws CommandException, PreconditionException {
}
@@ -446,6 +448,8 @@ public abstract class XCommand<T> implements XCallable<T> {
* <p>
* Subclasses must implement this method and load the state needed to do the precondition check and execute the
* command.
+ *
+ * @throws CommandException thrown if loading state fails
*/
protected abstract void loadState() throws CommandException;
@@ -454,6 +458,7 @@ public abstract class XCommand<T> implements XCallable<T> {
* <p>
*
* @throws CommandException thrown if the precondition is not met.
+ * @throws PreconditionException thrown if precondition does not met
*/
protected abstract void verifyPrecondition() throws CommandException, PreconditionException;
diff --git a/core/src/main/java/org/apache/oozie/command/coord/BulkCoordXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/BulkCoordXCommand.java
index e6a9c54..d395901 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/BulkCoordXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/BulkCoordXCommand.java
@@ -46,6 +46,7 @@ public class BulkCoordXCommand extends XCommand<CoordinatorJobInfo> {
* @param filter the filter string
* @param start start location for paging
* @param length total length to get
+ * @param operation type of operation
*/
public BulkCoordXCommand(Map<String, List<String>> filter, int start, int length, OperationType operation) {
super("bulkcoord" + operation, "bulkcoord" + operation, 1);
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordActionInputCheckXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordActionInputCheckXCommand.java
index b3174d2..3fbdae2 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordActionInputCheckXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordActionInputCheckXCommand.java
@@ -453,6 +453,8 @@ public class CoordActionInputCheckXCommand extends CoordinatorXCommand<Void> {
/**
* getting the error code of the coord action. (used mainly for unit testing)
+ *
+ * @return error code
*/
protected String getCoordActionErrorCode() {
if (coordAction != null) {
@@ -463,6 +465,8 @@ public class CoordActionInputCheckXCommand extends CoordinatorXCommand<Void> {
/**
* getting the error message of the coord action. (used mainly for unit testing)
+ *
+ * @return error message
*/
protected String getCoordActionErrorMsg() {
if (coordAction != null) {
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java
index 83c7e2f..fcf98f5 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java
@@ -52,7 +52,7 @@ import org.apache.oozie.util.ParamChecker;
* <p>
* The "range" can be set with {@link RestConstants#JOB_COORD_SCOPE_DATE} or
* {@link RestConstants#JOB_COORD_SCOPE_ACTION}.
- * <p>
+ * </p>
*/
public class CoordActionsKillXCommand extends KillTransitionXCommand<CoordinatorActionInfo> {
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordCommandUtils.java b/core/src/main/java/org/apache/oozie/command/coord/CoordCommandUtils.java
index 4e4a569..7d73815 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordCommandUtils.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordCommandUtils.java
@@ -85,10 +85,10 @@ public class CoordCommandUtils {
* parse a function like coord:latest(n)/future() and return the 'n'.
* <p>
*
- * @param function
- * @param restArg
+ * @param function function
+ * @param restArg arguments
* @return int instanceNumber
- * @throws Exception
+ * @throws Exception when parsing function argument fails
*/
public static int getInstanceNumber(String function, StringBuilder restArg) throws Exception {
int funcType = getFuncType(function);
@@ -106,12 +106,12 @@ public class CoordCommandUtils {
/**
* Evaluates function for coord-action-create-inst tag
- * @param event
- * @param appInst
- * @param conf
- * @param function
+ * @param event event
+ * @param appInst application instance
+ * @param conf configuration
+ * @param function function
* @return evaluation result
- * @throws Exception
+ * @throws Exception when evaluating function fails, especially when parsing date/time zone
*/
private static String evaluateInstanceFunction(Element event, SyncCoordAction appInst, Configuration conf,
String function) throws Exception {
@@ -215,12 +215,12 @@ public class CoordCommandUtils {
/**
* Resolve list of <instance> </instance> tags.
*
- * @param event
- * @param instances
- * @param actionInst
- * @param conf
+ * @param event event
+ * @param instances instances
+ * @param actionInst action instance
+ * @param conf configuration
* @param eval ELEvalautor
- * @throws Exception
+ * @throws Exception when function evaluation fails
*/
public static void resolveInstances(Element event, StringBuilder instances, SyncCoordAction actionInst,
Configuration conf, ELEvaluator eval) throws Exception {
@@ -238,12 +238,12 @@ public class CoordCommandUtils {
* Resolve <start-instance> <end-insatnce> tag. Don't resolve any
* latest()/future()
*
- * @param event
- * @param instances
- * @param appInst
- * @param conf
+ * @param event event
+ * @param instances instances
+ * @param appInst application instance
+ * @param conf configuration
* @param eval ELEvalautor
- * @throws Exception
+ * @throws Exception when function evaluation fails
*/
public static void resolveInstanceRange(Element event, StringBuilder instances, SyncCoordAction appInst,
Configuration conf, ELEvaluator eval) throws Exception {
@@ -374,10 +374,10 @@ public class CoordCommandUtils {
* @param event : <data-in>
* @param expr : instance like current(-1)
* @param appInst : application specific info
- * @param conf
+ * @param conf configuration
* @param evalInst :ELEvaluator
* @return materialized date string
- * @throws Exception
+ * @throws Exception when function evaluation fails
*/
public static String materializeInstance(Element event, String expr, SyncCoordAction appInst, Configuration conf,
ELEvaluator evalInst) throws Exception {
@@ -392,9 +392,9 @@ public class CoordCommandUtils {
/**
* Create two new tags with <uris> and <unresolved-instances>.
*
- * @param event
- * @param instances
- * @throws Exception
+ * @param event event
+ * @param instances instances
+ * @throws Exception when function evaluation fails
*/
private static String separateResolvedAndUnresolved(Element event, StringBuilder instances)
throws Exception {
@@ -428,7 +428,7 @@ public class CoordCommandUtils {
* @param unresolvedInstances : list of instance with latest function
* @param urisWithDoneFlag : list of URIs with the done flag appended
* @return : list of URIs separated by ";" as a string.
- * @throws Exception
+ * @throws Exception when function evaluation fails
*/
public static String createEarlyURIs(Element event, String instances, StringBuilder unresolvedInstances,
StringBuilder urisWithDoneFlag) throws Exception {
@@ -471,11 +471,11 @@ public class CoordCommandUtils {
}
/**
- * @param eAction
- * @param coordAction
- * @param conf
+ * @param eAction action xml element
+ * @param coordAction coordinator action
+ * @param conf configuration
* @return boolean to determine whether the SLA element is present or not
- * @throws CoordinatorJobException
+ * @throws CoordinatorJobException in case of coordinator problem
*/
public static boolean materializeSLA(Element eAction, CoordinatorActionBean coordAction, Configuration conf)
throws CoordinatorJobException {
@@ -520,7 +520,7 @@ public class CoordCommandUtils {
* @param conf job configuration
* @param actionBean CoordinatorActionBean to materialize
* @return one materialized action for specific nominal time
- * @throws Exception
+ * @throws Exception when materialization fails due to url checks or evaluation
*/
@SuppressWarnings("unchecked")
public static String materializeOneInstance(String jobId, boolean dryrun, Element eAction, Date nominalTime,
@@ -598,7 +598,7 @@ public class CoordCommandUtils {
* @param eAction the actionXml related element
* @param actionBean the coordinator action bean
* @return actionXml returns actionXml as String
- * @throws Exception
+ * @throws Exception when materialization fails due to url checks or evaluation
*/
static String dryRunCoord(Element eAction, CoordinatorActionBean actionBean) throws Exception {
String action = XmlUtils.prettyPrint(eAction).toString();
@@ -652,10 +652,10 @@ public class CoordCommandUtils {
* tags Create uris for resolved instances. Create unresolved instance for
* latest()/future().
*
- * @param events
- * @param appInst
- * @param conf
- * @throws Exception
+ * @param events events
+ * @param appInst application instance
+ * @param conf configuration
+ * @throws Exception when materialization fails due to url checks or evaluation
*/
private static void materializeOutputDataEvents(List<Element> events, SyncCoordAction appInst, Configuration conf)
throws Exception {
@@ -770,9 +770,9 @@ public class CoordCommandUtils {
/**
* Get resolved string from missDepList
*
- * @param missDepList
- * @param resolved
- * @param unresolved
+ * @param missDepList missing dependencies
+ * @param resolved resolved dependencies
+ * @param unresolved unresolved dependencies
* @return resolved string
*/
public static String getResolvedList(String missDepList, StringBuilder resolved, StringBuilder unresolved) {
@@ -792,9 +792,10 @@ public class CoordCommandUtils {
/**
* Get the next action time after a given time
*
- * @param targetDate
- * @param coordJob
+ * @param targetDate target date
+ * @param coordJob coordinator job
* @return the next valid action time
+ * @throws ParseException if parsing time fails
*/
public static Date getNextValidActionTimeForCronFrequency(Date targetDate, CoordinatorJobBean coordJob) throws ParseException {
@@ -873,8 +874,8 @@ public class CoordCommandUtils {
* @param coordJob The Coordinator Job
* @param coordAction The Coordinator Action
* @return the nominal time of the next action
- * @throws ParseException
- * @throws JDOMException
+ * @throws ParseException if parsing time fails
+ * @throws JDOMException in case of xml parsing error
*/
public static Date computeNextNominalTime(CoordinatorJobBean coordJob, CoordinatorActionBean coordAction)
throws ParseException, JDOMException {
@@ -947,8 +948,8 @@ public class CoordCommandUtils {
/**
* @param startIndex dataset index
- * @param timeUnit
- * @param datasetTimeZone
+ * @param timeUnit time unit
+ * @param datasetTimeZone time zone of data set
* @param nominalTime nominal time of action
*/
public StartInstanceFinder(int startIndex, TimeUnit timeUnit, TimeZone datasetTimeZone, Date nominalTime) {
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordJobXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordJobXCommand.java
index 6cf7c05..0ca9e43 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordJobXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordJobXCommand.java
@@ -60,7 +60,7 @@ public class CoordJobXCommand extends CoordinatorXCommand<CoordinatorJobBean> {
/**
* Constructor for loading a coordinator job information
* @param id coord jobId
- * @param filterMap
+ * @param filterMap filters
* @param offset starting index in the list of actions belonging to the job
* @param length number of actions to be returned
* @param desc boolean for whether the actions returned are in descending order
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordMaterializeTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordMaterializeTransitionXCommand.java
index ec9ef41..7e0a2bf 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordMaterializeTransitionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordMaterializeTransitionXCommand.java
@@ -368,6 +368,7 @@ public class CoordMaterializeTransitionXCommand extends MaterializeTransitionXCo
* Create action instances starting from "startMatdTime" to "endMatdTime" and store them into coord action table.
*
* @param dryrun if this is a dry run
+ * @return materialized action(s)
* @throws Exception thrown if failed to materialize actions
*/
protected String materializeActions(boolean dryrun) throws Exception {
diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordSubmitXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordSubmitXCommand.java
index f46f254..705350d 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/CoordSubmitXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/CoordSubmitXCommand.java
@@ -318,6 +318,8 @@ public class CoordSubmitXCommand extends SubmitTransitionXCommand {
/**
* Queue MaterializeTransitionXCommand
+ *
+ * @param jobId job id
*/
protected void queueMaterializeTransitionXCommand(String jobId) {
int materializationWindow = ConfigurationService
diff --git a/core/src/main/java/org/apache/oozie/command/coord/SLAEventsXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/SLAEventsXCommand.java
index cae9591..ef3421d 100644
--- a/core/src/main/java/org/apache/oozie/command/coord/SLAEventsXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/coord/SLAEventsXCommand.java
@@ -95,7 +95,7 @@ public class SLAEventsXCommand extends XCommand<List<SLAEventBean>> {
/**
* Set lastSeqId
*
- * @param lastSeqId
+ * @param lastSeqId last sequence id
*/
public void setLastSeqId(long lastSeqId) {
this.lastSeqId = lastSeqId;
diff --git a/core/src/main/java/org/apache/oozie/command/sla/SLAJobHistoryXCommand.java b/core/src/main/java/org/apache/oozie/command/sla/SLAJobHistoryXCommand.java
index 0b4045a..4770170 100644
--- a/core/src/main/java/org/apache/oozie/command/sla/SLAJobHistoryXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/sla/SLAJobHistoryXCommand.java
@@ -89,6 +89,8 @@ public abstract class SLAJobHistoryXCommand extends XCommand<Boolean> {
/**
* Update SLASummary
*
+ * @throws CommandException if command cannot be executed
+ * @throws XException in other cases
*/
protected abstract void updateSLASummary() throws CommandException, XException;
diff --git a/core/src/main/java/org/apache/oozie/command/wf/ActionStartXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/ActionStartXCommand.java
index ea61e22..7a9e9fe 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/ActionStartXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/ActionStartXCommand.java
@@ -354,8 +354,8 @@ public class ActionStartXCommand extends ActionXCommand<org.apache.oozie.command
/**
* Get action executor context
- * @param isRetry
- * @param isUserRetry
+ * @param isRetry set to true if retry mode
+ * @param isUserRetry set to true is user retry mode
* @return ActionExecutorContext returns action executor context
*/
protected ActionExecutorContext getContext(boolean isRetry, boolean isUserRetry) {
diff --git a/core/src/main/java/org/apache/oozie/command/wf/ActionXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/ActionXCommand.java
index 2207546..e1cafd2 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/ActionXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/ActionXCommand.java
@@ -150,7 +150,7 @@ public abstract class ActionXCommand<T> extends WorkflowXCommand<T> {
*
* @param context the execution context.
* @param executor the executor instance being used.
- * @param message
+ * @param message error message
* @param isStart whether the error was generated while starting or ending an action.
* @param status the status to be set for the action.
* @throws CommandException thrown if unable to handle action error
@@ -218,6 +218,7 @@ public abstract class ActionXCommand<T> extends WorkflowXCommand<T> {
/**
* Execute retry for action if this action is eligible for user-retry
*
+ * @param context executor context
* @param action the Workflow action bean
* @return true if user-retry has to be handled for this action
* @throws CommandException thrown if unable to fail job
@@ -244,25 +245,35 @@ public abstract class ActionXCommand<T> extends WorkflowXCommand<T> {
return false;
}
- /*
- * In case of action error increment the error count for instrumentation
- */
+ /**
+ * In case of action error increment the error count for instrumentation
+ *
+ * @param type counter type
+ * @param error error type
+ * @param count error count
+ */
private void incrActionErrorCounter(String type, String error, int count) {
getInstrumentation().incr(INSTRUMENTATION_GROUP, type + "#ex." + error, count);
}
- /**
- * Increment the action counter in the instrumentation log. indicating how
- * many times the action was executed since the start Oozie server
- */
+ /**
+ * Increment the action counter in the instrumentation log. indicating how
+ * many times the action was executed since the start Oozie server
+ *
+ * @param type counter type
+ * @param count value to update
+ */
protected void incrActionCounter(String type, int count) {
getInstrumentation().incr(INSTRUMENTATION_GROUP, type + "#" + getName(), count);
}
- /**
- * Adding a cron for the instrumentation time for the given Instrumentation
- * group
- */
+ /**
+ * Adding a cron for the instrumentation time for the given Instrumentation
+ * group
+ *
+ * @param type counter type
+ * @param cron cron instance
+ */
protected void addActionCron(String type, Instrumentation.Cron cron) {
getInstrumentation().addCron(INSTRUMENTATION_GROUP, type + "#" + getName(), cron);
}
@@ -301,6 +312,11 @@ public abstract class ActionXCommand<T> extends WorkflowXCommand<T> {
/**
* Constructing the ActionExecutorContext, setting the private members
* and constructing the proto configuration
+ *
+ * @param workflow workflow
+ * @param action action
+ * @param isRetry set to true if retry mode
+ * @param isUserRetry set to true if user retry mode
*/
public ActionExecutorContext(WorkflowJobBean workflow, WorkflowActionBean action, boolean isRetry,
boolean isUserRetry) {
@@ -355,8 +371,8 @@ public abstract class ActionXCommand<T> extends WorkflowXCommand<T> {
/**
* This is not thread safe, don't use if workflowjob is shared among multiple actions command
- * @param name
- * @param value
+ * @param name variable name
+ * @param value variable value
*/
public void setVarToWorkflow(String name, String value) {
name = action.getName() + WorkflowInstance.NODE_VAR_SEPARATOR + name;
diff --git a/core/src/main/java/org/apache/oozie/command/wf/BulkWorkflowXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/BulkWorkflowXCommand.java
index 74dfd52..0692a65 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/BulkWorkflowXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/BulkWorkflowXCommand.java
@@ -45,6 +45,7 @@ public class BulkWorkflowXCommand extends WorkflowXCommand<WorkflowsInfo> {
* @param start starting from this index in the list of workflows matching the filter are killed
* @param length number of workflows to be killed from the list of workflows matching the filter and starting from
* index "start".
+ * @param operation operation type
*/
public BulkWorkflowXCommand(Map<String, List<String>> filter, int start, int length, OperationType operation) {
super("bulkkill", "bulkkill", 1, true);
diff --git a/core/src/main/java/org/apache/oozie/command/wf/ReRunXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/ReRunXCommand.java
index 58f203f..dd8d3d2 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/ReRunXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/ReRunXCommand.java
@@ -280,7 +280,7 @@ public class ReRunXCommand extends WorkflowXCommand<Void> {
* Loading the Wfjob and workflow actions. Parses the config and adds the nodes that are to be skipped to the
* skipped node list
*
- * @throws CommandException
+ * @throws CommandException if loading state fails
*/
@Override
protected void eagerLoadState() throws CommandException {
@@ -322,7 +322,7 @@ public class ReRunXCommand extends WorkflowXCommand<Void> {
* Checks the pre-conditions that are required for workflow to recover - Last run of Workflow should be completed -
* The nodes that are to be skipped are to be completed successfully in the base run.
*
- * @throws CommandException
+ * @throws CommandException if verification fails
* @throws PreconditionException On failure of pre-conditions
*/
@Override
diff --git a/core/src/main/java/org/apache/oozie/command/wf/SubmitXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/SubmitXCommand.java
index 1509c38..70b9adc 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/SubmitXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/SubmitXCommand.java
@@ -368,7 +368,7 @@ public class SubmitXCommand extends WorkflowXCommand<String> {
* @param eSla sla xml element
* @param evalSla sla evaluator
* @return sla xml string after evaluation
- * @throws CommandException
+ * @throws CommandException if command cannot be executed
*/
public static String resolveSla(Element eSla, ELEvaluator evalSla) throws CommandException {
// EL evaluation
diff --git a/core/src/main/java/org/apache/oozie/command/wf/SuspendXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/SuspendXCommand.java
index ef97990..0061d9d 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/SuspendXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/SuspendXCommand.java
@@ -107,6 +107,7 @@ public class SuspendXCommand extends WorkflowXCommand<Void> {
* @param workflow workflow job
* @param id workflow job id
* @param actionId workflow action id
+ * @param updateList list of job to be updated
* @throws WorkflowException thrown if failed to suspend workflow instance
* @throws CommandException thrown if unable set pending false for actions
*/
diff --git a/core/src/main/java/org/apache/oozie/command/wf/WorkflowXCommand.java b/core/src/main/java/org/apache/oozie/command/wf/WorkflowXCommand.java
index 9ed4336..7fdf869 100644
--- a/core/src/main/java/org/apache/oozie/command/wf/WorkflowXCommand.java
+++ b/core/src/main/java/org/apache/oozie/command/wf/WorkflowXCommand.java
@@ -30,7 +30,7 @@ import org.apache.oozie.event.WorkflowJobEvent;
/**
* Abstract coordinator command class derived from XCommand
*
- * @param <T>
+ * @param <T> template parameter for XCommand, used as return type of call()
*/
public abstract class WorkflowXCommand<T> extends XCommand<T> {
diff --git a/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java b/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java
index 3467eef..c869b87 100644
--- a/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java
+++ b/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java
@@ -82,7 +82,7 @@ public class CoordELEvaluator {
}
public static ELEvaluator createELEvaluatorForDataEcho(Configuration conf, String group,
- HashMap<String, String> dataNameList) throws Exception {
+ HashMap<String, String> dataNameList) {
ELEvaluator eval = createELEvaluatorForGroup(conf, group);
for (Iterator<String> it = dataNameList.keySet().iterator(); it.hasNext();) {
String key = it.next();
@@ -122,10 +122,9 @@ public class CoordELEvaluator {
* @param coordAction the coordinator action
* @param conf the configuration
* @return eval returns SLA evaluator to be used during Materialization
- * @throws Exception in case of error
*/
- public static ELEvaluator createSLAEvaluator(Element eAction, CoordinatorActionBean coordAction, Configuration conf)
- throws Exception {
+ public static ELEvaluator createSLAEvaluator(Element eAction, CoordinatorActionBean coordAction,
+ Configuration conf) {
ELEvaluator eval = Services.get().get(ELService.class).createEvaluator("coord-sla-create");
setConfigToEval(eval, conf);
SyncCoordAction appInst = new SyncCoordAction();// TODO:
@@ -158,10 +157,9 @@ public class CoordELEvaluator {
* @param group the group for the EL expression
* @param dataNameList the name list for the data
* @return eval returns an Evaluator using conf and input/output-data (used for sla)
- * @throws Exception in case of error
*/
public static ELEvaluator createELEvaluatorForDataAndConf(Configuration conf, String group,
- HashMap<String, String> dataNameList) throws Exception {
+ HashMap<String, String> dataNameList) {
ELEvaluator eval = createELEvaluatorForDataEcho(conf, group, dataNameList);
setConfigToEval(eval, conf);
return eval;
diff --git a/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java b/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java
index c3fecd8..e54ec0a 100644
--- a/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java
+++ b/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java
@@ -205,7 +205,7 @@ public class CoordELFunctions {
* @param offset any number
* @param unit one of DAY, MONTH, HOUR, MINUTE, MONTH
* @return the offset date string
- * @throws Exception in case of error
+ * @throws Exception when getting calendar based on strBaseDate fails
*/
public static String ph2_coord_dateOffset(String strBaseDate, int offset, String unit) throws Exception {
Calendar baseCalDate = DateUtils.getCalendar(strBaseDate);
@@ -226,7 +226,7 @@ public class CoordELFunctions {
* @param strBaseDate The base date
* @param timezone the timezone
* @return the offset date string
- * @throws Exception in case of error
+ * @throws Exception when getting calendar based on strBaseDate fails
*/
public static String ph2_coord_dateTzOffset(String strBaseDate, String timezone) throws Exception {
Calendar baseCalDate = DateUtils.getCalendar(strBaseDate);
@@ -389,6 +389,7 @@ public class CoordELFunctions {
* Return Action Id.
*
* @return coordinator action Id
+ * @throws Exception if parameter checking fails
*/
public static String ph2_coord_actionId() throws Exception {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -405,6 +406,7 @@ public class CoordELFunctions {
* Return Job Name. <p>
*
* @return coordinator name
+ * @throws Exception if parameter checking fails
*/
public static String ph2_coord_name() throws Exception {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -497,9 +499,8 @@ public class CoordELFunctions {
* @param n instance count domain: n is integer
* @return date-time in Oozie processing timezone of the n-th instance returns 'null' means n-th instance is
* earlier than Initial-Instance of DS
- * @throws Exception
*/
- public static String ph2_coord_current(int n) throws Exception {
+ public static String ph2_coord_current(int n) {
if (isSyncDataSet()) { // For Sync Dataset
return coord_current_sync(n);
}
@@ -520,9 +521,8 @@ public class CoordELFunctions {
* delimited by comma. <p> If the current instance time of the dataset based on the Action Creation Time
* is earlier than the Initial-Instance of DS an empty string is returned.
* If an instance within the range is earlier than Initial-Instance of DS that instance is ignored
- * @throws Exception
*/
- public static String ph2_coord_currentRange(int start, int end) throws Exception {
+ public static String ph2_coord_currentRange(int start, int end) {
if (isSyncDataSet()) { // For Sync Dataset
return coord_currentRange_sync(start, end);
}
@@ -556,9 +556,8 @@ public class CoordELFunctions {
*
* @param n instance count <p> domain: n is integer
* @return number of hours on that day <p> returns -1 means n-th instance is earlier than Initial-Instance of DS
- * @throws Exception
*/
- public static int ph2_coord_hoursInDay(int n) throws Exception {
+ public static int ph2_coord_hoursInDay(int n) {
int datasetFrequency = (int) getDSFrequency();
// /Calendar nominalInstanceCal =
// getCurrentInstance(getActionCreationtime());
@@ -587,9 +586,8 @@ public class CoordELFunctions {
*
* @param n instance count. domain: n is integer
* @return number of days in that month <p> returns -1 means n-th instance is earlier than Initial-Instance of DS
- * @throws Exception
*/
- public static int ph2_coord_daysInMonth(int n) throws Exception {
+ public static int ph2_coord_daysInMonth(int n) {
int datasetFrequency = (int) getDSFrequency();// in minutes
// Calendar nominalInstanceCal =
// getCurrentInstance(getActionCreationtime());
@@ -607,7 +605,7 @@ public class CoordELFunctions {
return nominalInstanceCal.getActualMaximum(Calendar.DAY_OF_MONTH);
}
- public static int ph3_coord_daysInMonth(int n) throws Exception {
+ public static int ph3_coord_daysInMonth(int n) {
return ph2_coord_daysInMonth(n);
}
@@ -620,7 +618,7 @@ public class CoordELFunctions {
* @param n :instance count <p> domain: n <= 0, n is integer
* @return date-time in Oozie processing timezone of the n-th instance <p> returns 'null' means n-th instance is
* earlier than Initial-Instance of DS
- * @throws Exception
+ * @throws Exception in case of wrong arguments, or HDFS access errors
*/
public static String ph3_coord_latest(int n) throws Exception {
ParamChecker.checkLEZero(n, "latest:n");
@@ -644,7 +642,7 @@ public class CoordELFunctions {
* @return date-time in Oozie processing timezone of the instances from start to end offsets
* delimited by comma. <p> returns 'null' means start offset instance is
* earlier than Initial-Instance of DS
- * @throws Exception
+ * @throws Exception in case of wrong arguments, or HDFS access errors
*/
public static String ph3_coord_latestRange(int start, int end) throws Exception {
ParamChecker.checkLEZero(start, "latest:n");
@@ -677,7 +675,7 @@ public class CoordELFunctions {
* @param eval :EL evaluator
* @param expr : expression to evaluate
* @return Resolved expression or echo back the same expression
- * @throws Exception
+ * @throws Exception if evaluating expression fails
*/
public static String evalAndWrap(ELEvaluator eval, String expr) throws Exception {
try {
@@ -949,16 +947,15 @@ public class CoordELFunctions {
// Local methods
/**
- * @param n
+ * @param n the required instance position
* @return n-th instance Date-Time from current instance for data-set <p> return empty string ("") if the
* Action_Creation_time or the n-th instance <p> is earlier than the Initial_Instance of dataset.
- * @throws Exception
*/
- private static String coord_current_sync(int n) throws Exception {
+ private static String coord_current_sync(int n) {
return coord_currentRange_sync(n, n);
}
- private static String coord_currentRange_sync(int start, int end) throws Exception {
+ private static String coord_currentRange_sync(int start, int end) {
final XLog LOG = XLog.getLog(CoordELFunctions.class);
int datasetFrequency = getDSFrequency();// in minutes
TimeUnit dsTimeUnit = getDSTimeUnit();
@@ -998,9 +995,8 @@ public class CoordELFunctions {
* @param timeUnit TimeUnit for offset n ("MINUTE", "HOUR", "DAY", "MONTH", "YEAR")
* @return the offset time from the effective nominal time <p> return empty string ("") if the Action_Creation_time or the
* offset instance <p> is earlier than the Initial_Instance of dataset.
- * @throws Exception
*/
- private static String coord_offset_sync(int n, String timeUnit) throws Exception {
+ private static String coord_offset_sync(int n, String timeUnit) {
Calendar rawCal = resolveOffsetRawTime(n, TimeUnit.valueOf(timeUnit), null);
if (rawCal == null) {
// warning already logged by resolveOffsetRawTime()
@@ -1055,9 +1051,9 @@ public class CoordELFunctions {
}
/**
- * @param offset
+ * @param offset offset
* @return n-th available latest instance Date-Time for SYNC data-set
- * @throws Exception
+ * @throws Exception in case of wrong arguments, or HDFS access errors
*/
private static String coord_latest_sync(int offset) throws Exception {
return coord_latestRange_sync(offset, offset);
@@ -1068,7 +1064,7 @@ public class CoordELFunctions {
}
/**
- * @param tm
+ * @param tm calendar
* @return a new Evaluator to be used for URI-template evaluation
*/
private static ELEvaluator getUriEvaluator(Calendar tm) {
@@ -1101,8 +1097,8 @@ public class CoordELFunctions {
/**
* Check whether a function should be resolved.
*
- * @param functionName
- * @param n
+ * @param functionName name of the function
+ * @param n the function parameter
* @return null if the functionName needs to be resolved otherwise return the calling function unresolved.
*/
private static String checkIfResolved(String functionName, String n) {
@@ -1213,6 +1209,8 @@ public class CoordELFunctions {
/**
* Find the current instance based on effectiveTime (i.e Action_Creation_Time or Action_Start_Time)
*
+ * @param effectiveTime effective time
+ * @param instanceCount instance count
* @return current instance i.e. current(0) returns null if effectiveTime is earlier than Initial Instance time of
* the dataset.
*/
@@ -1337,6 +1335,7 @@ public class CoordELFunctions {
}
/**
+ * @param eval evaluator
* @return dataset TimeUnit
*/
public static TimeUnit getDSTimeUnit(ELEvaluator eval) {
@@ -1356,6 +1355,7 @@ public class CoordELFunctions {
}
/**
+ * @param eval evaluator
* @return dataset TimeZone
*/
public static TimeZone getDatasetTZ(ELEvaluator eval) {
@@ -1797,20 +1797,20 @@ public class CoordELFunctions {
/**
* Checks whether a dataset is available.
* @param nominalInstance the nominal instance
- * @param initInstance
- * @return
+ * @param initInstance the initial instance
+ * @return true if dataset is available
*/
protected abstract boolean isAvailable(Calendar nominalInstance, Calendar initInstance);
/**
* Checks whether it's the first matching for the given evaluation.
- * @return
+ * @return true if it is the first matching
*/
protected abstract boolean isFirst();
/**
* Checks whether it's not the first but a valid matching for the given evaluation.
- * @return
+ * @return true if description is true
*/
protected abstract boolean isInBetween();
@@ -1842,8 +1842,8 @@ public class CoordELFunctions {
static class OozieTimeUnitConverter {
/**
* Convert {@code millis} given {@code source} to {@link java.util.concurrent.TimeUnit}.
- * @param millis
- * @param source
+ * @param millis milliseconds
+ * @param source source time unit
* @return -1 if no correct {@code source} was given, else the estimated occurrence count of a dataset
*/
long convertMillis(final long millis, final TimeUnit source) {
diff --git a/core/src/main/java/org/apache/oozie/coord/CoordUtils.java b/core/src/main/java/org/apache/oozie/coord/CoordUtils.java
index e0c6af9..e476188 100644
--- a/core/src/main/java/org/apache/oozie/coord/CoordUtils.java
+++ b/core/src/main/java/org/apache/oozie/coord/CoordUtils.java
@@ -86,8 +86,9 @@ public class CoordUtils {
* @param rangeType the rerun type (date, action)
* @param jobId the coordinator job id
* @param scope the date scope or action id scope
+ * @param active set to true if non-terminated
* @return the list of Coordinator actions
- * @throws CommandException
+ * @throws CommandException thrown if failed to get coordinator actions by given date range
*/
public static List<CoordinatorActionBean> getCoordActions(String rangeType, String jobId, String scope,
boolean active) throws CommandException {
@@ -129,6 +130,7 @@ public class CoordUtils {
*
* @param jobId coordinator job id
* @param scope a comma-separated list of date ranges. Each date range element is specified with two dates separated by '::'
+ * @param active set to true if non-terminated
* @return the list of Coordinator actions for the date range
* @throws CommandException thrown if failed to get coordinator actions by given date range
*/
@@ -278,11 +280,11 @@ public class CoordUtils {
/**
* Check if sla alert is disabled for action.
- * @param actionBean
- * @param coordName
- * @param jobConf
+ * @param actionBean the action bean
+ * @param coordName the coordinator name
+ * @param jobConf the job configuration
* @return true if SLA alert is disabled for action
- * @throws ParseException
+ * @throws ParseException if date parse fails
*/
public static boolean isSlaAlertDisabled(CoordinatorActionBean actionBean, String coordName, Configuration jobConf)
throws ParseException {
@@ -334,7 +336,7 @@ public class CoordUtils {
* @param jobConf
* @param slaAlertType
* @return status of coord action SLA alert
- * @throws ParseException
+ * @throws ParseException if parsing date is not possible
*/
private static boolean getCoordActionSLAAlertStatus(CoordinatorActionBean actionBean, String coordName,
Configuration jobConf, String slaAlertType) throws ParseException {
diff --git a/core/src/main/java/org/apache/oozie/coord/HCatELFunctions.java b/core/src/main/java/org/apache/oozie/coord/HCatELFunctions.java
index 12c0b81..3d5d386 100644
--- a/core/src/main/java/org/apache/oozie/coord/HCatELFunctions.java
+++ b/core/src/main/java/org/apache/oozie/coord/HCatELFunctions.java
@@ -54,7 +54,7 @@ public class HCatELFunctions {
*
* @param uri hcatalog partition uri.
* @return <code>true</code> if the uri exists, <code>false</code> if it does not.
- * @throws Exception
+ * @throws Exception if any exception occurs
*/
public static boolean hcat_exists(String uri) throws Exception {
URI hcatURI = new URI(uri);
@@ -70,7 +70,7 @@ public class HCatELFunctions {
/**
* Echo the same EL function without evaluating anything
*
- * @param dataInName
+ * @param dataInName data-IN name
* @return the same EL function
*/
public static String ph1_coord_databaseIn_echo(String dataInName) {
@@ -139,7 +139,7 @@ public class HCatELFunctions {
* 'oozie.coord.el.dataset.bean' with synchronous dataset object
* (SyncCoordDataset)
*
- * @param dataInName
+ * @param dataInName data-IN name
* @return DB name
*/
public static String ph3_coord_databaseIn(String dataInName) {
@@ -158,7 +158,7 @@ public class HCatELFunctions {
* 'oozie.coord.el.dataset.bean' with synchronous dataset object
* (SyncCoordDataset)
*
- * @param dataOutName
+ * @param dataOutName data-OUT name
* @return DB name
*/
public static String ph3_coord_databaseOut(String dataOutName) {
@@ -177,7 +177,7 @@ public class HCatELFunctions {
* 'oozie.coord.el.dataset.bean' with synchronous dataset object
* (SyncCoordDataset)
*
- * @param dataInName
+ * @param dataInName data-IN name
* @return Table name
*/
public static String ph3_coord_tableIn(String dataInName) {
@@ -196,7 +196,7 @@ public class HCatELFunctions {
* 'oozie.coord.el.dataset.bean' with synchronous dataset object
* (SyncCoordDataset)
*
- * @param dataOutName
+ * @param dataOutName data-OUT name
* @return Table name
*/
public static String ph3_coord_tableOut(String dataOutName) {
@@ -217,6 +217,7 @@ public class HCatELFunctions {
*
* @param dataInName : Datain name
* @param type : for action type - pig, MR or hive
+ * @return partition filter
*/
public static String ph3_coord_dataInPartitionFilter(String dataInName, String type) {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -236,6 +237,7 @@ public class HCatELFunctions {
*
* @param dataOutName : Dataout name
* @param partitionName : Specific partition name whose value is wanted
+ * @return partition value
*/
public static String ph3_coord_dataOutPartitionValue(String dataOutName, String partitionName) {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -261,6 +263,7 @@ public class HCatELFunctions {
* unresolved, this function will echo back the original function <p> otherwise it sends the partition.
*
* @param dataOutName : DataOut name
+ * @return partitions
*/
public static String ph3_coord_dataOutPartitions(String dataOutName) {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -285,6 +288,7 @@ public class HCatELFunctions {
*
* @param dataInName : DataIn name
* @param type : for action type: hive-export
+ * @return partitions
*/
public static String ph3_coord_dataInPartitions(String dataInName, String type) {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -319,14 +323,15 @@ public class HCatELFunctions {
}
/**
- * Used to specify the MAXIMUM value of an HCat partition which is input dependency for workflow job.
+ * Used to specify the MINIMUM value of an HCat partition which is input dependency for workflow job.
* <p> Look for two evaluator-level
* variables <p> A) .datain.<DATAIN_NAME> B) .datain.<DATAIN_NAME>.unresolved <p> A defines the current list of
* HCat URIs. <p> B defines whether there are any unresolved EL-function (i.e latest) <p> If there are something
- * unresolved, this function will echo back the original function <p> otherwise it sends the max partition value.
+ * unresolved, this function will echo back the original function <p> otherwise it sends the min partition value.
*
* @param dataInName : Datain name
- * @param partitionName : Specific partition name whose MAX value is wanted
+ * @param partitionName : Specific partition name whose MIN value is wanted
+ * @return minimum of partition
*/
public static String ph3_coord_dataInPartitionMin(String dataInName, String partitionName) {
ELEvaluator eval = ELEvaluator.getCurrent();
@@ -365,14 +370,15 @@ public class HCatELFunctions {
}
/**
- * Used to specify the MINIMUM value of an HCat partition which is input dependency for workflow job.
+ * Used to specify the MAXIMUM value of an HCat partition which is input dependency for workflow job.
* <p> Look for two evaluator-level
* variables <p> A) .datain.<DATAIN_NAME> B) .datain.<DATAIN_NAME>.unresolved <p> A defines the current list of
* HCat URIs. <p> B defines whether there are any unresolved EL-function (i.e latest) <p> If there are something
- * unresolved, this function will echo back the original function <p> otherwise it sends the min partition value.
+ * unresolved, this function will echo back the original function <p> otherwise it sends the max partition value.
*
* @param dataInName : Datain name
- * @param partitionName : Specific partition name whose MIN value is wanted
+ * @param partitionName : Specific partition name whose MAX value is wanted
+ * @return maximum of partition
*/
public static String ph3_coord_dataInPartitionMax(String dataInName, String partitionName) {
ELEvaluator eval = ELEvaluator.getCurrent();
diff --git a/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorUtil.java b/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorUtil.java
index 2306ede..d38bc0f 100644
--- a/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorUtil.java
+++ b/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorUtil.java
@@ -83,7 +83,7 @@ public class CoordInputLogicEvaluatorUtil {
* Validate input logic.
*
* @throws JDOMException the JDOM exception
- * @throws CommandException in case of error
+ * @throws CommandException when evaluation fails
*/
public void validateInputLogic() throws JDOMException, CommandException {
JexlEngine jexl = new OozieJexlEngine();
diff --git a/core/src/main/java/org/apache/oozie/dependency/DependencyChecker.java b/core/src/main/java/org/apache/oozie/dependency/DependencyChecker.java
index 5e9ae74..1fcb393 100644
--- a/core/src/main/java/org/apache/oozie/dependency/DependencyChecker.java
+++ b/core/src/main/java/org/apache/oozie/dependency/DependencyChecker.java
@@ -70,7 +70,7 @@ public class DependencyChecker {
* @param stopOnFirstMissing Does not continue check for the rest of list if there is a missing
* dependency
* @return ActionDependency which has the list of missing and available dependencies
- * @throws CommandException in case of error
+ * @throws CommandException when dependency uri is malformed or resource is inaccessible
*/
public static ActionDependency checkForAvailability(String missingDependencies, Configuration actionConf,
boolean stopOnFirstMissing) throws CommandException {
@@ -86,7 +86,7 @@ public class DependencyChecker {
* @param stopOnFirstMissing Does not continue check for the rest of list if there is a missing
* dependency
* @return ActionDependency which has the list of missing and available dependencies
- * @throws CommandException in case of error
+ * @throws CommandException when dependency uri is malformed or resource is inaccessible
*/
public static ActionDependency checkForAvailability(List<String> missingDependencies, Configuration actionConf,
boolean stopOnFirstMissing) throws CommandException {
diff --git a/core/src/main/java/org/apache/oozie/dependency/URIHandler.java b/core/src/main/java/org/apache/oozie/dependency/URIHandler.java
index b465b9a..fbec332 100644
--- a/core/src/main/java/org/apache/oozie/dependency/URIHandler.java
+++ b/core/src/main/java/org/apache/oozie/dependency/URIHandler.java
@@ -72,7 +72,7 @@ public interface URIHandler {
*
* @param uri the URI to get the dependency type from
* @return dependency type of URI
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
DependencyType getDependencyType(URI uri) throws URIHandlerException;
@@ -83,8 +83,7 @@ public interface URIHandler {
* @param conf Configuration to access the URI
* @param user name of the user the URI should be accessed as
* @param actionID The id of action which depends on the availability of the uri
- *
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
void registerForNotification(URI uri, Configuration conf, String user, String actionID)
throws URIHandlerException;
@@ -94,6 +93,7 @@ public interface URIHandler {
*
* @param uri The URI to be removed from missing dependency
* @param actionID The id of action which was dependent on the uri.
+ * @return true if unregister succeeded
*/
boolean unregisterFromNotification(URI uri, String actionID);
@@ -107,7 +107,7 @@ public interface URIHandler {
* @param readOnly indicate if operation is read-only
* @return Context to access URIs with same scheme and host
*
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
Context getContext(URI uri, Configuration conf, String user, boolean readOnly) throws URIHandlerException;
@@ -120,7 +120,7 @@ public interface URIHandler {
* @return <code>true</code> if the URI exists; <code>false</code> if the
* URI does not exist
*
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
boolean exists(URI uri, Context context) throws URIHandlerException;
@@ -135,7 +135,7 @@ public interface URIHandler {
* @return <code>true</code> if the URI exists; <code>false</code> if the
* URI does not exist
*
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
boolean exists(URI uri, Configuration conf, String user) throws URIHandlerException;
@@ -144,7 +144,7 @@ public interface URIHandler {
*
* @param uri URI
* @param context Context to access the URI
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
void delete(URI uri, Context context) throws URIHandlerException;
@@ -154,7 +154,7 @@ public interface URIHandler {
* @param uri URI
* @param conf Configuration to access the URI
* @param user name of the user the URI should be accessed as
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
void delete(URI uri, Configuration conf, String user) throws URIHandlerException;
@@ -166,7 +166,7 @@ public interface URIHandler {
*
* @return the final URI with the doneFlag incorporated
*
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
String getURIWithDoneFlag(String uri, String doneFlag) throws URIHandlerException;
@@ -178,7 +178,7 @@ public interface URIHandler {
*
* @return the final URI without the doneFlag incorporated
*
- * @throws URIHandlerException in case of error
+ * @throws URIHandlerException when dependency uri is malformed or resource is inaccessible
*/
String getURIWithoutDoneFlag(String uri, String doneFlag) throws URIHandlerException;
diff --git a/core/src/main/java/org/apache/oozie/event/EventQueue.java b/core/src/main/java/org/apache/oozie/event/EventQueue.java
index 67fb0f9..477db0c 100644
--- a/core/src/main/java/org/apache/oozie/event/EventQueue.java
+++ b/core/src/main/java/org/apache/oozie/event/EventQueue.java
@@ -41,13 +41,13 @@ public interface EventQueue {
/**
* Initialize the event queue
- * @param conf
+ * @param conf configuration
*/
void init(Configuration conf);
/**
* Add event to queue
- * @param e
+ * @param e event
*/
void add(Event e);
diff --git a/core/src/main/java/org/apache/oozie/event/listener/JobEventListener.java b/core/src/main/java/org/apache/oozie/event/listener/JobEventListener.java
index e98d10a..b2e4eb6 100644
--- a/core/src/main/java/org/apache/oozie/event/listener/JobEventListener.java
+++ b/core/src/main/java/org/apache/oozie/event/listener/JobEventListener.java
@@ -33,7 +33,7 @@ public abstract class JobEventListener {
/**
* Initialize the listener
- * @param conf
+ * @param conf configuration
*/
public abstract void init(Configuration conf);
@@ -44,31 +44,31 @@ public abstract class JobEventListener {
/**
* On workflow job transition
- * @param wje
+ * @param wje workflow job event
*/
public abstract void onWorkflowJobEvent(WorkflowJobEvent wje);
/**
* On workflow action transition
- * @param wae
+ * @param wae workflow action event
*/
public abstract void onWorkflowActionEvent(WorkflowActionEvent wae);
/**
* On coordinator job transition
- * @param cje
+ * @param cje coordinator job event
*/
public abstract void onCoordinatorJobEvent(CoordinatorJobEvent cje);
/**
* On coordinator action transition
- * @param cae
+ * @param cae coordinator action event
*/
public abstract void onCoordinatorActionEvent(CoordinatorActionEvent cae);
/**
* On bundle job transition
- * @param bje
+ * @param bje bundle job event
*/
public abstract void onBundleJobEvent(BundleJobEvent bje);
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/BinaryBlobValueHandler.java b/core/src/main/java/org/apache/oozie/executor/jpa/BinaryBlobValueHandler.java
index 92b37f8..a00a8ab 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/BinaryBlobValueHandler.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/BinaryBlobValueHandler.java
@@ -29,6 +29,8 @@ public class BinaryBlobValueHandler extends org.apache.openjpa.jdbc.meta.strats.
/**
* Singleton instance.
+ *
+ * @return singleton instance of BinaryBlobValueHandler
*/
public static BinaryBlobValueHandler getInstance() {
return _instance;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/BundleJobsDeleteJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/BundleJobsDeleteJPAExecutor.java
index afd7903..cf3833a 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/BundleJobsDeleteJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/BundleJobsDeleteJPAExecutor.java
@@ -34,7 +34,7 @@ public class BundleJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Initialize the JPAExecutor using the delete list of BundleJobBeans
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public BundleJobsDeleteJPAExecutor(Collection<String> deleteList) {
this.deleteList = deleteList;
@@ -46,7 +46,7 @@ public class BundleJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Sets the delete list for BundleJobBeans
*
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public void setDeleteList(Collection<String> deleteList) {
this.deleteList = deleteList;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionRemoveJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionRemoveJPAExecutor.java
index 25b8f36..8ea31a3 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionRemoveJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionRemoveJPAExecutor.java
@@ -35,7 +35,7 @@ public class CoordActionRemoveJPAExecutor implements JPAExecutor<Void> {
/**
* Constructor which records coordinator action id.
*
- * @param coordActionId
+ * @param coordActionId id of coordinator action
*/
public CoordActionRemoveJPAExecutor(String coordActionId) {
ParamChecker.notNull(coordActionId, "coordActionId");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionsDeleteJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionsDeleteJPAExecutor.java
index 97584e8..1a8d445 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionsDeleteJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/CoordActionsDeleteJPAExecutor.java
@@ -32,7 +32,7 @@ public class CoordActionsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Initialize the JPAExecutor using the delete list of CoordinatorActionBeans
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public CoordActionsDeleteJPAExecutor(Collection<String> deleteList) {
this.deleteList = deleteList;
@@ -44,7 +44,7 @@ public class CoordActionsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Sets the delete list for CoordinatorActionBeans
*
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public void setDeleteList(Collection<String> deleteList) {
this.deleteList = deleteList;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsDeleteJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsDeleteJPAExecutor.java
index 0a8eb9a..fd083a7 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsDeleteJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsDeleteJPAExecutor.java
@@ -34,7 +34,7 @@ public class CoordJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Initialize the JPAExecutor using the delete list of CoordinatorJobBeans
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public CoordJobsDeleteJPAExecutor(Collection<String> deleteList) {
this.deleteList = deleteList;
@@ -46,7 +46,7 @@ public class CoordJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Sets the delete list for CoordinatorJobBeans
*
- * @param deleteList
+ * @param deleteList list of jobs to delete
*/
public void setDeleteList(Collection<String> deleteList) {
this.deleteList = deleteList;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsToBeMaterializedJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsToBeMaterializedJPAExecutor.java
index 6f30a42..6c78bd1 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsToBeMaterializedJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/CoordJobsToBeMaterializedJPAExecutor.java
@@ -39,8 +39,8 @@ public class CoordJobsToBeMaterializedJPAExecutor implements JPAExecutor<List<Co
private int limit;
/**
- * @param date
- * @param limit
+ * @param date date
+ * @param limit limit
*/
public CoordJobsToBeMaterializedJPAExecutor(Date date, int limit) {
ParamChecker.notNull(date, "Coord Job Materialization Date");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/StringBlobValueHandler.java b/core/src/main/java/org/apache/oozie/executor/jpa/StringBlobValueHandler.java
index c2e246a..1b5739b 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/StringBlobValueHandler.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/StringBlobValueHandler.java
@@ -29,6 +29,8 @@ public class StringBlobValueHandler extends org.apache.openjpa.jdbc.meta.strats.
/**
* Singleton instance.
+ *
+ * @return singleton instance of StringBlobValueHandler
*/
public static StringBlobValueHandler getInstance() {
return _instance;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionDeleteJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionDeleteJPAExecutor.java
index 810f0e6..6658276 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionDeleteJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionDeleteJPAExecutor.java
@@ -28,7 +28,7 @@ public class WorkflowActionDeleteJPAExecutor implements JPAExecutor<Void> {
private final String wfActionId;
/**
- * @param wfActionId
+ * @param wfActionId WF action id
*/
public WorkflowActionDeleteJPAExecutor(String wfActionId) {
ParamChecker.notEmpty(wfActionId, "ActionID");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionRetryManualGetJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionRetryManualGetJPAExecutor.java
index ed2400b..25ad7e2 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionRetryManualGetJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionRetryManualGetJPAExecutor.java
@@ -35,7 +35,7 @@ public class WorkflowActionRetryManualGetJPAExecutor implements JPAExecutor<List
/**
* This creates the WorkflowActionRetryManualGetJPAExecutor executor object.
*
- * @param wfId
+ * @param wfId WF id
*/
public WorkflowActionRetryManualGetJPAExecutor(String wfId) {
ParamChecker.notNull(wfId, "wfId");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionSubsetGetJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionSubsetGetJPAExecutor.java
index 9ae3646..9a8e103 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionSubsetGetJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowActionSubsetGetJPAExecutor.java
@@ -43,9 +43,9 @@ public class WorkflowActionSubsetGetJPAExecutor implements JPAExecutor<List<Work
* This Constructor creates the WorkflowActionSubsetGetJPAExecutor object Which gets the List of wrokflow action
* bean.
*
- * @param wfId
- * @param start
- * @param length
+ * @param wfId WF id
+ * @param start first result
+ * @param length length
*/
public WorkflowActionSubsetGetJPAExecutor(String wfId, int start, int length) {
ParamChecker.notNull(wfId, "wfJobId");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowInfoWithActionsSubsetGetJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowInfoWithActionsSubsetGetJPAExecutor.java
index 3ceda38..5df6841 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowInfoWithActionsSubsetGetJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowInfoWithActionsSubsetGetJPAExecutor.java
@@ -44,9 +44,9 @@ public class WorkflowInfoWithActionsSubsetGetJPAExecutor implements JPAExecutor<
* This will create the WorkflowInfoWithActionsSubsetGetJPAExecutor object. which is responsible for getting the
* Workflow job with actions in certain range.
*
- * @param wfJobId
- * @param start
- * @param len
+ * @param wfJobId WF job id
+ * @param start start element of range
+ * @param len length of range
*/
public WorkflowInfoWithActionsSubsetGetJPAExecutor(String wfJobId, int start, int len) {
ParamChecker.notNull(wfJobId, "wfJobId");
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowJobsDeleteJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowJobsDeleteJPAExecutor.java
index 01fe534..f792ce1 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowJobsDeleteJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowJobsDeleteJPAExecutor.java
@@ -34,7 +34,7 @@ public class WorkflowJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Initialize the JPAExecutor using the delete list of WorkflowJobBeans
- * @param deleteList
+ * @param deleteList list of workflows to be deleted
*/
public WorkflowJobsDeleteJPAExecutor(Collection<String> deleteList) {
this.deleteList = deleteList;
@@ -46,7 +46,7 @@ public class WorkflowJobsDeleteJPAExecutor implements JPAExecutor<Integer> {
/**
* Sets the delete list for WorkflowJobBeans
*
- * @param deleteList
+ * @param deleteList list of workflows to be deleted
*/
public void setDeleteList(Collection<String> deleteList) {
this.deleteList = deleteList;
diff --git a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowsJobGetJPAExecutor.java b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowsJobGetJPAExecutor.java
index 9e68f49..45a893d 100644
--- a/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowsJobGetJPAExecutor.java
+++ b/core/src/main/java/org/apache/oozie/executor/jpa/WorkflowsJobGetJPAExecutor.java
@@ -56,9 +56,9 @@ public class WorkflowsJobGetJPAExecutor implements JPAExecutor<WorkflowsInfo> {
/**
* This JPA Executor gets the workflows info for the range.
*
- * @param filter
- * @param start
- * @param len
+ * @param filter filter
+ * @param start start element of range
+ * @param len length of range
*/
public WorkflowsJobGetJPAExecutor(Map<String, List<String>> filter, int start, int len) {
this.filter = filter;
diff --git a/core/src/main/java/org/apache/oozie/jms/ConnectionContext.java b/core/src/main/java/org/apache/oozie/jms/ConnectionContext.java
index 4a76dfb..be576d7 100644
--- a/core/src/main/java/org/apache/oozie/jms/ConnectionContext.java
+++ b/core/src/main/java/org/apache/oozie/jms/ConnectionContext.java
@@ -36,14 +36,16 @@ public interface ConnectionContext {
* Create connection using properties
*
* @param props the properties used for creating jndi context
- * @throws JMSException
+ * @throws NamingException if there is naming issue
+ * @throws JMSException if JMS issue occurs
*/
void createConnection(Properties props) throws NamingException, JMSException;
/**
* Set the exception Listener
*
- * @param exceptionListener
+ * @param exceptionListener exception listener
+ * @throws JMSException if JMS issue occurs
*/
void setExceptionListener(ExceptionListener exceptionListener) throws JMSException;
@@ -57,48 +59,49 @@ public interface ConnectionContext {
/**
* Creates session using the specified session opts
*
- * @param sessionOpts
+ * @param sessionOpts session options
* @return Session returns session using the specified session opts
- * @throws JMSException
+ * @throws JMSException if JMS issue occurs
*/
Session createSession(int sessionOpts) throws JMSException;
/**
* Creates consumer using session and topic name
*
- * @param session
- * @param topicName
+ * @param session session
+ * @param topicName topic name
* @return MessageConsumer returns consumer using session and topic name
- * @throws JMSException
+ * @throws JMSException if JMS issue occurs
*/
MessageConsumer createConsumer(Session session, String topicName) throws JMSException;
/**
* Creates consumer using session, topic name and selector
*
- * @param session
- * @param topicName
+ * @param session session
+ * @param topicName topic name
+ * @param selector selector
* @return MessageConsumer returns consumer using session, topic name and selector
- * @throws JMSException
+ * @throws JMSException if JMS issue occurs
*/
MessageConsumer createConsumer(Session session, String topicName, String selector) throws JMSException;
/**
* Creates producer using session and topic
*
- * @param session
- * @param topicName
+ * @param session session
+ * @param topicName topic name
* @return MessageProducer returns producer using session and topic name
- * @throws JMSException
+ * @throws JMSException if JMS issue occurs
*/
MessageProducer createProducer(Session session, String topicName) throws JMSException;
/**
* Creates a threadlocal session using session opts
*
- * @param sessionOpts
+ * @param sessionOpts session options
* @return Session returns a threadlocal session using session opts
- * @throws JMSException
+ * @throws JMSException if JMS issue occurs
*/
Session createThreadLocalSession(final int sessionOpts) throws JMSException;
diff --git a/core/src/main/java/org/apache/oozie/jms/JMSExceptionListener.java b/core/src/main/java/org/apache/oozie/jms/JMSExceptionListener.java
index 75751eb..dc40545 100644
--- a/core/src/main/java/org/apache/oozie/jms/JMSExceptionListener.java
+++ b/core/src/main/java/org/apache/oozie/jms/JMSExceptionListener.java
@@ -37,6 +37,7 @@ public class JMSExceptionListener implements ExceptionListener {
*
* @param connInfo Information to connect to the JMS compliant messaging service
* @param connCtxt The actual connection on which this listener will be registered
+ * @param retry set to true if connection shall be retried after exception
*/
public JMSExceptionListener(JMSConnectionInfo connInfo, ConnectionContext connCtxt, boolean retry) {
this.connInfo = connInfo;
diff --git a/core/src/main/java/org/apache/oozie/local/LocalOozie.java b/core/src/main/java/org/apache/oozie/local/LocalOozie.java
index 6475f33..0db695a 100644
--- a/core/src/main/java/org/apache/oozie/local/LocalOozie.java
+++ b/core/src/main/java/org/apache/oozie/local/LocalOozie.java
@@ -252,6 +252,7 @@ public class LocalOozie {
* {@link org.apache.oozie.client.OozieClient#getHeaders},
* {@link org.apache.oozie.client.OozieClient#getClientBuildVersion}.
*
+ * @param user user
* @return a {@link org.apache.oozie.client.OozieClient} for LocalOozie.
*/
public static OozieClient getClientBundle(String user) {
diff --git a/core/src/main/java/org/apache/oozie/service/AuthorizationService.java b/core/src/main/java/org/apache/oozie/service/AuthorizationService.java
index 6f72c41..2c19aa2 100644
--- a/core/src/main/java/org/apache/oozie/service/AuthorizationService.java
+++ b/core/src/main/java/org/apache/oozie/service/AuthorizationService.java
@@ -267,8 +267,8 @@ public class AuthorizationService implements Service {
}
/**
- * Check if the user belongs to the group or not. <p> <p> Subclasses should override the {@link #isUserInGroup}
- * method.
+ * Check if the user belongs to the group or not. <p> Subclasses should override the {@link #isUserInGroup}
+ * method. <p>
*
* @param user user name.
* @param group group name.
@@ -362,6 +362,7 @@ public class AuthorizationService implements Service {
* @param user user name.
* @param group group name.
* @param appPath application path.
+ * @param jobConf job configuration
* @throws AuthorizationException thrown if the user is not authorized for the app.
*/
public void authorizeForApp(String user, String group, String appPath, Configuration jobConf)
@@ -411,7 +412,7 @@ public class AuthorizationService implements Service {
* @param group group name.
* @param appPath application path.
* @param fileName workflow or coordinator.xml
- * @param conf
+ * @param conf configuration
* @throws AuthorizationException thrown if the user is not authorized for the app.
*/
public void authorizeForApp(String user, String group, String appPath, String fileName, Configuration conf)
@@ -562,6 +563,7 @@ public class AuthorizationService implements Service {
*
* @param user user name.
* @param filter filter used to select jobs
+ * @param jobType job type
* @param start starting index of the jobs in DB
* @param len maximum amount of jobs to select
* @param write indicates if the check is for read or write job tasks.
diff --git a/core/src/main/java/org/apache/oozie/service/CallableQueueService.java b/core/src/main/java/org/apache/oozie/service/CallableQueueService.java
index a942600..d1222bc 100644
--- a/core/src/main/java/org/apache/oozie/service/CallableQueueService.java
+++ b/core/src/main/java/org/apache/oozie/service/CallableQueueService.java
@@ -771,8 +771,11 @@ public class CallableQueueService implements Service, Instrumentable {
/**
* check the interrupt map for the existence of an interrupt commands if
- * exist a List of Interrupt Callable for the same lock key will bereturned,
+ * exist a List of Interrupt Callable for the same lock key will be returned,
* otherwise it will return null
+ *
+ * @param lockKey key to check
+ * @return Set of interrupt callables
*/
public Set<XCallable<?>> checkInterrupts(String lockKey) {
@@ -786,7 +789,7 @@ public class CallableQueueService implements Service, Instrumentable {
* check if the callable is of an interrupt type and insert it into the map
* accordingly
*
- * @param callable
+ * @param callable callable
*/
public void checkInterruptTypes(XCallable<?> callable) {
if ((callable instanceof CompositeCallable) && (((CompositeCallable) callable).getCallables() != null)) {
@@ -805,7 +808,7 @@ public class CallableQueueService implements Service, Instrumentable {
* insert a new callable in the Interrupt Command Map add a new element to
* the list or create a new list accordingly
*
- * @param callable
+ * @param callable callable
*/
public void insertCallableIntoInterruptMap(XCallable<?> callable) {
if (interruptCommandsMap.size() < interruptMapMaxSize) {
diff --git a/core/src/main/java/org/apache/oozie/service/HadoopAccessorService.java b/core/src/main/java/org/apache/oozie/service/HadoopAccessorService.java
index 05cdc55..5cab847 100644
--- a/core/src/main/java/org/apache/oozie/service/HadoopAccessorService.java
+++ b/core/src/main/java/org/apache/oozie/service/HadoopAccessorService.java
@@ -509,6 +509,7 @@ public class HadoopAccessorService implements Service {
* Return a JobClient created with the provided user/group.
*
*
+ * @param user user
* @param conf JobConf with all necessary information to create the
* JobClient.
* @return JobClient created with the provided user/group.
@@ -539,6 +540,7 @@ public class HadoopAccessorService implements Service {
* Return a JobClient created with the provided user/group.
*
*
+ * @param user user
* @param conf Configuration with all necessary information to create the
* JobClient.
* @return JobClient created with the provided user/group.
@@ -633,8 +635,8 @@ public class HadoopAccessorService implements Service {
/**
* Validate Job tracker
- * @param jobTrackerUri
- * @throws HadoopAccessorException
+ * @param jobTrackerUri job tracker uri
+ * @throws HadoopAccessorException if job tracker cannot be reached
*/
protected void validateJobTracker(String jobTrackerUri) throws HadoopAccessorException {
validate(jobTrackerUri, jobTrackerWhitelist, ErrorCode.E0900);
@@ -642,8 +644,8 @@ public class HadoopAccessorService implements Service {
/**
* Validate Namenode list
- * @param nameNodeUri
- * @throws HadoopAccessorException
+ * @param nameNodeUri name node uri
+ * @throws HadoopAccessorException if NN cannot be reached
*/
protected void validateNameNode(String nameNodeUri) throws HadoopAccessorException {
validate(nameNodeUri, nameNodeWhitelist, ErrorCode.E0901);
@@ -681,6 +683,9 @@ public class HadoopAccessorService implements Service {
/**
* checks configuration parameter if filesystem scheme is among the list of supported ones
* this makes system robust to filesystems other than HDFS also
+ *
+ * @param uri uri
+ * @throws HadoopAccessorException if scheme is not supported
*/
public void checkSupportedFilesystem(URI uri) throws HadoopAccessorException {
diff --git a/core/src/main/java/org/apache/oozie/service/JMSTopicService.java b/core/src/main/java/org/apache/oozie/service/JMSTopicService.java
index a28330b..bc1dc26 100644
--- a/core/src/main/java/org/apache/oozie/service/JMSTopicService.java
+++ b/core/src/main/java/org/apache/oozie/service/JMSTopicService.java
@@ -143,9 +143,9 @@ public class JMSTopicService implements Service {
/**
* Retrieve topic from Job id
- * @param jobId
+ * @param jobId job id
* @return topicPrefix + topicName Retrieve topic from Job id
- * @throws JPAExecutorException
+ * @throws JPAExecutorException if JPA executor has a problem
*/
public String getTopic(String jobId) throws JPAExecutorException {
String topicName = null;
@@ -177,10 +177,10 @@ public class JMSTopicService implements Service {
/**
* Retrieve Topic
*
- * @param appType
- * @param user
- * @param jobId
- * @param parentJobId
+ * @param appType application type
+ * @param user user
+ * @param jobId job id
+ * @param parentJobId parent job id
* @return topicName
*/
diff --git a/core/src/main/java/org/apache/oozie/service/JPAService.java b/core/src/main/java/org/apache/oozie/service/JPAService.java
index cefcb43..4abc262 100644
--- a/core/src/main/java/org/apache/oozie/service/JPAService.java
+++ b/core/src/main/java/org/apache/oozie/service/JPAService.java
@@ -314,6 +314,7 @@ public class JPAService implements Service, Instrumentable {
/**
* Execute a {@link JPAExecutor}.
*
+ * @param <T> type of executor's result
* @param executor JPAExecutor to execute.
* @return return value of the JPAExecutor.
* @throws JPAExecutorException thrown if an jpa executor failed
@@ -392,7 +393,7 @@ public class JPAService implements Service, Instrumentable {
* @param query query instance to be executed
* @param em Entity Manager
* @return Integer that query returns, which corresponds to the number of rows updated
- * @throws JPAExecutorException
+ * @throws JPAExecutorException if JPA executor has problem
*/
public int executeUpdate(final String namedQueryName, final Query query, final EntityManager em) throws JPAExecutorException {
final Instrumentation.Cron cron = new Instrumentation.Cron();
@@ -483,7 +484,7 @@ public class JPAService implements Service, Instrumentable {
* @param updateQueryList list of update queries
* @param deleteBeans list of beans to be deleted
* @param em Entity Manager
- * @throws JPAExecutorException
+ * @throws JPAExecutorException if JPA executor has problem
*/
public void executeBatchInsertUpdateDelete(final Collection<JsonBean> insertBeans, final List<QueryEntry> updateQueryList,
final Collection<JsonBean> deleteBeans, final EntityManager em) throws JPAExecutorException {
@@ -548,6 +549,7 @@ public class JPAService implements Service, Instrumentable {
* @param query query instance to be executed
* @param em Entity Manager
* @return object that matches the query
+ * @throws JPAExecutorException if JPA executor has problem
*/
public Object executeGet(final String namedQueryName, final Query query, final EntityManager em) throws JPAExecutorException {
final Instrumentation.Cron cron = new Instrumentation.Cron();
@@ -588,6 +590,7 @@ public class JPAService implements Service, Instrumentable {
* @param query query instance to be executed
* @param em Entity Manager
* @return list containing results that match the query
+ * @throws JPAExecutorException if JPA executor has problem
*/
public List<?> executeGetList(final String namedQueryName, final Query query, final EntityManager em)
throws JPAExecutorException {
diff --git a/core/src/main/java/org/apache/oozie/service/MetricsInstrumentationService.java b/core/src/main/java/org/apache/oozie/service/MetricsInstrumentationService.java
index b57a2a5..24e168d 100644
--- a/core/src/main/java/org/apache/oozie/service/MetricsInstrumentationService.java
+++ b/core/src/main/java/org/apache/oozie/service/MetricsInstrumentationService.java
@@ -35,7 +35,7 @@ public class MetricsInstrumentationService extends InstrumentationService {
* Initialize the metrics instrumentation service.
*
* @param services services instance.
- * @throws org.apache.oozie.service.ServiceException
+ * @throws org.apache.oozie.service.ServiceException if logging cannot be initialised
*/
@Override
public void init(Services services) throws ServiceException {
diff --git a/core/src/main/java/org/apache/oozie/service/ProxyUserService.java b/core/src/main/java/org/apache/oozie/service/ProxyUserService.java
index 4bfd527..fb86140 100644
--- a/core/src/main/java/org/apache/oozie/service/ProxyUserService.java
+++ b/core/src/main/java/org/apache/oozie/service/ProxyUserService.java
@@ -37,13 +37,12 @@ import java.util.Set;
* The ProxyUserService checks if a user of a request has proxyuser privileges.
* <p>
* This check is based on the following criteria:
- * <p>
+ * </p>
* <ul>
* <li>The user of the request must be configured as proxy user in Oozie configuration.</li>
* <li>The user of the request must be making the request from a whitelisted host.</li>
* <li>The user of the request must be making the request on behalf of a user of a whitelisted group.</li>
* </ul>
- * <p>
*/
public class ProxyUserService implements Service {
private static XLog LOG = XLog.getLog(ProxyUserService.class);
diff --git a/core/src/main/java/org/apache/oozie/service/SLAStoreService.java b/core/src/main/java/org/apache/oozie/service/SLAStoreService.java
index 02899cc..160329c 100644
--- a/core/src/main/java/org/apache/oozie/service/SLAStoreService.java
+++ b/core/src/main/java/org/apache/oozie/service/SLAStoreService.java
@@ -57,6 +57,8 @@ public class SLAStoreService implements Service {
* Return a SLA store instance with an existing transaction. <p> The SLA store has to be committed and then closed
* to commit changes, if only close it rolls back.
*
+ * @param <S> child type of Store
+ * @param store store definition
* @return a SLA store.
* @throws StoreException thrown if the SLA store could not be created.
*/
diff --git a/core/src/main/java/org/apache/oozie/service/SchedulerService.java b/core/src/main/java/org/apache/oozie/service/SchedulerService.java
index 81fbc0d..29e3727 100644
--- a/core/src/main/java/org/apache/oozie/service/SchedulerService.java
+++ b/core/src/main/java/org/apache/oozie/service/SchedulerService.java
@@ -95,7 +95,7 @@ public class SchedulerService implements Service {
/**
* Return the number of threads configured with the Scheduler Service
- * @param conf
+ * @param conf configuration
* @return int num threads
*/
public int getSchedulableThreads(Configuration conf) {
diff --git a/core/src/main/java/org/apache/oozie/service/SchemaService.java b/core/src/main/java/org/apache/oozie/service/SchemaService.java
index 14d1eeb..e1b2691 100644
--- a/core/src/main/java/org/apache/oozie/service/SchemaService.java
+++ b/core/src/main/java/org/apache/oozie/service/SchemaService.java
@@ -216,9 +216,9 @@ public class SchemaService implements Service {
/**
* Returns validator for schema
- * @param schemaName
- * @return
- * @throws SAXException
+ * @param schemaName schema name
+ * @return Validator
+ * @throws SAXException if XML parsing fails
*/
public Validator getValidator(SchemaName schemaName) throws SAXException {
return getValidator(getSchema(schemaName));
@@ -226,9 +226,9 @@ public class SchemaService implements Service {
/**
* Returns validator for schema
- * @param schema
- * @return
- * @throws SAXException
+ * @param schema schema
+ * @return Validator
+ * @throws SAXException if XML parsing fails
*/
public static Validator getValidator(Schema schema) throws SAXException {
Validator validator = schema.newValidator();
diff --git a/core/src/main/java/org/apache/oozie/service/Services.java b/core/src/main/java/org/apache/oozie/service/Services.java
index 7391605..5e40f88 100644
--- a/core/src/main/java/org/apache/oozie/service/Services.java
+++ b/core/src/main/java/org/apache/oozie/service/Services.java
@@ -352,6 +352,7 @@ public class Services {
/**
* Return a service by its public interface.
*
+ * @param <T> child type of Service
* @param serviceKlass service public interface.
* @return the associated service, or <code>null</code> if not define.
*/
diff --git a/core/src/main/java/org/apache/oozie/service/StoreService.java b/core/src/main/java/org/apache/oozie/service/StoreService.java
index 7868e02..ff7ce1d 100644
--- a/core/src/main/java/org/apache/oozie/service/StoreService.java
+++ b/core/src/main/java/org/apache/oozie/service/StoreService.java
@@ -33,7 +33,10 @@ public class StoreService implements Service {
/**
* Return instance of store.
*
+ * @param <S> child type of Store
+ * @param klass store class for this given Store
* @return {@link Store}.
+ * @throws StoreException if Store cannot be retrieved
*/
@SuppressWarnings("unchecked")
public <S extends Store> S getStore(Class<S> klass) throws StoreException {
@@ -50,7 +53,12 @@ public class StoreService implements Service {
/**
* Return instance of store with an EntityManager pointing to an existing Store.
*
+ * @param <S> child type of Store
+ * @param <T> child type of Store
+ * @param klass store class for this given Store
+ * @param store store instance
* @return {@link Store}.
+ * @throws StoreException if Store cannot be retrieved
*/
@SuppressWarnings("unchecked")
public <S extends Store, T extends Store> S getStore(Class<S> klass, T store) throws StoreException {
@@ -78,6 +86,7 @@ public class StoreService implements Service {
* Initializes the {@link StoreService}.
*
* @param services services instance.
+ * @throws ServiceException if JPAService is not available
*/
public void init(Services services) throws ServiceException {
jpaService = Services.get().get(JPAService.class);
@@ -94,6 +103,8 @@ public class StoreService implements Service {
/**
* Return EntityManager
+ *
+ * @return EntityManager of JPA service
*/
public EntityManager getEntityManager() {
return jpaService.getEntityManager();
diff --git a/core/src/main/java/org/apache/oozie/service/URIHandlerService.java b/core/src/main/java/org/apache/oozie/service/URIHandlerService.java
index c4a3701..8872407 100644
--- a/core/src/main/java/org/apache/oozie/service/URIHandlerService.java
+++ b/core/src/main/java/org/apache/oozie/service/URIHandlerService.java
@@ -193,7 +193,7 @@ public class URIHandlerService implements Service {
* Get the URI with scheme://host:port removing the path
* @param uri uri template
* @return URI with authority and scheme
- * @throws URIHandlerException
+ * @throws URIHandlerException if the provided uri is malformed
*/
public URI getAuthorityWithScheme(String uri) throws URIHandlerException {
int index = uri.indexOf("://");
diff --git a/core/src/main/java/org/apache/oozie/service/WorkflowAppService.java b/core/src/main/java/org/apache/oozie/service/WorkflowAppService.java
index 17d1d2e..b7eb950 100644
--- a/core/src/main/java/org/apache/oozie/service/WorkflowAppService.java
+++ b/core/src/main/java/org/apache/oozie/service/WorkflowAppService.java
@@ -107,6 +107,7 @@ public abstract class WorkflowAppService implements Service {
*
* @param appPath application path.
* @param user user name.
+ * @param conf configuration
* @return workflow definition.
* @throws WorkflowException thrown if the definition could not be read.
*/
@@ -262,9 +263,9 @@ public abstract class WorkflowAppService implements Service {
/**
* Parse workflow definition.
*
- * @param jobConf
+ * @param jobConf job configuration
* @return WorkflowApp
- * @throws WorkflowException
+ * @throws WorkflowException thrown if the workflow application could not be parsed.
*/
public abstract WorkflowApp parseDef(Configuration jobConf) throws WorkflowException;
@@ -275,7 +276,7 @@ public abstract class WorkflowAppService implements Service {
* @param configDefault config from config-default.xml
* @return workflow application thrown if the workflow application could not
* be parsed
- * @throws WorkflowException
+ * @throws WorkflowException thrown if the workflow application could not be parsed.
*/
public abstract WorkflowApp parseDef(Configuration jobConf, Configuration configDefault) throws WorkflowException;
diff --git a/core/src/main/java/org/apache/oozie/service/WorkflowStoreService.java b/core/src/main/java/org/apache/oozie/service/WorkflowStoreService.java
index 72e0fe4..ef744d7 100644
--- a/core/src/main/java/org/apache/oozie/service/WorkflowStoreService.java
+++ b/core/src/main/java/org/apache/oozie/service/WorkflowStoreService.java
@@ -70,6 +70,8 @@ public abstract class WorkflowStoreService implements Service {
* Return a workflow store instance with an existing transaction. <p> The workflow store has to be committed and
* then closed to commit changes, if only close it rolls back.
*
+ * @param <S> child type of Store
+ * @param store store instance
* @return a workflow store.
* @throws StoreException thrown if the workflow store could not be created.
*/
diff --git a/core/src/main/java/org/apache/oozie/service/XLogService.java b/core/src/main/java/org/apache/oozie/service/XLogService.java
index 1ac82f5..2599045 100644
--- a/core/src/main/java/org/apache/oozie/service/XLogService.java
+++ b/core/src/main/java/org/apache/oozie/service/XLogService.java
@@ -56,7 +56,6 @@ import java.util.Map;
* the automatic reloading interval is defined by the Java System property <code>oozie.log4j.reload</code>. The default
* value is 10 seconds.
* <p>
- * <p>
* Unlike most of the other Services, XLogService isn't easily overridable because Services depends on XLogService being available
*/
public class XLogService implements Service, Instrumentable {
diff --git a/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java b/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java
index 85610eb..3fcf4a4 100644
--- a/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java
@@ -103,6 +103,7 @@ public abstract class BaseAdminServlet extends JsonRestServlet {
* Get JMS connection Info
* @param request the request
* @param response the response
+ * @return connection information in a form of a JsonBean
* @throws XServletException in case of any servlet error
* @throws IOException in case of any IO error
*/
diff --git a/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java b/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java
index 3145650..dad4a10 100644
--- a/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java
@@ -421,6 +421,7 @@ public abstract class BaseJobServlet extends JsonRestServlet {
*
* @param request the request
* @param response the response
+ * @return a json object about the killed job, depends on implementation
* @throws XServletException in case of any servlet error
* @throws IOException in case of any I/O error
*/
@@ -444,6 +445,7 @@ public abstract class BaseJobServlet extends JsonRestServlet {
* @param request the request
* @param response the response
* @param conf the configuration to use
+ * @return a json object about the rerun job, depends on implementation
* @throws XServletException in case of any servlet error
* @throws IOException in case of any I/O error
*/
@@ -515,6 +517,7 @@ public abstract class BaseJobServlet extends JsonRestServlet {
* abstract method to get JMS topic name for a job
* @param request the request
* @param response the response
+ * @return the name of the JMS topic
* @throws XServletException in case of any servlet error
* @throws IOException in case of any I/O error
*/
diff --git a/core/src/main/java/org/apache/oozie/servlet/BaseJobsServlet.java b/core/src/main/java/org/apache/oozie/servlet/BaseJobsServlet.java
index f351ae7..95c65fe 100644
--- a/core/src/main/java/org/apache/oozie/servlet/BaseJobsServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/BaseJobsServlet.java
@@ -222,11 +222,11 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
/**
* abstract method to kill jobs based ona filter param. The jobs could be workflow, coordinator or bundle jobs
*
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return JSONObject of all jobs being killed
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject killJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
IOException;
@@ -234,11 +234,11 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
/**
* abstract method to suspend jobs based ona filter param. The jobs could be workflow, coordinator or bundle jobs
*
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return JSONObject of all jobs being suspended
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject suspendJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
IOException;
@@ -246,11 +246,11 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
/**
* abstract method to resume jobs based ona filter param. The jobs could be workflow, coordinator or bundle jobs
*
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return JSONObject of all jobs being resumed
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject resumeJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
IOException;
@@ -258,11 +258,11 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
* abstract method to submit a job, either workflow or coordinator in the case of workflow job, there is an optional
* flag in request to indicate if want this job to be started immediately or not
*
- * @param request
- * @param conf
+ * @param request the request
+ * @param conf the job configuration
* @return JSONObject of job id
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject submitJob(HttpServletRequest request, Configuration conf)
throws XServletException, IOException;
@@ -270,11 +270,11 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
/**
* abstract method to get a job from external ID
*
- * @param request
- * @param externalId
+ * @param request the request
+ * @param externalId the external id you you want the job id from
* @return JSONObject for the requested job
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject getJobIdForExternalId(HttpServletRequest request,
String externalId) throws XServletException, IOException;
@@ -282,10 +282,10 @@ public abstract class BaseJobsServlet extends JsonRestServlet {
/**
* abstract method to get a list of workflow jobs
*
- * @param request
+ * @param request the request
* @return JSONObject of the requested jobs
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException depends on implementation
+ * @throws IOException depends on implementation
*/
abstract JSONObject getJobs(HttpServletRequest request)
throws XServletException, IOException;
diff --git a/core/src/main/java/org/apache/oozie/servlet/V0JobsServlet.java b/core/src/main/java/org/apache/oozie/servlet/V0JobsServlet.java
index 0ff9c6a..94961dd 100644
--- a/core/src/main/java/org/apache/oozie/servlet/V0JobsServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/V0JobsServlet.java
@@ -126,40 +126,34 @@ public class V0JobsServlet extends BaseJobsServlet {
/**
* service implementation to bulk kill jobs
- * @param request
- * @param response
- * @throws XServletException
- * @throws IOException
+ * @param request the request
+ * @param response the response
+ * @return nothing, throws UnsupportedOperationException
*/
@Override
- protected JSONObject killJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
- IOException {
+ protected JSONObject killJobs(HttpServletRequest request, HttpServletResponse response) {
throw new UnsupportedOperationException("method not implemented in V0 API");
}
/**
* service implementation to bulk suspend jobs
- * @param request
- * @param response
- * @throws XServletException
- * @throws IOException
+ * @param request the request
+ * @param response the response
+ * @return nothing, throws UnsupportedOperationException
*/
@Override
- protected JSONObject suspendJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
- IOException {
+ protected JSONObject suspendJobs(HttpServletRequest request, HttpServletResponse response) {
throw new UnsupportedOperationException("method not implemented in V0 API");
}
/**
* service implementation to bulk resume jobs
- * @param request
- * @param response
- * @throws XServletException
- * @throws IOException
+ * @param request the request
+ * @param response the response
+ * @return nothing, throws UnsupportedOperationException
*/
@Override
- protected JSONObject resumeJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
- IOException {
+ protected JSONObject resumeJobs(HttpServletRequest request, HttpServletResponse response) {
throw new UnsupportedOperationException("method not implemented in V0 API");
}
}
diff --git a/core/src/main/java/org/apache/oozie/servlet/V1AdminServlet.java b/core/src/main/java/org/apache/oozie/servlet/V1AdminServlet.java
index 8eb6ee1..812b385 100644
--- a/core/src/main/java/org/apache/oozie/servlet/V1AdminServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/V1AdminServlet.java
@@ -103,8 +103,7 @@ public class V1AdminServlet extends BaseAdminServlet {
* @param json the result json object that contains a JSONArray for the callable dump
*
* @see
- * org.apache.oozie.servlet.BaseAdminServlet#getQueueDump(org.json.simple
- * .JSONObject)
+ * org.apache.oozie.servlet.BaseAdminServlet#getQueueDump(org.json.simple.JSONObject)
*/
@SuppressWarnings("unchecked")
@Override
diff --git a/core/src/main/java/org/apache/oozie/servlet/V1JobServlet.java b/core/src/main/java/org/apache/oozie/servlet/V1JobServlet.java
index 9acd571..aa443bb 100644
--- a/core/src/main/java/org/apache/oozie/servlet/V1JobServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/V1JobServlet.java
@@ -173,8 +173,8 @@ public class V1JobServlet extends BaseJobServlet {
* protected method to change a coordinator job
* @param request request object
* @param response response object
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if BundleEngineException or CoordinatorEngineException occurs
+ * @throws IOException in case of parsing error
*/
@Override
protected void changeJob(HttpServletRequest request, HttpServletResponse response) throws XServletException,
@@ -388,7 +388,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private void startWorkflowJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
DagEngine dagEngine = Services.get().get(DagEngineService.class).getDagEngine(getUser(request));
@@ -407,7 +407,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private void startBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
@@ -425,7 +425,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private void resumeWorkflowJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
DagEngine dagEngine = Services.get().get(DagEngineService.class).getDagEngine(getUser(request));
@@ -444,7 +444,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private void resumeBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
@@ -462,8 +462,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
- * @throws CoordinatorEngineException
+ * @throws XServletException in case if CoordinatorEngineException occurs
*/
private void resumeCoordinatorJob(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -483,7 +482,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private void suspendWorkflowJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
DagEngine dagEngine = Services.get().get(DagEngineService.class).getDagEngine(getUser(request));
@@ -502,7 +501,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private void suspendBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
@@ -520,7 +519,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if CoordinatorEngineException occurs
*/
private void suspendCoordinatorJob(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -539,7 +538,7 @@ public class V1JobServlet extends BaseJobServlet {
* Kill a wf job
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private void killWorkflowJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
DagEngine dagEngine = Services.get().get(DagEngineService.class).getDagEngine(getUser(request));
@@ -558,7 +557,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if CoordinatorEngineException or CommandException occurs
*/
@SuppressWarnings("unchecked")
private JSONObject killCoordinator(HttpServletRequest request, HttpServletResponse response) throws XServletException {
@@ -600,7 +599,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private void killBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
@@ -618,7 +617,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if CoordinatorEngineException occurs
*/
private void changeCoordinatorJob(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -639,7 +638,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private void changeBundleJob(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -660,7 +659,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @param conf configuration object
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private void reRunWorkflowJob(HttpServletRequest request, HttpServletResponse response, Configuration conf)
throws XServletException {
@@ -681,7 +680,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @param conf configration object
- * @throws XServletException
+ * @throws XServletException in case if BaseEngineException occurs
*/
private void rerunBundleJob(HttpServletRequest request, HttpServletResponse response, Configuration conf)
throws XServletException {
@@ -711,7 +710,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @param conf configuration object
- * @throws XServletException
+ * @throws XServletException in case if BaseEngineException or CommandException occurs
*/
@SuppressWarnings("unchecked")
private JSONObject reRunCoordinatorActions(HttpServletRequest request, HttpServletResponse response,
@@ -760,7 +759,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean WorkflowJobBean
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
protected JsonBean getWorkflowJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
JsonBean jobBean = getWorkflowJobBean(request, response);
@@ -775,7 +774,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean WorkflowJobBean
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
protected JsonBean getWorkflowJobBean(HttpServletRequest request, HttpServletResponse response) throws XServletException {
JsonBean jobBean;
@@ -834,7 +833,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean WorkflowActionBean
- * @throws XServletException
+ * @throws XServletException in case if BaseEngineException occurs
*/
protected JsonBean getWorkflowAction(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -865,8 +864,8 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean CoordinatorJobBean
- * @throws XServletException
- * @throws BaseEngineException
+ * @throws XServletException in case if CoordinatorEngineException occurs
+ * @throws BaseEngineException if CommandException occurs
*/
protected JsonBean getCoordinatorJob(HttpServletRequest request, HttpServletResponse response)
throws XServletException, BaseEngineException {
@@ -914,11 +913,9 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean bundle job bean
- * @throws XServletException
- * @throws BaseEngineException
+ * @throws XServletException in case if BundleEngineException occurs
*/
- private JsonBean getBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException,
- BaseEngineException {
+ private JsonBean getBundleJob(HttpServletRequest request, HttpServletResponse response) throws XServletException {
JsonBean jobBean;
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
String jobId = getResourceName(request);
@@ -939,8 +936,8 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return JsonBean CoordinatorActionBean
- * @throws XServletException
- * @throws BaseEngineException
+ * @throws XServletException in case if CoordinatorEngineException occurs
+ * @throws BaseEngineException if CommandException occurs
*/
private JsonBean getCoordinatorAction(HttpServletRequest request, HttpServletResponse response)
throws XServletException, BaseEngineException {
@@ -964,7 +961,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return String wf definition
- * @throws XServletException
+ * @throws XServletException in case if DagEngineException occurs
*/
private String getWorkflowJobDefinition(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -987,7 +984,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return String bundle definition
- * @throws XServletException
+ * @throws XServletException in case if BundleEngineException occurs
*/
private String getBundleJobDefinition(HttpServletRequest request, HttpServletResponse response) throws XServletException {
BundleEngine bundleEngine = Services.get().get(BundleEngineService.class).getBundleEngine(getUser(request));
@@ -1008,7 +1005,7 @@ public class V1JobServlet extends BaseJobServlet {
* @param request servlet request
* @param response servlet response
* @return String coord definition
- * @throws XServletException
+ * @throws XServletException in case if BaseEngineException occurs
*/
private String getCoordinatorJobDefinition(HttpServletRequest request, HttpServletResponse response)
throws XServletException {
@@ -1033,8 +1030,8 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if BaseEngineException occurs
+ * @throws IOException in case of parsing error
*/
private void streamWorkflowJobLog(HttpServletRequest request, HttpServletResponse response)
throws XServletException, IOException {
@@ -1053,7 +1050,7 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if BaseEngineException occurs
*/
private void streamBundleJobLog(HttpServletRequest request, HttpServletResponse response)
throws XServletException, IOException {
@@ -1072,8 +1069,8 @@ public class V1JobServlet extends BaseJobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if BaseEngineException or CommandException occurs
+ * @throws IOException in case of parsing error
*/
private void streamCoordinatorJobLog(HttpServletRequest request, HttpServletResponse response)
throws XServletException, IOException {
diff --git a/core/src/main/java/org/apache/oozie/servlet/V1JobsServlet.java b/core/src/main/java/org/apache/oozie/servlet/V1JobsServlet.java
index a582b1b..931864d 100644
--- a/core/src/main/java/org/apache/oozie/servlet/V1JobsServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/V1JobsServlet.java
@@ -584,11 +584,12 @@ public class V1JobsServlet extends BaseJobsServlet {
/**
* service implementation to bulk kill jobs
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return bulkModifyJobs implementation to bulk kill jobs
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if
+ * BundleEngineException or CoordinatorEngineException or DagEngineException occurs
+ * @throws IOException in case of parsing error
*/
@Override
protected JSONObject killJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
@@ -598,11 +599,12 @@ public class V1JobsServlet extends BaseJobsServlet {
/**
* service implementation to bulk suspend jobs
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return bulkModifyJobs implementation to bulk suspend jobs
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if
+ * BundleEngineException or CoordinatorEngineException or DagEngineException occurs
+ * @throws IOException in case of parsing error
*/
@Override
protected JSONObject suspendJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
@@ -612,11 +614,12 @@ public class V1JobsServlet extends BaseJobsServlet {
/**
* service implementation to bulk resume jobs
- * @param request
- * @param response
+ * @param request the request
+ * @param response the response
* @return bulkModifyJobs implementation to bulk resume jobs
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if
+ * BundleEngineException or CoordinatorEngineException or DagEngineException occurs
+ * @throws IOException in case of parsing error
*/
@Override
protected JSONObject resumeJobs(HttpServletRequest request, HttpServletResponse response) throws XServletException,
diff --git a/core/src/main/java/org/apache/oozie/servlet/V2JobServlet.java b/core/src/main/java/org/apache/oozie/servlet/V2JobServlet.java
index c2b90c1..d05b4c0 100644
--- a/core/src/main/java/org/apache/oozie/servlet/V2JobServlet.java
+++ b/core/src/main/java/org/apache/oozie/servlet/V2JobServlet.java
@@ -142,8 +142,8 @@ public class V2JobServlet extends V1JobServlet {
* Ignore a coordinator job
* @param request request object
* @param response response object
- * @throws XServletException
- * @throws IOException
+ * @throws XServletException in case if CoordinatorEngineException occurs
+ * @throws IOException in case of parsing error
*/
@Override
protected JSONObject ignoreJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException {
@@ -210,7 +210,7 @@ public class V2JobServlet extends V1JobServlet {
*
* @param request servlet request
* @param response servlet response
- * @throws XServletException
+ * @throws XServletException in case if CoordinatorEngineException or CommandException occurs
*/
@SuppressWarnings("unchecked")
private JSONObject ignoreCoordinatorJob(HttpServletRequest request, HttpServletResponse response)
diff --git a/core/src/main/java/org/apache/oozie/sla/SLACalcStatus.java b/core/src/main/java/org/apache/oozie/sla/SLACalcStatus.java
index 3d7d6e8..a9dd956 100644
--- a/core/src/main/java/org/apache/oozie/sla/SLACalcStatus.java
+++ b/core/src/main/java/org/apache/oozie/sla/SLACalcStatus.java
@@ -77,6 +77,8 @@ public class SLACalcStatus extends SLAEvent {
/**
* copy constructor
+ *
+ * @param a use this to create a copy from
*/
public SLACalcStatus(SLACalcStatus a) {
this();
diff --git a/core/src/main/java/org/apache/oozie/sla/SLACalculator.java b/core/src/main/java/org/apache/oozie/sla/SLACalculator.java
index db71865..6e4fe20 100644
--- a/core/src/main/java/org/apache/oozie/sla/SLACalculator.java
+++ b/core/src/main/java/org/apache/oozie/sla/SLACalculator.java
@@ -68,8 +68,8 @@ public interface SLACalculator {
* Enable sla alert for child jobs.
* @param parentJobIds the parent job ids
* @return true if successful
- * @throws JPAExecutorException
- * @throws ServiceException
+ * @throws JPAExecutorException the JPA executor exception
+ * @throws ServiceException the service exception
*/
boolean enableChildJobAlert(List<String> parentJobIds) throws JPAExecutorException, ServiceException;
@@ -88,8 +88,8 @@ public interface SLACalculator {
* Disable Sla alert for child jobs.
* @param parentJobIds the parent job ids
* @return true if successful
- * @throws JPAExecutorException
- * @throws ServiceException
+ * @throws JPAExecutorException the JPA executor exception
+ * @throws ServiceException the service exception
*/
boolean disableChildJobAlert(List<String> parentJobIds) throws JPAExecutorException, ServiceException;
diff --git a/core/src/main/java/org/apache/oozie/sla/SLAOperations.java b/core/src/main/java/org/apache/oozie/sla/SLAOperations.java
index 3905003..8342189 100644
--- a/core/src/main/java/org/apache/oozie/sla/SLAOperations.java
+++ b/core/src/main/java/org/apache/oozie/sla/SLAOperations.java
@@ -195,8 +195,8 @@ public class SLAOperations {
/**
* Retrieve registration event
* @param jobId the jobId
- * @throws CommandException
- * @throws JPAExecutorException
+ * @throws CommandException update failure
+ * @throws JPAExecutorException if JPA related issue occurs
*/
public static void updateRegistrationEvent(String jobId) throws CommandException, JPAExecutorException {
SLAService slaService = Services.get().get(SLAService.class);
diff --git a/core/src/main/java/org/apache/oozie/sla/listener/SLAEventListener.java b/core/src/main/java/org/apache/oozie/sla/listener/SLAEventListener.java
index ab77104..6c86340 100644
--- a/core/src/main/java/org/apache/oozie/sla/listener/SLAEventListener.java
+++ b/core/src/main/java/org/apache/oozie/sla/listener/SLAEventListener.java
@@ -29,7 +29,8 @@ public abstract class SLAEventListener {
/**
* Initialize the listener
- * @param conf
+ * @param conf configuration
+ * @throws Exception if init fails
*/
public abstract void init(Configuration conf) throws Exception;
@@ -40,37 +41,37 @@ public abstract class SLAEventListener {
/**
* on SLA job start-time limit met
- * @param work
+ * @param work event
*/
public abstract void onStartMet(SLAEvent work);
/**
* on SLA job start-time limit missed
- * @param event
+ * @param event event
*/
public abstract void onStartMiss(SLAEvent event);
/**
* on SLA job end-time limit met
- * @param work
+ * @param work event
*/
public abstract void onEndMet(SLAEvent work);
/**
* on SLA job end-time limit missed
- * @param event
+ * @param event event
*/
public abstract void onEndMiss(SLAEvent event);
/**
* on SLA job duration limit met
- * @param work
+ * @param work event
*/
public abstract void onDurationMet(SLAEvent work);
/**
* on SLA job duration limit missed
- * @param event
+ * @param event event
*/
public abstract void onDurationMiss(SLAEvent event);
diff --git a/core/src/main/java/org/apache/oozie/store/OozieSchema.java b/core/src/main/java/org/apache/oozie/store/OozieSchema.java
index ea785d3..c3a10d6 100644
--- a/core/src/main/java/org/apache/oozie/store/OozieSchema.java
+++ b/core/src/main/java/org/apache/oozie/store/OozieSchema.java
@@ -197,8 +197,8 @@ public class OozieSchema {
/**
* Generates the create table SQL Statement
*
- * @param table
- * @param dbType
+ * @param table table
+ * @param dbType database type
* @return SQL Statement to create the table
*/
public static String generateCreateTableScript(Table table, DBType dbType) {
@@ -208,7 +208,7 @@ public class OozieSchema {
/**
* Gets the query that will be used to validate the connection
*
- * @param dbName
+ * @param dbName database name
* @return String returns the query that will be used to validate the connection
*/
public static String getValidationQuery(String dbName) {
@@ -219,7 +219,7 @@ public class OozieSchema {
/**
* Generates the Insert statement to insert the OOZIE_VERSION to table
*
- * @param dbName
+ * @param dbName database name
* @return String returns the Insert statement for the OOZIE_VERSION to a table
*/
public static String generateInsertVersionScript(String dbName) {
diff --git a/core/src/main/java/org/apache/oozie/store/SLAStore.java b/core/src/main/java/org/apache/oozie/store/SLAStore.java
index 34f47fb..5c19f0a 100644
--- a/core/src/main/java/org/apache/oozie/store/SLAStore.java
+++ b/core/src/main/java/org/apache/oozie/store/SLAStore.java
@@ -54,7 +54,7 @@ public class SLAStore extends Store {
* Create an SLAEventBeane. It also creates the process instance for the job.
*
* @param slaEvent sla event bean
- * @throws StoreException
+ * @throws StoreException is insertion fails
*/
public void insertSLAEvent(final SLAEventBean slaEvent) throws StoreException {
@@ -73,8 +73,10 @@ public class SLAStore extends Store {
* clause.
*
* @param seqId sequence id
+ * @param limitLen length limit
+ * @param lastSeqId last sequence id
* @return List of SLA Events
- * @throws StoreException
+ * @throws StoreException if getting events fails
*/
public List<SLAEventBean> getSLAEventListNewerSeqLimited(final long seqId, final int limitLen, long[] lastSeqId)
throws StoreException {
diff --git a/core/src/main/java/org/apache/oozie/store/Store.java b/core/src/main/java/org/apache/oozie/store/Store.java
index b60f022..d8286b6 100644
--- a/core/src/main/java/org/apache/oozie/store/Store.java
+++ b/core/src/main/java/org/apache/oozie/store/Store.java
@@ -62,6 +62,8 @@ public abstract class Store {
/**
* Use an existing transaction for cross store operations
+ *
+ * @param store use the EntityManager of given store
*/
public Store(Store store) {
entityManager = store.getEntityManager();
@@ -69,6 +71,8 @@ public abstract class Store {
/**
* Return EntityManager
+ *
+ * @return entity manager
*/
public EntityManager getEntityManager() {
return entityManager;
diff --git a/core/src/main/java/org/apache/oozie/store/WorkflowStore.java b/core/src/main/java/org/apache/oozie/store/WorkflowStore.java
index 573bcdd..e668c85 100644
--- a/core/src/main/java/org/apache/oozie/store/WorkflowStore.java
+++ b/core/src/main/java/org/apache/oozie/store/WorkflowStore.java
@@ -103,7 +103,7 @@ public class WorkflowStore extends Store {
* Create a Workflow and return a WorkflowJobBean. It also creates the process instance for the job.
*
* @param workflow workflow bean
- * @throws StoreException
+ * @throws StoreException if storing fails
*/
public void insertWorkflow(final WorkflowJobBean workflow) throws StoreException {
@@ -124,7 +124,7 @@ public class WorkflowStore extends Store {
* @param id Workflow ID
* @param locking true if Workflow is to be locked
* @return WorkflowJobBean
- * @throws StoreException
+ * @throws StoreException if getting WF fails
*/
public WorkflowJobBean getWorkflow(final String id, final boolean locking) throws StoreException {
ParamChecker.notEmpty(id, "WorkflowID");
@@ -153,7 +153,7 @@ public class WorkflowStore extends Store {
*
* @param status Workflow Status.
* @return number of Workflows with given status.
- * @throws StoreException
+ * @throws StoreException if getting WF fails
*/
public int getWorkflowCountWithStatus(final String status) throws StoreException {
ParamChecker.notEmpty(status, "status");
@@ -174,7 +174,7 @@ public class WorkflowStore extends Store {
* @param status Workflow Status.
* @param secs No. of seconds within which the workflow got modified.
* @return number of Workflows modified within given time with given status.
- * @throws StoreException
+ * @throws StoreException if getting WF fails
*/
public int getWorkflowCountWithStatusInLastNSeconds(final String status, final int secs) throws StoreException {
ParamChecker.notEmpty(status, "status");
@@ -312,7 +312,7 @@ public class WorkflowStore extends Store {
* @param wfId Workflow ID
* @param locking true if Actions are to be locked
* @return A List of WorkflowActionBean
- * @throws StoreException
+ * @throws StoreException if getting actions fails
*/
public List<WorkflowActionBean> getActionsForWorkflow(final String wfId, final boolean locking)
throws StoreException {
@@ -364,7 +364,7 @@ public class WorkflowStore extends Store {
* @param start offset for select statement
* @param len number of Workflow Actions to be returned
* @return A List of WorkflowActionBean
- * @throws StoreException
+ * @throws StoreException if getting actions fails
*/
public List<WorkflowActionBean> getActionsSubsetForWorkflow(final String wfId, final int start, final int len)
throws StoreException {
@@ -404,7 +404,7 @@ public class WorkflowStore extends Store {
*
* @param minimumPendingAgeSecs Minimum Pending age in seconds
* @return List of action beans
- * @throws StoreException
+ * @throws StoreException if getting actions fails
*/
public List<WorkflowActionBean> getPendingActions(final long minimumPendingAgeSecs) throws StoreException {
List<WorkflowActionBean> actions = doOperation("getPendingActions", new Callable<List<WorkflowActionBean>>() {
@@ -430,7 +430,7 @@ public class WorkflowStore extends Store {
*
* @param checkAgeSecs check age in seconds.
* @return List of action beans.
- * @throws StoreException
+ * @throws StoreException if getting actions fails
*/
public List<WorkflowActionBean> getRunningActions(final long checkAgeSecs) throws StoreException {
List<WorkflowActionBean> actions = doOperation("getRunningActions", new Callable<List<WorkflowActionBean>>() {
@@ -458,7 +458,7 @@ public class WorkflowStore extends Store {
*
* @param wfId String
* @return List of action beans
- * @throws StoreException
+ * @throws StoreException if getting actions fails
*/
public List<WorkflowActionBean> getRetryAndManualActions(final String wfId) throws StoreException {
List<WorkflowActionBean> actions = doOperation("GET_RETRY_MANUAL_ACTIONS",
@@ -488,7 +488,7 @@ public class WorkflowStore extends Store {
* @param start offset for select statement
* @param len number of Workflows to be returned
* @return A list of workflows
- * @throws StoreException
+ * @throws StoreException if getting WF fails
*/
public WorkflowsInfo getWorkflowsInfo(final Map<String, List<String>> filter, final int start, final int len)
throws StoreException {
@@ -778,7 +778,8 @@ public class WorkflowStore extends Store {
* Purge the Workflows Completed older than given days.
*
* @param olderThanDays number of days for which to preserve the workflows
- * @throws StoreException
+ * @param limit limit number of affected workflows
+ * @throws StoreException if purging fails
*/
public void purge(final long olderThanDays, final int limit) throws StoreException {
doOperation("purge", new Callable<Void>() {
diff --git a/core/src/main/java/org/apache/oozie/util/BufferDrainer.java b/core/src/main/java/org/apache/oozie/util/BufferDrainer.java
index 304fd6d..0120316 100644
--- a/core/src/main/java/org/apache/oozie/util/BufferDrainer.java
+++ b/core/src/main/java/org/apache/oozie/util/BufferDrainer.java
@@ -53,7 +53,7 @@ public class BufferDrainer {
* buffer is provided for the stream.
*
* @return the exit value of the processSettings.
- * @throws IOException
+ * @throws IOException if IO related issue occurs
*/
public int drainBuffers() throws IOException {
if (drainBuffersFinished) {
diff --git a/core/src/main/java/org/apache/oozie/util/ConfigUtils.java b/core/src/main/java/org/apache/oozie/util/ConfigUtils.java
index af54145..895370a 100644
--- a/core/src/main/java/org/apache/oozie/util/ConfigUtils.java
+++ b/core/src/main/java/org/apache/oozie/util/ConfigUtils.java
@@ -142,7 +142,7 @@ public class ConfigUtils {
* @param newValue the new value to assign if {@code performWrite=true} and if configuration value
* {@code oozie.configuration.check-and-set.*} is set
* @param toThrow the {@link Exception} to throw when {@code oozie.configuration.check-and-set.*} is unset
- * @param performWrite
+ * @param performWrite set to true if setting new value needed
* @param <E> {@link Exception} type
* @throws E the {@link Exception} to throw when {@code oozie.configuration.check-and-set.*} is unset
*/
diff --git a/core/src/main/java/org/apache/oozie/util/StringUtils.java b/core/src/main/java/org/apache/oozie/util/StringUtils.java
index af7ccd6..0e57f7f 100644
--- a/core/src/main/java/org/apache/oozie/util/StringUtils.java
+++ b/core/src/main/java/org/apache/oozie/util/StringUtils.java
@@ -58,6 +58,7 @@ public class StringUtils {
* @param expr - Expression string
* @param sequence - char sequence to check in the input expression
* @return true if present
+ * @throws ELEvaluationException if evaluation of expression fails
*/
public static boolean checkStaticExistence(String expr, String sequence) throws ELEvaluationException {
int curlyBracketDept = 0;
diff --git a/core/src/main/java/org/apache/oozie/util/XConfiguration.java b/core/src/main/java/org/apache/oozie/util/XConfiguration.java
index d6e59a6..6e11c2c 100644
--- a/core/src/main/java/org/apache/oozie/util/XConfiguration.java
+++ b/core/src/main/java/org/apache/oozie/util/XConfiguration.java
@@ -415,7 +415,7 @@ public class XConfiguration extends Configuration {
/**
* Restrict the parser
- * @param restrictParser
+ * @param restrictParser set to true if parser restriction needed
*/
public void setRestrictParser(boolean restrictParser) {
this.restrictParser = restrictParser;
@@ -426,7 +426,7 @@ public class XConfiguration extends Configuration {
}
/**
* Restrict reading property from System.getProperty()
- * @param restrictSystemProperties
+ * @param restrictSystemProperties set to true if system property parsing needed
*/
public void setRestrictSystemProperties(boolean restrictSystemProperties) {
this.restrictSystemProperties = restrictSystemProperties;
diff --git a/core/src/main/java/org/apache/oozie/util/db/FailingDBHelperForTest.java b/core/src/main/java/org/apache/oozie/util/db/FailingDBHelperForTest.java
index af55b06..7131e92 100644
--- a/core/src/main/java/org/apache/oozie/util/db/FailingDBHelperForTest.java
+++ b/core/src/main/java/org/apache/oozie/util/db/FailingDBHelperForTest.java
@@ -33,7 +33,7 @@ public class FailingDBHelperForTest {
/**
* change the used predicate value
- * @param predicate
+ * @param predicate predicate
*/
@VisibleForTesting
public static void setDbPredicate (final Predicate predicate) {
diff --git a/core/src/main/java/org/apache/oozie/util/db/SLADbXOperations.java b/core/src/main/java/org/apache/oozie/util/db/SLADbXOperations.java
index 37615bc..c0a573a 100644
--- a/core/src/main/java/org/apache/oozie/util/db/SLADbXOperations.java
+++ b/core/src/main/java/org/apache/oozie/util/db/SLADbXOperations.java
@@ -42,7 +42,7 @@ public class SLADbXOperations {
* @param user user name
* @param groupName group name
* @return the event
- * @throws Exception in case of error
+ * @throws Exception if nominal-time is incorrect
*/
public static SLAEventBean createSlaRegistrationEvent(Element eSla, String slaId,
SlaAppType appType, String user, String groupName)
@@ -120,10 +120,9 @@ public class SLADbXOperations {
* @param status SLA status
* @param appType SLA app type
* @return the event
- * @throws Exception in case of error
*/
public static SLAEventBean createSlaStatusEvent(String id,
- Status status, SlaAppType appType) throws Exception {
+ Status status, SlaAppType appType) {
SLAEventBean sla = new SLAEventBean();
sla.setSlaId(id);
sla.setJobStatus(status);
@@ -141,7 +140,7 @@ public class SLADbXOperations {
* @param stat SLA status
* @param appType SLA app type
* @return the report
- * @throws CommandException in case of error
+ * @throws CommandException when adding SLA event is failed
*/
public static SLAEventBean createStatusEvent(String slaXml, String id, Status stat,
SlaAppType appType) throws CommandException {
diff --git a/core/src/main/java/org/apache/oozie/util/db/SqlStatement.java b/core/src/main/java/org/apache/oozie/util/db/SqlStatement.java
index 1229ad2..a35e240 100755
--- a/core/src/main/java/org/apache/oozie/util/db/SqlStatement.java
+++ b/core/src/main/java/org/apache/oozie/util/db/SqlStatement.java
@@ -63,7 +63,7 @@ public abstract class SqlStatement {
* Move the Result Set to next record
*
* @return true if there is a next record
- * @throws SQLException in case of error
+ * @throws SQLException if a database access error occurs or this method is called on a closed result set
*/
public boolean next() throws SQLException {
return rSet.next();
@@ -72,7 +72,7 @@ public abstract class SqlStatement {
/**
* Close the Result Set
*
- * @throws SQLException in case of error
+ * @throws SQLException if a database access error occurs
*/
public void close() throws SQLException {
rSet.close();
@@ -85,7 +85,8 @@ public abstract class SqlStatement {
* @param clazz Class of the Type
* @param col Column name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException if the columnLabel is not valid;
+ * if a database access error occurs or this method is called on a closed result set
*/
@SuppressWarnings("unchecked")
public <T> T get(Class<T> clazz, Column col) throws SQLException {
@@ -108,7 +109,7 @@ public abstract class SqlStatement {
*
* @param col Column name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException when accessing binary stream fails
*/
public byte[] getByteArray(Column col) throws SQLException {
byte[] bArray = null;
@@ -142,7 +143,8 @@ public abstract class SqlStatement {
*
* @param col Column Name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException if the columnLabel is not valid;
+ * if a database access error occurs or this method is called on a closed result set
*/
public String getString(Column col) throws SQLException {
return get(String.class, col);
@@ -153,7 +155,8 @@ public abstract class SqlStatement {
*
* @param col Column name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException if the columnLabel is not valid;
+ * if a database access error occurs or this method is called on a closed result set
*/
public Timestamp getTimestamp(Column col) throws SQLException {
return get(Timestamp.class, col);
@@ -164,7 +167,8 @@ public abstract class SqlStatement {
*
* @param col Column name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException if the columnLabel is not valid;
+ * if a database access error occurs or this method is called on a closed result set
*/
public Boolean getBoolean(Column col) throws SQLException {
return get(Boolean.class, col);
@@ -175,7 +179,8 @@ public abstract class SqlStatement {
*
* @param col Column name
* @return Column data
- * @throws SQLException in case of error
+ * @throws SQLException if the columnLabel is not valid;
+ * if a database access error occurs or this method is called on a closed result set
*/
public Long getLong(Column col) throws SQLException {
return get(Long.class, col);
@@ -832,7 +837,7 @@ public abstract class SqlStatement {
*
* @param conn Connection
* @return Prepared SQL Statement
- * @throws SQLException in case of error
+ * @throws SQLException when setting prepared statement values fails
*/
public PreparedStatement prepareAndSetValues(Connection conn) throws SQLException {
String stmt = toString();
@@ -855,7 +860,7 @@ public abstract class SqlStatement {
*
* @param pStmt Prepared Statement
* @return PreparedStatement with values set
- * @throws SQLException in case of error
+ * @throws SQLException when setting prepared statement values fails
*/
public PreparedStatement prepare(PreparedStatement pStmt) throws SQLException {
int i = 1;
@@ -872,7 +877,7 @@ public abstract class SqlStatement {
*
* @param conn Connection
* @return PreparedStatement
- * @throws SQLException in case of error
+ * @throws SQLException when creating prepared statement fails
*/
public PreparedStatement prepare(Connection conn) throws SQLException {
String stmt = toString();
@@ -887,8 +892,9 @@ public abstract class SqlStatement {
*
* @param conn Connection
* @param values A list of maps that contains the actual values
+ * @param pStmt prepared statement
* @return Prepared Statement
- * @throws SQLException in case of error
+ * @throws SQLException when creating prepared statement fails
*/
public PreparedStatement prepareForBatch(Connection conn, List<? extends Map<Object, Object>> values,
PreparedStatement pStmt) throws SQLException {
diff --git a/core/src/main/java/org/apache/oozie/workflow/WorkflowInstance.java b/core/src/main/java/org/apache/oozie/workflow/WorkflowInstance.java
index 9313642..2e3f5ad 100644
--- a/core/src/main/java/org/apache/oozie/workflow/WorkflowInstance.java
+++ b/core/src/main/java/org/apache/oozie/workflow/WorkflowInstance.java
@@ -86,6 +86,7 @@ public interface WorkflowInstance {
/**
* Start the instance.
*
+ * @return true if start succeeded
* @throws WorkflowException thrown if the instance could not be started.
*/
boolean start() throws WorkflowException;
@@ -96,6 +97,7 @@ public interface WorkflowInstance {
* @param path execution path of the node that has completed.
* @param signaValue signal value for the node.
* @return <code>true</code> if the instance has completed its execution, <code>false</code> otherwise.
+ * @throws WorkflowException if workflow related issue occurs
*/
boolean signal(String path, String signaValue) throws WorkflowException;
diff --git a/core/src/main/java/org/apache/oozie/workflow/lite/DBLiteWorkflowLib.java b/core/src/main/java/org/apache/oozie/workflow/lite/DBLiteWorkflowLib.java
index 22c14fc..fbc1aef 100644
--- a/core/src/main/java/org/apache/oozie/workflow/lite/DBLiteWorkflowLib.java
+++ b/core/src/main/java/org/apache/oozie/workflow/lite/DBLiteWorkflowLib.java
@@ -47,8 +47,8 @@ public class DBLiteWorkflowLib extends LiteWorkflowLib {
/**
* Save the Workflow Instance for the given Workflow Application.
*
- * @param instance
- * @throws WorkflowException
+ * @param instance workflow instance
+ * @throws WorkflowException if workflow related issue occurs
*/
@Override
public void insert(WorkflowInstance instance) throws WorkflowException {
@@ -66,9 +66,9 @@ public class DBLiteWorkflowLib extends LiteWorkflowLib {
/**
* Loads the Workflow instance with the given ID.
*
- * @param id
+ * @param id workflow id
* @return pInstance returns a workflow instance with the given ID
- * @throws WorkflowException
+ * @throws WorkflowException if workflow related issue occurs
*/
@Override
public WorkflowInstance get(String id) throws WorkflowException {
@@ -90,8 +90,8 @@ public class DBLiteWorkflowLib extends LiteWorkflowLib {
/**
* Updates the Workflow Instance to DB.
*
- * @param instance
- * @throws WorkflowException
+ * @param instance workflow instance
+ * @throws WorkflowException if workflow related issue occurs
*/
@Override
public void update(WorkflowInstance instance) throws WorkflowException {
@@ -111,8 +111,8 @@ public class DBLiteWorkflowLib extends LiteWorkflowLib {
/**
* Delets the Workflow Instance with the given id.
*
- * @param id
- * @throws WorkflowException
+ * @param id workflow id
+ * @throws WorkflowException if workflow related issue occurs
*/
@Override
public void delete(String id) throws WorkflowException {
diff --git a/core/src/main/java/org/apache/oozie/workflow/lite/LiteWorkflowAppParser.java b/core/src/main/java/org/apache/oozie/workflow/lite/LiteWorkflowAppParser.java
index a767124..d116867 100644
--- a/core/src/main/java/org/apache/oozie/workflow/lite/LiteWorkflowAppParser.java
+++ b/core/src/main/java/org/apache/oozie/workflow/lite/LiteWorkflowAppParser.java
@@ -160,9 +160,11 @@ public class LiteWorkflowAppParser {
/**
* Parse and validate xml to {@link LiteWorkflowApp}
*
- * @param reader
+ * @param reader configuration reader
+ * @param jobConf job configuration
+ * @param configDefault default configuration
* @return LiteWorkflowApp
- * @throws WorkflowException
+ * @throws WorkflowException if workflow related issue occurs
*/
public LiteWorkflowApp validateAndParse(Reader reader, Configuration jobConf, Configuration configDefault)
throws WorkflowException {
@@ -210,12 +212,12 @@ public class LiteWorkflowAppParser {
/**
* Parse xml to {@link LiteWorkflowApp}
*
- * @param strDef
- * @param root
- * @param configDefault
- * @param jobConf
+ * @param strDef definition
+ * @param root root xml element
+ * @param configDefault default configuration
+ * @param jobConf job configuration
* @return LiteWorkflowApp
- * @throws WorkflowException
+ * @throws WorkflowException if workflow related issue occurs
*/
@SuppressWarnings({"unchecked"})
private LiteWorkflowApp parse(String strDef, Element root, Configuration configDefault, Configuration jobConf)
@@ -324,9 +326,9 @@ public class LiteWorkflowAppParser {
/**
* Read the GlobalSectionData from Base64 string.
- * @param globalStr
+ * @param globalStr string value of global section
* @return GlobalSectionData
- * @throws WorkflowException
+ * @throws WorkflowException if workflow related issue occurs
*/
private GlobalSectionData getGlobalFromString(String globalStr) throws WorkflowException {
GlobalSectionData globalSectionData = new GlobalSectionData();
@@ -345,9 +347,9 @@ public class LiteWorkflowAppParser {
/**
* Write the GlobalSectionData to a Base64 string.
- * @param globalSectionData
+ * @param globalSectionData string value of global section
* @return String
- * @throws WorkflowException
+ * @throws WorkflowException if workflow related issue occurs
*/
private String getGlobalString(GlobalSectionData globalSectionData) throws WorkflowException {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
diff --git a/release-log.txt b/release-log.txt
index 2a77671..451378e 100644
--- a/release-log.txt
+++ b/release-log.txt
@@ -1,5 +1,6 @@
-- Oozie 5.2.0 release (trunk - unreleased)
+OOZIE-1702 [build] Fix Javadoc warnings (dionusos via kmarton)
OOZIE-3395 amend [build] Migration from FindBugs to SpotBugs (kmarton via asalamon74)
OOZIE-3440 [action] Oozie Spark action replaces path symlink # to %23 (dionusos via asalamon74)
OOZIE-3409 Oozie Server : Memory leak in EL evaluation (asalamon74 via kmarton)
diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/JavaMain.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/JavaMain.java
index 34d1a3e..2dde943 100644
--- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/JavaMain.java
+++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/JavaMain.java
@@ -29,7 +29,7 @@ public class JavaMain extends LauncherMain {
/**
* @param args Invoked from LauncherAM:run()
- * @throws Exception in case of error
+ * @throws Exception in case of error when running the application
*/
public static void main(String[] args) throws Exception {
run(JavaMain.class, args);
diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandler.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandler.java
index c47144d..3fa5e65 100644
--- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandler.java
+++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandler.java
@@ -34,7 +34,7 @@ public interface LauncherURIHandler {
* @return <code>true</code> if the URI did not exist and was successfully
* created; <code>false</code> if the URI already existed
*
- * @throws LauncherException in case of error
+ * @throws LauncherException when creating resource on uri fails
*/
boolean create(URI uri, Configuration conf) throws LauncherException;
@@ -46,7 +46,7 @@ public interface LauncherURIHandler {
*
* @return <code>true</code> if the URI exists and was successfully deleted;
* <code>false</code> if the URI does not exist
- * @throws LauncherException in case of error
+ * @throws LauncherException when deleting resource on uri fails
*/
boolean delete(URI uri, Configuration conf) throws LauncherException;
diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandlerFactory.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandlerFactory.java
index bb12bfa..017b763 100644
--- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandlerFactory.java
+++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandlerFactory.java
@@ -37,7 +37,7 @@ public class LauncherURIHandlerFactory {
* Get LauncherURIHandler to perform operations on a URI in the launcher
* @param uri the target uri
* @return LauncherURIHandler to perform operations on the URI
- * @throws LauncherException in case of error
+ * @throws LauncherException if handler cannot be instantiated
*/
public LauncherURIHandler getURIHandler(URI uri) throws LauncherException {
LauncherURIHandler handler;
diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PrepareActionsHandler.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PrepareActionsHandler.java
index 93731ad..983d49a 100644
--- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PrepareActionsHandler.java
+++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PrepareActionsHandler.java
@@ -50,7 +50,7 @@ public class PrepareActionsHandler {
* @throws IOException if there is an IO error during prepare action
* @throws SAXException in case of xml parsing error
* @throws ParserConfigurationException if the parser is not well configured
- * @throws LauncherException in case of error
+ * @throws LauncherException when accessing resource on uri fails
*/
void prepareAction(String prepareXML, Configuration conf)
throws IOException, SAXException, ParserConfigurationException, LauncherException {
diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/ShellMain.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/ShellMain.java
index 554652e..0e1b3a2 100644
--- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/ShellMain.java
+++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/ShellMain.java
@@ -57,7 +57,7 @@ public class ShellMain extends LauncherMain {
/**
* @param args Invoked from LauncherAMUtils:map()
- * @throws Exception in case of error
+ * @throws Exception in case of error when running the application
*/
public static void main(String[] args) throws Exception {
run(ShellMain.class, args);
@@ -138,7 +138,7 @@ public class ShellMain extends LauncherMain {
* @param actionConf The action configuration
* @param envp The environment for the Shell process
* @param currDir The current working dir
- * @throws IOException in case of error
+ * @throws IOException in case of error writing config or property file
*/
private void prepareHadoopConfigs(Configuration actionConf, Map<String, String> envp, File currDir) throws IOException {
if (actionConf.getBoolean(CONF_OOZIE_SHELL_SETUP_HADOOP_CONF_DIR, false)) {