OOZIE-2681 Fix javadoc to compile on JDK8 (dbist13, abhisekbafna, gezapeti)
Project: http://git-wip-us.apache.org/repos/asf/oozie/repo Commit: http://git-wip-us.apache.org/repos/asf/oozie/commit/4a058985 Tree: http://git-wip-us.apache.org/repos/asf/oozie/tree/4a058985 Diff: http://git-wip-us.apache.org/repos/asf/oozie/diff/4a058985 Branch: refs/heads/master Commit: 4a05898518af353a36465805099c947918bf7d50 Parents: 299370b Author: Gezapeti Cseh <gezap...@apache.org> Authored: Tue Dec 5 17:00:27 2017 +0100 Committer: Gezapeti Cseh <gezap...@apache.org> Committed: Tue Dec 5 17:00:27 2017 +0100 ---------------------------------------------------------------------- .../java/org/apache/oozie/cli/CLIParser.java | 2 +- .../java/org/apache/oozie/cli/OozieCLI.java | 2 +- .../main/java/org/apache/oozie/client/Job.java | 2 +- .../org/apache/oozie/client/OozieClient.java | 82 +++++++------- .../client/event/jms/JMSMessagingUtils.java | 6 +- .../client/event/jms/MessageDeserializer.java | 4 +- .../event/message/CoordinatorActionMessage.java | 10 +- .../client/event/message/EventMessage.java | 8 +- .../oozie/client/event/message/JobMessage.java | 10 +- .../oozie/client/event/message/SLAMessage.java | 24 ++-- .../event/message/WorkflowJobMessage.java | 6 +- .../main/java/org/apache/oozie/BaseEngine.java | 39 +++---- .../main/java/org/apache/oozie/BinaryBlob.java | 4 +- .../java/org/apache/oozie/BundleActionBean.java | 8 +- .../java/org/apache/oozie/BundleJobBean.java | 2 +- .../org/apache/oozie/CoordinatorEngine.java | 57 +++++----- .../org/apache/oozie/CoordinatorJobBean.java | 9 +- .../main/java/org/apache/oozie/DagEngine.java | 8 +- .../java/org/apache/oozie/LocalOozieClient.java | 4 +- .../apache/oozie/LocalOozieClientBundle.java | 1 - .../org/apache/oozie/LocalOozieClientCoord.java | 5 +- .../main/java/org/apache/oozie/StringBlob.java | 6 +- .../org/apache/oozie/WorkflowActionBean.java | 31 ++--- .../oozie/client/rest/BulkResponseImpl.java | 6 +- .../client/rest/JMSConnectionInfoBean.java | 6 +- .../apache/oozie/compression/CodecFactory.java | 6 +- .../apache/oozie/coord/CoordELEvaluator.java | 22 ++-- .../apache/oozie/coord/CoordELFunctions.java | 16 +-- .../input/dependency/CoordInputDependency.java | 2 +- .../logic/CoordInputLogicEvaluatorPhaseOne.java | 8 +- .../logic/CoordInputLogicEvaluatorUtil.java | 2 +- .../oozie/dependency/DependencyChecker.java | 4 +- .../org/apache/oozie/dependency/URIHandler.java | 22 ++-- .../dependency/hcat/HCatDependencyCache.java | 2 + .../org/apache/oozie/service/UUIDService.java | 2 +- .../apache/oozie/servlet/BaseAdminServlet.java | 10 +- .../apache/oozie/servlet/BaseJobServlet.java | 112 +++++++++---------- .../org/apache/oozie/servlet/ErrorServlet.java | 6 +- .../apache/oozie/servlet/JsonRestServlet.java | 4 +- .../apache/oozie/servlet/ServletUtilities.java | 6 +- .../oozie/test/EmbeddedServletContainer.java | 2 +- .../oozie/util/CoordActionsInDateRange.java | 9 +- .../java/org/apache/oozie/util/DateUtils.java | 9 +- .../java/org/apache/oozie/util/ELEvaluator.java | 1 + .../java/org/apache/oozie/util/JobUtils.java | 2 +- .../java/org/apache/oozie/util/MappingRule.java | 2 +- .../oozie/util/MetricsInstrumentation.java | 2 +- .../org/apache/oozie/util/ParamChecker.java | 2 + .../oozie/util/PollablePriorityDelayQueue.java | 1 + .../org/apache/oozie/util/PropertiesUtils.java | 3 +- .../util/SimpleTimestampedMessageParser.java | 2 +- .../java/org/apache/oozie/util/StatusUtils.java | 2 +- .../oozie/util/StringSerializationUtil.java | 6 +- .../oozie/util/TimestampedMessageParser.java | 13 ++- .../org/apache/oozie/util/WritableUtils.java | 1 + .../java/org/apache/oozie/util/XCallable.java | 3 +- .../main/java/org/apache/oozie/util/XLog.java | 2 +- .../java/org/apache/oozie/util/XLogFilter.java | 10 +- .../org/apache/oozie/util/XLogStreamer.java | 24 ++-- .../apache/oozie/util/XLogUserFilterParam.java | 4 +- .../java/org/apache/oozie/util/XmlUtils.java | 9 +- .../java/org/apache/oozie/util/ZKUtils.java | 2 +- .../oozie/util/db/BasicDataSourceWrapper.java | 16 +-- .../util/db/FailingMySQLDriverWrapper.java | 2 +- ...ceExceptionSubclassFilterRetryPredicate.java | 4 +- .../apache/oozie/util/db/SLADbXOperations.java | 9 +- .../java/org/apache/oozie/util/db/Schema.java | 26 ++--- .../org/apache/oozie/util/db/SqlStatement.java | 88 +++++++-------- .../apache/oozie/util/graph/GraphGenerator.java | 8 +- pom.xml | 1 - release-log.txt | 1 + .../oozie/server/EmbeddedOozieServer.java | 8 +- .../org/apache/oozie/server/JspHandler.java | 3 + .../java/org/apache/oozie/util/HCatURI.java | 13 ++- .../oozie/action/hadoop/HdfsOperations.java | 5 + .../apache/oozie/action/hadoop/JavaMain.java | 2 +- .../hadoop/LauncherAMCallbackNotifier.java | 2 +- .../oozie/action/hadoop/LauncherMain.java | 4 +- .../oozie/action/hadoop/LauncherURIHandler.java | 4 +- .../hadoop/LauncherURIHandlerFactory.java | 4 +- .../oozie/action/hadoop/LocalFsOperations.java | 3 +- .../action/hadoop/OozieActionConfigurator.java | 2 +- .../oozie/action/hadoop/PasswordMasker.java | 2 +- .../action/hadoop/PrepareActionsHandler.java | 6 +- .../apache/oozie/action/hadoop/ShellMain.java | 20 ++-- .../org/apache/oozie/action/hadoop/PigMain.java | 2 +- 86 files changed, 476 insertions(+), 436 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/cli/CLIParser.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/cli/CLIParser.java b/client/src/main/java/org/apache/oozie/cli/CLIParser.java index 3930276..bbdb803 100644 --- a/client/src/main/java/org/apache/oozie/cli/CLIParser.java +++ b/client/src/main/java/org/apache/oozie/cli/CLIParser.java @@ -64,7 +64,7 @@ public class CLIParser { * @param argsHelp command arguments help. * @param commandHelp command description. * @param commandOptions command options. - * @param hasArguments + * @param hasArguments true if this command has arguments */ public void addCommand(String command, String argsHelp, String commandHelp, Options commandOptions, boolean hasArguments) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/cli/OozieCLI.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/cli/OozieCLI.java b/client/src/main/java/org/apache/oozie/cli/OozieCLI.java index d837c84..4abc750 100644 --- a/client/src/main/java/org/apache/oozie/cli/OozieCLI.java +++ b/client/src/main/java/org/apache/oozie/cli/OozieCLI.java @@ -547,7 +547,7 @@ public class OozieCLI { /** * Create option for command line option 'pig' or 'hive' - * @param jobType + * @param jobType type of job - pig or hive * @return pig or hive options */ @SuppressWarnings("static-access") http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/Job.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/Job.java b/client/src/main/java/org/apache/oozie/client/Job.java index 277e112..f58ef32 100644 --- a/client/src/main/java/org/apache/oozie/client/Job.java +++ b/client/src/main/java/org/apache/oozie/client/Job.java @@ -113,7 +113,7 @@ public interface Job { /** * Set the status of the job * - * @param status + * @param status the status to set */ void setStatus(Job.Status status); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/OozieClient.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/OozieClient.java b/client/src/main/java/org/apache/oozie/client/OozieClient.java index 7fb1cf3..7e41ef8 100644 --- a/client/src/main/java/org/apache/oozie/client/OozieClient.java +++ b/client/src/main/java/org/apache/oozie/client/OozieClient.java @@ -74,7 +74,6 @@ import org.codehaus.jackson.type.TypeReference; * <code>[NAME=VALUE][;NAME=VALUE]*</code>. * <p> * Valid filter names are: - * <p> * <ul> * <li>name: the workflow application name from the workflow definition.</li> * <li>user: the user that submitted the job.</li> @@ -256,7 +255,7 @@ public class OozieClient { * IMPORTANT: impersonation happens only with Oozie client requests done within * doAs() calls. * - * @param <T> + * @param <T> the type of the callable * @param userName user to impersonate. * @param callable callable with {@link OozieClient} calls impersonating the specified user. * @return any response returned by the {@link Callable#call()} method. @@ -520,12 +519,12 @@ public class OozieClient { /** * Create retryable http connection to oozie server. * - * @param url - * @param method + * @param url URL to create connection to + * @param method method to use - GET, POST, PUT * @return connection - * @throws IOException + * @throws IOException in case of an exception during connection setup */ - protected HttpURLConnection createRetryableConnection(final URL url, final String method) throws IOException{ + protected HttpURLConnection createRetryableConnection(final URL url, final String method) throws IOException { return (HttpURLConnection) new ConnectionRetriableClient(getRetryCount()) { @Override public Object doExecute(URL url, String method) throws IOException, OozieClientException { @@ -538,11 +537,11 @@ public class OozieClient { /** * Create http connection to oozie server. * - * @param url - * @param method + * @param url URL to create connection to + * @param method method to use - GET, POST, PUT * @return connection - * @throws IOException - * @throws OozieClientException + * @throws IOException in case of an exception during connection setup + * @throws OozieClientException if the connection can't be set up */ protected HttpURLConnection createConnection(URL url, String method) throws IOException, OozieClientException { HttpURLConnection conn = (HttpURLConnection) url.openConnection(); @@ -967,8 +966,9 @@ public class OozieClient { * * @param jobId coord job Id. * @param scope list of coord actions to be ignored + * @return the list ignored actions or null if there are none * @throws OozieClientException thrown if the job could not be changed. - * @return List<CoordinatorAction> ignore a coordinator job. + * @return list of ignored coordinator jobs */ public List<CoordinatorAction> ignore(String jobId, String scope) throws OozieClientException { return new CoordIgnore(jobId, RestConstants.JOB_COORD_SCOPE_ACTION, scope).call(); @@ -1072,7 +1072,7 @@ public class OozieClient { /** * Get the JMS Connection info * @return JMSConnectionInfo object - * @throws OozieClientException + * @throws OozieClientException thrown if the JMS info could not be retrieved. */ public JMSConnectionInfo getJMSConnectionInfo() throws OozieClientException { return new JMSInfo().call(); @@ -1128,9 +1128,9 @@ public class OozieClient { /** * Get the audit log of a job. * - * @param jobId - * @param ps - * @throws OozieClientException + * @param jobId the id of the job + * @param ps the stream to write the result into + * @throws OozieClientException thrown if the job audit log could not be retrieved. */ public void getJobAuditLog(String jobId, PrintStream ps) throws OozieClientException { new JobAuditLog(jobId, ps).call(); @@ -1154,9 +1154,9 @@ public class OozieClient { /** * Get the error log of a job. * - * @param jobId - * @param ps - * @throws OozieClientException + * @param jobId the id of the job + * @param ps the stream to write the result into + * @throws OozieClientException thrown if the job log could not be retrieved. */ public void getJobErrorLog(String jobId, PrintStream ps) throws OozieClientException { new JobErrorLog(jobId, ps).call(); @@ -1202,7 +1202,7 @@ public class OozieClient { * Gets the JMS topic name for a particular job * @param jobId given jobId * @return the JMS topic name - * @throws OozieClientException + * @throws OozieClientException thrown if the JMS topic could not be retrieved. */ public String getJMSTopicName(String jobId) throws OozieClientException { return new JMSTopic(jobId).call(); @@ -1241,11 +1241,11 @@ public class OozieClient { /** * Get coord action missing dependencies - * @param jobId - * @param actionList - * @param dates - * @param ps - * @throws OozieClientException + * @param jobId the id of the job + * @param actionList the list of coordinator actions + * @param dates a comma-separated list of date ranges. Each date range element is specified with two dates separated by '::' + * @param ps the stream to write the result into + * @throws OozieClientException thrown if the info could not be retrieved. */ public void getCoordActionMissingDependencies(String jobId, String actionList, String dates, PrintStream ps) throws OozieClientException { @@ -1254,10 +1254,10 @@ public class OozieClient { /** * Get coord action missing dependencies - * @param jobId - * @param actionList - * @param dates - * @throws OozieClientException + * @param jobId the id of the job + * @param actionList the list of coordinator actions + * @param dates a comma-separated list of date ranges. Each date range element is specified with two dates separated by '::' + * @throws OozieClientException thrown if the info could not be retrieved. */ public void getCoordActionMissingDependencies(String jobId, String actionList, String dates) throws OozieClientException { @@ -1816,8 +1816,8 @@ public class OozieClient { * @param scope rerun scope for date or actionIds * @param refresh true if -refresh is given in command option * @param noCleanup true if -nocleanup is given in command option - * @throws OozieClientException - * @return List<CoordinatorAction> rerun a coordinator action. + * @return the list of rerun coordinator actions + * @throws OozieClientException thrown if the info could not be retrieved. */ public List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup) throws OozieClientException { @@ -1833,9 +1833,9 @@ public class OozieClient { * @param refresh true if -refresh is given in command option * @param noCleanup true if -nocleanup is given in command option * @param failed true if -failed is given in command option - * @param props + * @param props properties to use during rerun * @return new coordinator job execution - * @throws OozieClientException + * @throws OozieClientException thrown if the info could not be retrieved. */ public List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup, boolean failed, Properties props) throws OozieClientException { @@ -1850,7 +1850,7 @@ public class OozieClient { * @param dateScope rerun scope for date * @param refresh true if -refresh is given in command option * @param noCleanup true if -nocleanup is given in command option - * @throws OozieClientException + * @throws OozieClientException thrown if the info could not be retrieved. */ public Void reRunBundle(String jobId, String coordScope, String dateScope, boolean refresh, boolean noCleanup) throws OozieClientException { @@ -2028,8 +2028,8 @@ public class OozieClient { * * @param start starting offset * @param len number of results - * @param filter - * @throws OozieClientException + * @param filter filters to use. Elements must be semicolon-separated name=value pairs + * @throws OozieClientException thrown if the sla info could not be retrieved */ public void getSlaInfo(int start, int len, String filter) throws OozieClientException { new SlaInfo(start, len, filter).call(); @@ -2497,7 +2497,7 @@ public class OozieClient { * * @param jobId given jobId * @return the status - * @throws OozieClientException + * @throws OozieClientException thrown if the status could not be retrieved */ public String getStatus(String jobId) throws OozieClientException { return new Status(jobId).call(); @@ -3088,8 +3088,8 @@ public class OozieClient { /** * Check if the string is not null or not empty. * - * @param str - * @param name + * @param str the string to check + * @param name the name to present in the error message * @return string */ public static String notEmpty(String str, String name) { @@ -3105,9 +3105,9 @@ public class OozieClient { /** * Check if the object is not null. * - * @param <T> - * @param obj - * @param name + * @param <T> the type of the object + * @param obj the object to check + * @param name the name to present in the error message * @return string */ public static <T> T notNull(T obj, String name) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/jms/JMSMessagingUtils.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/jms/JMSMessagingUtils.java b/client/src/main/java/org/apache/oozie/client/event/jms/JMSMessagingUtils.java index d1588e9..766b9bd 100644 --- a/client/src/main/java/org/apache/oozie/client/event/jms/JMSMessagingUtils.java +++ b/client/src/main/java/org/apache/oozie/client/event/jms/JMSMessagingUtils.java @@ -59,11 +59,11 @@ public class JMSMessagingUtils { /** * Constructs the EventMessage object from JMS message * - * @param <T> + * @param <T> the type of the message * @param msg the JMS message * @return the EventMessage - * @throws IOException - * @throws JMSException + * @throws IOException IOError + * @throws JMSException JMSException */ public static <T extends EventMessage> T getEventMessage(Message msg) throws IOException, JMSException { if (msg == null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/jms/MessageDeserializer.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/jms/MessageDeserializer.java b/client/src/main/java/org/apache/oozie/client/event/jms/MessageDeserializer.java index fe31061..9b5e85f 100644 --- a/client/src/main/java/org/apache/oozie/client/event/jms/MessageDeserializer.java +++ b/client/src/main/java/org/apache/oozie/client/event/jms/MessageDeserializer.java @@ -36,10 +36,10 @@ public abstract class MessageDeserializer { /** * Constructs the event message from JMS message * - * @param <T> + * @param <T> the type * @param message the JMS message * @return EventMessage - * @throws JMSException + * @throws JMSException in case of JMS error */ @SuppressWarnings("unchecked") public <T extends EventMessage> T getEventMessage(Message message) throws JMSException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/message/CoordinatorActionMessage.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/message/CoordinatorActionMessage.java b/client/src/main/java/org/apache/oozie/client/event/message/CoordinatorActionMessage.java index d6209c5..19429ec 100644 --- a/client/src/main/java/org/apache/oozie/client/event/message/CoordinatorActionMessage.java +++ b/client/src/main/java/org/apache/oozie/client/event/message/CoordinatorActionMessage.java @@ -81,7 +81,7 @@ public class CoordinatorActionMessage extends JobMessage { /** * Set the status of coordinator action - * @param status + * @param status the status to set */ public void setStatus(CoordinatorAction.Status status) { this.status = status; @@ -97,7 +97,7 @@ public class CoordinatorActionMessage extends JobMessage { /** * Set the nominal time - * @param nominalTime + * @param nominalTime the nominal time to set */ public void setNominalTime(Date nominalTime) { this.nominalTime = nominalTime; @@ -113,7 +113,7 @@ public class CoordinatorActionMessage extends JobMessage { /** * Set the error code - * @param errorCode + * @param errorCode the error code to set */ public void setErrorCode(String errorCode) { this.errorCode = errorCode; @@ -129,7 +129,7 @@ public class CoordinatorActionMessage extends JobMessage { /** * Set the error message - * @param errorMessage + * @param errorMessage the error message to set */ public void setErrorMessage(String errorMessage) { this.errorMessage = errorMessage; @@ -145,7 +145,7 @@ public class CoordinatorActionMessage extends JobMessage { /** * Set the missing dependency - * @param missingDependency + * @param missingDependency the missing dependency to set */ public void setMissingDependency(String missingDependency) { this.missingDependency = missingDependency; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/message/EventMessage.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/message/EventMessage.java b/client/src/main/java/org/apache/oozie/client/event/message/EventMessage.java index 382bb82..1e392db 100644 --- a/client/src/main/java/org/apache/oozie/client/event/message/EventMessage.java +++ b/client/src/main/java/org/apache/oozie/client/event/message/EventMessage.java @@ -58,7 +58,7 @@ public abstract class EventMessage { /** * Sets the appType for a event - * @param appType + * @param appType the app type */ public void setAppType(AppType appType) { this.appType = appType; @@ -75,7 +75,7 @@ public abstract class EventMessage { /** * Sets the message type for a event - * @param messageType + * @param messageType the message type */ public void setMessageType(MessageType messageType) { this.messageType = messageType; @@ -92,8 +92,8 @@ public abstract class EventMessage { /** * Set the JMS selector properties for message object - * @param message - * @throws JMSException + * @param message the message + * @throws JMSException in case of a JMS error occurs */ @JsonIgnore public void setProperties(Message message) throws JMSException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/message/JobMessage.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/message/JobMessage.java b/client/src/main/java/org/apache/oozie/client/event/message/JobMessage.java index c51b2f9..4458075 100644 --- a/client/src/main/java/org/apache/oozie/client/event/message/JobMessage.java +++ b/client/src/main/java/org/apache/oozie/client/event/message/JobMessage.java @@ -133,7 +133,7 @@ public class JobMessage extends EventMessage { /** * Sets the job start time for message * - * @param startTime + * @param startTime the start time */ public void setStartTime(Date startTime) { this.startTime = startTime; @@ -151,7 +151,7 @@ public class JobMessage extends EventMessage { /** * Sets the job end time for message * - * @param endTime + * @param endTime the end time */ public void setEndTime(Date endTime) { this.endTime = endTime; @@ -169,7 +169,7 @@ public class JobMessage extends EventMessage { /** * Sets the job's app name for message * - * @param appName + * @param appName the application name */ public void setAppName(String appName) { this.appName = appName; @@ -207,7 +207,7 @@ public class JobMessage extends EventMessage { /** * sets the job user for the msg * - * @param user + * @param user the user */ public void setUser(String user) { this.user = user; @@ -226,7 +226,7 @@ public class JobMessage extends EventMessage { /** * Sets the event status * - * @param eventStatus + * @param eventStatus the event status */ public void setEventStatus(JobEvent.EventStatus eventStatus) { this.eventStatus = eventStatus; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/message/SLAMessage.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/message/SLAMessage.java b/client/src/main/java/org/apache/oozie/client/event/message/SLAMessage.java index 96f9d67..5462705 100644 --- a/client/src/main/java/org/apache/oozie/client/event/message/SLAMessage.java +++ b/client/src/main/java/org/apache/oozie/client/event/message/SLAMessage.java @@ -138,7 +138,7 @@ public class SLAMessage extends EventMessage { /** * Set nominal time for message * - * @param nominalTime + * @param nominalTime the nominal time */ public void setNominalTime(Date nominalTime) { this.nominalTime = nominalTime; @@ -156,7 +156,7 @@ public class SLAMessage extends EventMessage { /** * Set expected start time for message * - * @param expectedStartTime + * @param expectedStartTime the expected start time */ public void setExpectedStartTime(Date expectedStartTime) { this.expectedStartTime = expectedStartTime; @@ -174,7 +174,7 @@ public class SLAMessage extends EventMessage { /** * Set actual start time for message * - * @param actualStartTime + * @param actualStartTime the actual start time */ public void setActualStartTime(Date actualStartTime) { this.actualStartTime = actualStartTime; @@ -192,7 +192,7 @@ public class SLAMessage extends EventMessage { /** * Set expected end time for message * - * @param expectedEndTime + * @param expectedEndTime the expected end time */ public void setExpectedEndTime(Date expectedEndTime) { this.expectedEndTime = expectedEndTime; @@ -210,7 +210,7 @@ public class SLAMessage extends EventMessage { /** * Set actual end time for message * - * @param actualEndTime + * @param actualEndTime the actual end time */ public void setActualEndTime(Date actualEndTime) { this.actualEndTime = actualEndTime; @@ -264,7 +264,7 @@ public class SLAMessage extends EventMessage { /** * Set notification message * - * @param notificationMessage + * @param notificationMessage the message */ public void setNotificationMessage(String notificationMessage) { this.notificationMessage = notificationMessage; @@ -282,7 +282,7 @@ public class SLAMessage extends EventMessage { /** * Set upstream app names * - * @param upstreamApps + * @param upstreamApps the upstream app names */ public void setUpstreamApps(String upstreamApps) { this.upstreamApps = upstreamApps; @@ -301,7 +301,7 @@ public class SLAMessage extends EventMessage { /** * Set user name for message * - * @param user + * @param user the user */ public void setUser(String user) { this.user = user; @@ -320,7 +320,7 @@ public class SLAMessage extends EventMessage { /** * Set application name for message * - * @param appName + * @param appName the application name */ public void setAppName(String appName) { this.appName = appName; @@ -339,7 +339,7 @@ public class SLAMessage extends EventMessage { /** * Set event status * - * @param eventStatus + * @param eventStatus the event status */ public void setEventStatus(SLAEvent.EventStatus eventStatus){ this.eventStatus = eventStatus; @@ -358,7 +358,7 @@ public class SLAMessage extends EventMessage { /** * Set SLA status for message * - * @param slaStatus + * @param slaStatus the sla status */ public void setSLAStatus(SLAEvent.SLAStatus slaStatus) { this.slaStatus = slaStatus; @@ -368,7 +368,7 @@ public class SLAMessage extends EventMessage { * Set the JMS properties for SLA message * * @param message the JMS message - * @throws JMSException + * @throws JMSException in case of a JMS error */ @Override @JsonIgnore http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/client/src/main/java/org/apache/oozie/client/event/message/WorkflowJobMessage.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/event/message/WorkflowJobMessage.java b/client/src/main/java/org/apache/oozie/client/event/message/WorkflowJobMessage.java index b204ccd..90ced2e 100644 --- a/client/src/main/java/org/apache/oozie/client/event/message/WorkflowJobMessage.java +++ b/client/src/main/java/org/apache/oozie/client/event/message/WorkflowJobMessage.java @@ -72,7 +72,7 @@ public class WorkflowJobMessage extends JobMessage { /** * Set the workflow job status - * @param status + * @param status the status */ public void setStatus(WorkflowJob.Status status) { this.status = status; @@ -88,7 +88,7 @@ public class WorkflowJobMessage extends JobMessage { /** * Set the workflow error code - * @param errorCode + * @param errorCode the error code */ public void setErrorCode(String errorCode) { this.errorCode = errorCode; @@ -104,7 +104,7 @@ public class WorkflowJobMessage extends JobMessage { /** * Set the workflow error message - * @param errorMessage + * @param errorMessage the error message */ public void setErrorMessage(String errorMessage) { this.errorMessage = errorMessage; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/BaseEngine.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BaseEngine.java b/core/src/main/java/org/apache/oozie/BaseEngine.java index 6a8ebff..f65b1d1 100644 --- a/core/src/main/java/org/apache/oozie/BaseEngine.java +++ b/core/src/main/java/org/apache/oozie/BaseEngine.java @@ -280,40 +280,33 @@ public abstract class BaseEngine { public abstract String getJobStatus(String jobId) throws BaseEngineException; /** - * Return the status for a Job ID - * - * @param jobId job Id. - * @return the job's status - * @throws BaseEngineException thrown if the job's status could not be obtained - */ - - /** * Enable SLA alert for job - * @param id - * @param actions - * @param dates - * @param childIds - * @throws BaseEngineException + * @param id job ID + * @param actions list of actions + * @param dates dates + * @param childIds child IDs + * @throws BaseEngineException thrown if SLA alert could not be enabled */ public abstract void enableSLAAlert(String id, String actions, String dates, String childIds) throws BaseEngineException; /** * Disable SLA alert for job - * @param id - * @param actions - * @param dates - * @param childIds - * @throws BaseEngineException + * @param id job ID + * @param actions list of actions + * @param dates dates + * @param childIds child IDs + * @throws BaseEngineException thrown if SLA alert could not be disabled */ public abstract void disableSLAAlert(String id, String actions, String dates, String childIds) throws BaseEngineException; /** * Change SLA properties for job - * @param id - * @param actions - * @param childIds - * @param newParams - * @throws BaseEngineException + * @param id job ID + * @param actions list of actions + * @param dates dates + * @param childIds child IDs + * @param newParams parameters to + * @throws BaseEngineException thrown if SLA alert could not be enabled */ public abstract void changeSLA(String id, String actions, String dates, String childIds, String newParams) throws BaseEngineException; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/BinaryBlob.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BinaryBlob.java b/core/src/main/java/org/apache/oozie/BinaryBlob.java index d1971fc..69bf67e 100644 --- a/core/src/main/java/org/apache/oozie/BinaryBlob.java +++ b/core/src/main/java/org/apache/oozie/BinaryBlob.java @@ -35,7 +35,7 @@ public class BinaryBlob { /** * Construct a binaryblob * - * @param byteArray + * @param byteArray the source byte array * @param isUncompressed - true if data is uncompressed */ public BinaryBlob(byte[] byteArray, boolean isUncompressed) { @@ -51,7 +51,7 @@ public class BinaryBlob { /** * Set bytes * - * @param byteArray + * @param byteArray the byte array */ public void setBytes(byte[] byteArray) { this.bytes = byteArray; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/BundleActionBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BundleActionBean.java b/core/src/main/java/org/apache/oozie/BundleActionBean.java index ccc18d9..eeec549 100644 --- a/core/src/main/java/org/apache/oozie/BundleActionBean.java +++ b/core/src/main/java/org/apache/oozie/BundleActionBean.java @@ -141,7 +141,7 @@ public class BundleActionBean implements Writable, JsonBean { /** * Set the Bundle Id. * - * @param bundleId + * @param bundleId the bundle Id */ public void setBundleId(String bundleId) { this.bundleId = bundleId; @@ -159,7 +159,7 @@ public class BundleActionBean implements Writable, JsonBean { /** * Set the Coordinator name. * - * @param coordName + * @param coordName the Coordinator name */ public void setCoordName(String coordName) { this.coordName = coordName; @@ -177,7 +177,7 @@ public class BundleActionBean implements Writable, JsonBean { /** * Set the coordinator Id. * - * @param coordId + * @param coordId the coordinator id */ public void setCoordId(String coordId) { this.coordId = coordId; @@ -213,7 +213,7 @@ public class BundleActionBean implements Writable, JsonBean { /** * Set the Status of the Bundle Action * - * @param val + * @param val the status to set */ public void setStatus(Status val) { this.statusStr = val.toString(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/BundleJobBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BundleJobBean.java b/core/src/main/java/org/apache/oozie/BundleJobBean.java index 5868412..b42f128 100644 --- a/core/src/main/java/org/apache/oozie/BundleJobBean.java +++ b/core/src/main/java/org/apache/oozie/BundleJobBean.java @@ -433,7 +433,7 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { } /** - * @param lastModifiedTime + * @param lastModifiedTime the lastModifiedTime to set */ public void setLastModifiedTime(Date lastModifiedTime) { this.lastModifiedTimestamp = DateUtils.convertDateToTimestamp(lastModifiedTime); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/CoordinatorEngine.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/CoordinatorEngine.java b/core/src/main/java/org/apache/oozie/CoordinatorEngine.java index 89fda05..0a4703e 100644 --- a/core/src/main/java/org/apache/oozie/CoordinatorEngine.java +++ b/core/src/main/java/org/apache/oozie/CoordinatorEngine.java @@ -136,9 +136,9 @@ public class CoordinatorEngine extends BaseEngine { } /** - * @param jobId + * @param jobId the job ID * @return CoordinatorJobBean - * @throws BaseEngineException + * @throws BaseEngineException if the bean could not be retrieved */ private CoordinatorJobBean getCoordJobWithNoActionInfo(String jobId) throws BaseEngineException { try { @@ -150,9 +150,9 @@ public class CoordinatorEngine extends BaseEngine { } /** - * @param actionId + * @param actionId the ID of the action * @return CoordinatorActionBean - * @throws BaseEngineException + * @throws BaseEngineException if the bean could not be retrieved */ public CoordinatorActionBean getCoordAction(String actionId) throws BaseEngineException { try { @@ -264,12 +264,15 @@ public class CoordinatorEngine extends BaseEngine { /** * Rerun coordinator actions for given rerunType * - * @param jobId - * @param rerunType - * @param scope - * @param refresh - * @param noCleanup - * @throws BaseEngineException + * @param jobId the job ID + * @param rerunType rerun type {@link RestConstants#JOB_COORD_SCOPE_DATE} or {@link RestConstants#JOB_COORD_SCOPE_ACTION} + * @param scope the rerun scope for given rerunType separated by "," + * @param refresh true if user wants to refresh input/output dataset urls + * @param noCleanup false if user wants to cleanup output events for given rerun actions + * @param failed true if user wants to rerun only failed nodes + * @param conf configuration values for actions + * @return the action info + * @throws BaseEngineException thrown if the actions could not be rerun */ public CoordinatorActionInfo reRun(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup, boolean failed, Configuration conf) @@ -328,9 +331,9 @@ public class CoordinatorEngine extends BaseEngine { * @param logRetrievalType Based on which filter criteria the log is retrieved * @param writer writer to stream the log to * @param requestParameters additional parameters from the request - * @throws IOException - * @throws BaseEngineException - * @throws CommandException + * @throws IOException in case of IO error + * @throws BaseEngineException if there is an error during streaming + * @throws CommandException if a parameter could not be parsed */ public void streamLog(String jobId, String logRetrievalScope, String logRetrievalType, Writer writer, Map<String, String[]> requestParameters) throws IOException, BaseEngineException, CommandException { @@ -585,11 +588,12 @@ public class CoordinatorEngine extends BaseEngine { } /** - * @param filter - * @param start - * @param len + * @param filter he filter to parse. Elements must be semicolon-separated name=value pairs. + * Supported names are in{@link CoordinatorEngine#FILTER_NAMES}. + * @param start start from this job in the coordinator + * @param len maximum number of results * @return CoordinatorJobInfo - * @throws CoordinatorEngineException + * @throws CoordinatorEngineException if the job info could no be retrieved */ public CoordinatorJobInfo getCoordJobs(String filter, int start, int len) throws CoordinatorEngineException { Map<String, List<String>> filterList = parseJobsFilter(filter); @@ -672,9 +676,10 @@ public class CoordinatorEngine extends BaseEngine { } /** - * @param filter - * @return Map<String, List<String>> - * @throws CoordinatorEngineException + * @param filter the filter to parse. Elements must be semicolon-separated name=value pairs. + * Supported names are in{@link CoordinatorEngine#FILTER_NAMES}. + * @return Map<String, List<String>> map of parsed filters + * @throws CoordinatorEngineException if the parameter could not be parsed */ @VisibleForTesting Map<String, List<String>> parseJobsFilter(String filter) throws CoordinatorEngineException { @@ -913,7 +918,7 @@ public class CoordinatorEngine extends BaseEngine { * @param start Offset for the jobs that will be suspended * @param length maximum number of jobs that will be suspended * @return coordinatorJobInfo - * @throws CoordinatorEngineException + * @throws CoordinatorEngineException if the jobs could not be suspended */ public CoordinatorJobInfo suspendJobs(String filter, int start, int length) throws CoordinatorEngineException { try { @@ -936,7 +941,7 @@ public class CoordinatorEngine extends BaseEngine { * @param start Offset for the jobs that will be resumed * @param length maximum number of jobs that will be resumed * @return coordinatorJobInfo returns resumed jobs - * @throws CoordinatorEngineException + * @throws CoordinatorEngineException if the jobs could not be resumed */ public CoordinatorJobInfo resumeJobs(String filter, int start, int length) throws CoordinatorEngineException { try { @@ -959,7 +964,7 @@ public class CoordinatorEngine extends BaseEngine { * @param dates nominal time list * @return CoordActionMissingDependenciesXCommand pair of coord action bean and * list of missing input dependencies. - * @throws CommandException + * @throws CommandException if the actions could not be retrieved */ public List<Pair<CoordinatorActionBean, Map<String, ActionDependency>>> getCoordActionMissingDependencies(String id, String actions, String dates) throws CommandException { @@ -970,10 +975,10 @@ public class CoordinatorEngine extends BaseEngine { * get wf actions by action name in a coordinator job * @param jobId coordinator job id * @param wfActionName workflow action name - * @param offset - * @param len + * @param offset offset in the coordinator job + * @param len maximum number of results * @return CoordWfActionInfoXCommand list of CoordinatorWfActionBean in a coordinator - * @throws CoordinatorEngineException + * @throws CoordinatorEngineException if the actions could not be retrieved */ public List<CoordinatorWfActionBean> getWfActionByJobIdAndName(String jobId, String wfActionName, int offset, int len) throws CoordinatorEngineException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java b/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java index b6e0b7e..99c7d3c 100644 --- a/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java +++ b/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java @@ -437,7 +437,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set original job xml * - * @param origJobXml + * @param origJobXml the job xml */ public void setOrigJobXml(String origJobXml) { if (this.origJobXml == null) { @@ -516,6 +516,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set doneMaterialization + * @param i value to set */ public void setDoneMaterialization(int i) { this.doneMaterialization = i; @@ -688,6 +689,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set status + * @param status the status to set */ public void setStatusStr(String status) { this.statusStr = status; @@ -709,7 +711,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set time unit - * + * @param timeunit time unit to set */ public void setTimeUnitStr(String timeunit) { this.timeUnitStr = timeunit; @@ -730,7 +732,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set order * - * @param order + * @param order execution order to set */ public void setExecutionOrder(Execution order) { this.execution = order.toString(); @@ -746,6 +748,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { /** * Set execution order + * @param order order to set */ public void setExecution(String order) { this.execution = order; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/DagEngine.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/DagEngine.java b/core/src/main/java/org/apache/oozie/DagEngine.java index 01cf449..bb166d4 100644 --- a/core/src/main/java/org/apache/oozie/DagEngine.java +++ b/core/src/main/java/org/apache/oozie/DagEngine.java @@ -127,7 +127,7 @@ public class DagEngine extends BaseEngine { * @param conf job conf * @param parentId parent of workflow * @return jobId returns jobId of the launched workflow - * @throws DagEngineException + * @throws DagEngineException if the job can't be submitted */ public String submitJobFromCoordinator(Configuration conf, String parentId) throws DagEngineException { validateSubmitConfiguration(conf); @@ -587,7 +587,7 @@ public class DagEngine extends BaseEngine { * @param start start index in the database of jobs * @param len maximum number of jobs that will be killed * @return workflowsInfo return the jobs that've been killed - * @throws DagEngineException + * @throws DagEngineException if the jobs could not be killed */ public WorkflowsInfo killJobs(String filter, int start, int len) throws DagEngineException { try { @@ -609,7 +609,7 @@ public class DagEngine extends BaseEngine { * @param start Offset for the jobs that will be suspended * @param len maximum number of jobs that will be suspended * @return workflowsInfo return the jobs that've been suspended - * @throws DagEngineException + * @throws DagEngineException if the jobs cloud not be suspended */ public WorkflowsInfo suspendJobs(String filter, int start, int len) throws DagEngineException { try { @@ -631,7 +631,7 @@ public class DagEngine extends BaseEngine { * @param start Offset for the jobs that will be resumed * @param len maximum number of jobs that will be resumed * @return workflowsInfo returns the jobs that've been resumed - * @throws DagEngineException + * @throws DagEngineException if the jobs cloud not be resumed */ public WorkflowsInfo resumeJobs(String filter, int start, int len) throws DagEngineException { try { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/LocalOozieClient.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/LocalOozieClient.java b/core/src/main/java/org/apache/oozie/LocalOozieClient.java index 123725f..590b85f 100644 --- a/core/src/main/java/org/apache/oozie/LocalOozieClient.java +++ b/core/src/main/java/org/apache/oozie/LocalOozieClient.java @@ -27,7 +27,7 @@ import java.util.List; /** * Client API to submit and manage Oozie workflow jobs against an Oozie instance. <p> This class is thread safe. <p> * Syntax for filter for the {@link #getJobsInfo(String)} {@link #getJobsInfo(String, int, int)} methods: - * <code>[NAME=VALUE][;NAME=VALUE]*</code>. <p> Valid filter names are: <p> <ul> <li>name: the workflow application + * <code>[NAME=VALUE][;NAME=VALUE]*</code>. <p> Valid filter names are: <ul> <li>name: the workflow application * name from the workflow definition.</li> <li>user: the user that submitted the job.</li> <li>group: the group for the * job.</li> <li>status: the status of the job.</li> </ul> <p> The query will do an AND among all the filter names. The * query will do an OR among all the filter values for the same name. Multiple values must be specified as different @@ -38,7 +38,7 @@ public class LocalOozieClient extends BaseLocalOozieClient { private DagEngine dagEngine; /** - * Create a workflow client for Oozie local use. <p> + * Create a workflow client for Oozie local use. * * @param dagEngine the dag engine instance to use. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/LocalOozieClientBundle.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/LocalOozieClientBundle.java b/core/src/main/java/org/apache/oozie/LocalOozieClientBundle.java index 3c229be..e4d4f0c 100644 --- a/core/src/main/java/org/apache/oozie/LocalOozieClientBundle.java +++ b/core/src/main/java/org/apache/oozie/LocalOozieClientBundle.java @@ -33,7 +33,6 @@ import java.util.List; * <code>[NAME=VALUE][;NAME=VALUE]*</code>. * <p> * Valid filter names are: - * <p> * <ul> * <li>name: the bundle application name from the bundle definition.</li> * <li>user: the user that submitted the job.</li> http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java b/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java index d1e6972..c2fdb43 100644 --- a/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java +++ b/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java @@ -43,7 +43,6 @@ import org.apache.oozie.util.XConfiguration; * <code>[NAME=VALUE][;NAME=VALUE]*</code>. * <p> * Valid filter names are: - * <p> * <ul> * <li>name: the coordinator application name from the coordinator definition.</li> * <li>user: the user that submitted the job.</li> @@ -79,7 +78,7 @@ public class LocalOozieClientCoord extends BaseLocalOozieClient { * @param scope rerun scope for date or actionIds * @param refresh true if -refresh is given in command option * @param noCleanup true if -nocleanup is given in command option - * @throws OozieClientException + * @throws OozieClientException if coordinators cannot be rerun */ @Override public List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, @@ -98,7 +97,7 @@ public class LocalOozieClientCoord extends BaseLocalOozieClient { * @param noCleanup true if -nocleanup is given in command option * @param failed true if -failed is given in command option * @param conf configuration information for the rerun - * @throws OozieClientException + * @throws OozieClientException if coordinators cannot be rerun */ @Override public List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/StringBlob.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/StringBlob.java b/core/src/main/java/org/apache/oozie/StringBlob.java index 9e8d383..cb5aff4 100644 --- a/core/src/main/java/org/apache/oozie/StringBlob.java +++ b/core/src/main/java/org/apache/oozie/StringBlob.java @@ -37,7 +37,7 @@ public class StringBlob { /** * Construct string blob from compressed byte array * - * @param byteArray + * @param byteArray the byte array */ public StringBlob(byte[] byteArray) { this.rawBlob = byteArray; @@ -46,7 +46,7 @@ public class StringBlob { /** * Construct StringBlob with uncompressed string * - * @param inputString + * @param inputString the string */ public StringBlob(String inputString) { this.string = inputString; @@ -56,7 +56,7 @@ public class StringBlob { /** * Set string * - * @param str + * @param str the string */ public void setString(String str) { this.string = str; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/WorkflowActionBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/WorkflowActionBean.java b/core/src/main/java/org/apache/oozie/WorkflowActionBean.java index 14f36ed..6b05b89 100644 --- a/core/src/main/java/org/apache/oozie/WorkflowActionBean.java +++ b/core/src/main/java/org/apache/oozie/WorkflowActionBean.java @@ -435,6 +435,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set pending flag + * @param i the flag */ public void setPending(int i) { pending = i; @@ -572,7 +573,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set external child ids * - * @param externalChildIDs + * @param externalChildIDs the external child ids */ public void setExternalChildIDsBlob(StringBlob externalChildIDs) { this.externalChildIDs = externalChildIDs; @@ -659,7 +660,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set status of job * - * @param val + * @param val the status */ public void setStatus(Status val) { this.statusStr = val.toString(); @@ -673,7 +674,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set status * - * @param statusStr + * @param statusStr the status */ public void setStatusStr(String statusStr) { this.statusStr = statusStr; @@ -814,7 +815,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set start time * - * @param startTime + * @param startTime the start time */ public void setStartTime(Date startTime) { this.startTimestamp = DateUtils.convertDateToTimestamp(startTime); @@ -828,7 +829,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set end time * - * @param endTime + * @param endTime the end time */ public void setEndTime(Date endTime) { this.endTimestamp = DateUtils.convertDateToTimestamp(endTime); @@ -969,7 +970,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set user retry max * - * @param retryMax + * @param retryMax the maximum retry count */ public void setUserRetryMax(int retryMax) { this.userRetryMax = retryMax; @@ -992,7 +993,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set transition * - * @param transition + * @param transition the transition */ public void setTransition(String transition) { this.transition = transition; @@ -1006,7 +1007,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set data * - * @param data + * @param data the data */ public void setData(String data) { if (this.data == null) { @@ -1033,7 +1034,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set stats * - * @param stats + * @param stats the action stats */ public void setStats(String stats) { if (this.stats == null) { @@ -1060,7 +1061,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set external Id * - * @param externalId + * @param externalId the id */ public void setExternalId(String externalId) { this.externalId = externalId; @@ -1074,7 +1075,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set external status * - * @param externalStatus + * @param externalStatus the external status */ public void setExternalStatus(String externalStatus) { this.externalStatus = externalStatus; @@ -1088,7 +1089,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set tracker uri * - * @param trackerUri + * @param trackerUri the URI */ public void setTrackerUri(String trackerUri) { this.trackerUri = trackerUri; @@ -1102,7 +1103,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set console URL * - * @param consoleUrl + * @param consoleUrl the URL */ public void setConsoleUrl(String consoleUrl) { this.consoleUrl = consoleUrl; @@ -1121,8 +1122,8 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set the error Info * - * @param errorCode - * @param errorMessage + * @param errorCode the error code + * @param errorMessage the error message */ public void setErrorInfo(String errorCode, String errorMessage) { this.errorCode = errorCode; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java b/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java index 374c6ef..8f3b09f 100644 --- a/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java +++ b/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java @@ -105,7 +105,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the bundle comprising this bulk response object - * @param bj + * @param bj the bundle */ public void setBundle(BundleJobBean bj) { this.bundle = bj; @@ -113,7 +113,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the coordinator comprising this bulk response object - * @param cj + * @param cj the coord */ public void setCoordinator(CoordinatorJobBean cj) { this.coordinator = cj; @@ -121,7 +121,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the coord action comprising this bulk response object - * @param ca + * @param ca the action */ public void setAction(CoordinatorActionBean ca) { this.action = ca; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/client/rest/JMSConnectionInfoBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/client/rest/JMSConnectionInfoBean.java b/core/src/main/java/org/apache/oozie/client/rest/JMSConnectionInfoBean.java index 1257640..e5f53f0 100644 --- a/core/src/main/java/org/apache/oozie/client/rest/JMSConnectionInfoBean.java +++ b/core/src/main/java/org/apache/oozie/client/rest/JMSConnectionInfoBean.java @@ -42,7 +42,7 @@ public class JMSConnectionInfoBean implements JsonBean, JMSConnectionInfoWrapper /** * Set the JNDI properties for jms connection - * @param JNDIProperties + * @param JNDIProperties the properties */ public void setJNDIProperties(Properties JNDIProperties) { this.JNDIProperties = JNDIProperties; @@ -69,7 +69,7 @@ public class JMSConnectionInfoBean implements JsonBean, JMSConnectionInfoWrapper /** * Sets the topic prefix - * @param topicPrefix + * @param topicPrefix the prefix */ public void setTopicPrefix(String topicPrefix) { this.topicPrefix = topicPrefix; @@ -77,7 +77,7 @@ public class JMSConnectionInfoBean implements JsonBean, JMSConnectionInfoWrapper /** * Set the topic pattern properties - * @param topicProperties + * @param topicProperties the properties */ public void setTopicPatternProperties(Properties topicProperties) { this.topicProperties = topicProperties; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/compression/CodecFactory.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/compression/CodecFactory.java b/core/src/main/java/org/apache/oozie/compression/CodecFactory.java index 72cf385..c0f906e 100644 --- a/core/src/main/java/org/apache/oozie/compression/CodecFactory.java +++ b/core/src/main/java/org/apache/oozie/compression/CodecFactory.java @@ -48,8 +48,8 @@ public class CodecFactory { /** * Initialize the codec factory to maintain list of codecs - * @param conf - * @throws Exception + * @param conf the configuration + * @throws Exception if the codec couldn't be initialized */ public static void initialize(Configuration conf) throws Exception { String outputCompressionStr = conf.get(COMPRESSION_OUTPUT_CODEC); @@ -128,7 +128,7 @@ public class CodecFactory { * Get decompression codec after reading from stream * @param dais the input stream * @return the decompression codec - * @throws IOException + * @throws IOException in case of IO error */ public static CompressionCodec getDeCompressionCodec(DataInputStream dais) throws IOException { byte[] buffer = new byte[COMPRESSION_MAGIC_DATA.length()]; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java ---------------------------------------------------------------------- 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 4230a20..3467eef 100644 --- a/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java +++ b/core/src/main/java/org/apache/oozie/coord/CoordELEvaluator.java @@ -49,6 +49,7 @@ public class CoordELEvaluator { * 1) * * @param conf : Configuration containing property variables + * @param group Name of the group of required EL Evaluator. * @return configured ELEvaluator */ public static ELEvaluator createELEvaluatorForGroup(Configuration conf, String group) { @@ -117,11 +118,11 @@ public class CoordELEvaluator { /** * Create a SLA evaluator to be used during Materialization - * @param eAction - * @param coordAction - * @param conf + * @param eAction the action + * @param coordAction the coordinator action + * @param conf the configuration * @return eval returns SLA evaluator to be used during Materialization - * @throws Exception + * @throws Exception in case of error */ public static ELEvaluator createSLAEvaluator(Element eAction, CoordinatorActionBean coordAction, Configuration conf) throws Exception { @@ -153,11 +154,11 @@ public class CoordELEvaluator { /** * Create an Evaluator using conf and input/output-data (used for sla) - * @param conf - * @param group - * @param dataNameList + * @param conf the configuration + * @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 + * @throws Exception in case of error */ public static ELEvaluator createELEvaluatorForDataAndConf(Configuration conf, String group, HashMap<String, String> dataNameList) throws Exception { @@ -171,6 +172,7 @@ public class CoordELEvaluator { * * @param eJob : XML element for the application instance * @param conf :Configuration to substitute any variables + * @param actionId the action Id * @return configured ELEvaluator * @throws Exception : If there is any date-time string in wrong format, the exception is thrown */ @@ -268,9 +270,9 @@ public class CoordELEvaluator { /** * Create Dataset object using the Dataset XML information * - * @param eData + * @param eData the xml * @return ds returns Dataset object using the Dataset XML information - * @throws Exception + * @throws Exception if the Dataset object can't be created */ private static SyncCoordDataset getDSObject(Element eData) throws Exception { SyncCoordDataset ds = new SyncCoordDataset(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java ---------------------------------------------------------------------- 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 76d837c..10f4f0d 100644 --- a/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java +++ b/core/src/main/java/org/apache/oozie/coord/CoordELFunctions.java @@ -197,7 +197,7 @@ public class CoordELFunctions { * @param offset any number * @param unit one of DAY, MONTH, HOUR, MINUTE, MONTH * @return the offset date string - * @throws Exception + * @throws Exception in case of error */ public static String ph2_coord_dateOffset(String strBaseDate, int offset, String unit) throws Exception { Calendar baseCalDate = DateUtils.getCalendar(strBaseDate); @@ -216,9 +216,9 @@ public class CoordELFunctions { * timezone. It will account for daylight saving time based on the given 'strBaseDate' and 'timezone'. * * @param strBaseDate The base date - * @param timezone + * @param timezone the timezone * @return the offset date string - * @throws Exception + * @throws Exception in case of error */ public static String ph2_coord_dateTzOffset(String strBaseDate, String timezone) throws Exception { Calendar baseCalDate = DateUtils.getCalendar(strBaseDate); @@ -259,7 +259,7 @@ public class CoordELFunctions { * be >=0 * @return date-time in Oozie processing timezone of the n-th instance * <p> - * @throws Exception + * @throws Exception if the dataset is asynchronous */ public static String ph3_coord_future(int n, int instance) throws Exception { ParamChecker.checkGEZero(n, "future:n"); @@ -302,8 +302,7 @@ public class CoordELFunctions { * be >=0 * @return date-time in Oozie processing timezone of the instances from start to end offsets * delimited by comma. - * <p> - * @throws Exception + * @throws Exception if the dataset is asynchronous */ public static String ph3_coord_futureRange(int start, int end, int instance) throws Exception { ParamChecker.checkGEZero(start, "future:n"); @@ -424,7 +423,6 @@ public class CoordELFunctions { /** * Return nominal time or Action Creation Time. - * <p> * * @return coordinator action creation or materialization date time * @throws Exception if unable to format the Date object to String @@ -442,7 +440,6 @@ public class CoordELFunctions { /** * Convert from standard date-time formatting to a desired format. - * <p> * @param dateTimeStr - A timestamp in standard (ISO8601) format. * @param format - A string representing the desired format. * @return coordinator action creation or materialization date time @@ -461,7 +458,6 @@ public class CoordELFunctions { /** * Convert from standard date-time formatting to a Unix epoch time. - * <p> * @param dateTimeStr - A timestamp in standard (ISO8601) format. * @param millis - "true" to include millis; otherwise will only include seconds * @return coordinator action creation or materialization date time @@ -479,7 +475,7 @@ public class CoordELFunctions { } /** - * Return Action Id. <p> + * Return Action Id. * * @return coordinator action Id */ http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/coord/input/dependency/CoordInputDependency.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/coord/input/dependency/CoordInputDependency.java b/core/src/main/java/org/apache/oozie/coord/input/dependency/CoordInputDependency.java index 4a2a0b0..08f3269 100644 --- a/core/src/main/java/org/apache/oozie/coord/input/dependency/CoordInputDependency.java +++ b/core/src/main/java/org/apache/oozie/coord/input/dependency/CoordInputDependency.java @@ -182,7 +182,7 @@ public interface CoordInputDependency { * Check unresolved. * * @param coordAction the coord action - * @param eAction + * @param eAction the element for the action * @return true, if successful * @throws Exception the exception */ http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorPhaseOne.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorPhaseOne.java b/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorPhaseOne.java index 52e03d9..a97b31a 100644 --- a/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorPhaseOne.java +++ b/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorPhaseOne.java @@ -73,10 +73,10 @@ public class CoordInputLogicEvaluatorPhaseOne implements CoordInputLogicEvaluato /** * Evaluate input function with min and wait * - * @param coordInputDependency - * @param dataSet - * @param min - * @param wait + * @param coordInputDependency the dependency + * @param dataSet the dataset + * @param min the minimum number of available dataset + * @param wait time to wait in minutes * @return the coord input logic evaluator result */ public CoordInputLogicEvaluatorResult input(AbstractCoordInputDependency coordInputDependency, String dataSet, http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/coord/input/logic/CoordInputLogicEvaluatorUtil.java ---------------------------------------------------------------------- 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 653fb2a..2306ede 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 + * @throws CommandException in case of error */ public void validateInputLogic() throws JDOMException, CommandException { JexlEngine jexl = new OozieJexlEngine(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/dependency/DependencyChecker.java ---------------------------------------------------------------------- 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 bdd854f..5e9ae74 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 + * @throws CommandException in case of error */ 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 + * @throws CommandException in case of error */ public static ActionDependency checkForAvailability(List<String> missingDependencies, Configuration actionConf, boolean stopOnFirstMissing) throws CommandException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/dependency/URIHandler.java ---------------------------------------------------------------------- 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 da68b00..b465b9a 100644 --- a/core/src/main/java/org/apache/oozie/dependency/URIHandler.java +++ b/core/src/main/java/org/apache/oozie/dependency/URIHandler.java @@ -70,7 +70,9 @@ public interface URIHandler { * when the availability is received through notifications from a external * entity like a JMS server the type is DependencyType.PUSH * + * @param uri the URI to get the dependency type from * @return dependency type of URI + * @throws URIHandlerException in case of error */ DependencyType getDependencyType(URI uri) throws URIHandlerException; @@ -82,7 +84,7 @@ public interface URIHandler { * @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 + * @throws URIHandlerException in case of error */ void registerForNotification(URI uri, Configuration conf, String user, String actionID) throws URIHandlerException; @@ -105,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 + * @throws URIHandlerException in case of error */ Context getContext(URI uri, Configuration conf, String user, boolean readOnly) throws URIHandlerException; @@ -118,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 + * @throws URIHandlerException in case of error */ boolean exists(URI uri, Context context) throws URIHandlerException; @@ -133,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 + * @throws URIHandlerException in case of error */ boolean exists(URI uri, Configuration conf, String user) throws URIHandlerException; @@ -142,7 +144,7 @@ public interface URIHandler { * * @param uri URI * @param context Context to access the URI - * @throws URIHandlerException + * @throws URIHandlerException in case of error */ void delete(URI uri, Context context) throws URIHandlerException; @@ -152,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 + * @throws URIHandlerException in case of error */ void delete(URI uri, Configuration conf, String user) throws URIHandlerException; @@ -164,7 +166,7 @@ public interface URIHandler { * * @return the final URI with the doneFlag incorporated * - * @throws URIHandlerException + * @throws URIHandlerException in case of error */ String getURIWithDoneFlag(String uri, String doneFlag) throws URIHandlerException; @@ -176,15 +178,15 @@ public interface URIHandler { * * @return the final URI without the doneFlag incorporated * - * @throws URIHandlerException + * @throws URIHandlerException in case of error */ String getURIWithoutDoneFlag(String uri, String doneFlag) throws URIHandlerException; /** * Check whether the URI is valid or not - * @param uri - * @throws URIHandlerException + * @param uri the uri + * @throws URIHandlerException if the uri is not valid */ void validate(String uri) throws URIHandlerException; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/dependency/hcat/HCatDependencyCache.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/dependency/hcat/HCatDependencyCache.java b/core/src/main/java/org/apache/oozie/dependency/hcat/HCatDependencyCache.java index a5a31e4..a924002 100644 --- a/core/src/main/java/org/apache/oozie/dependency/hcat/HCatDependencyCache.java +++ b/core/src/main/java/org/apache/oozie/dependency/hcat/HCatDependencyCache.java @@ -94,11 +94,13 @@ public interface HCatDependencyCache { /** * Purge stale actions + * @param coordActions the actions to purge */ void removeNonWaitingCoordActions(Set<String> coordActions); /** * Remove coordAction when all dependencies met + * @param coordAction the actions to remove */ void removeCoordActionWithDependenciesAvailable(String coordAction); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/service/UUIDService.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/service/UUIDService.java b/core/src/main/java/org/apache/oozie/service/UUIDService.java index faddd6d..29583b6 100644 --- a/core/src/main/java/org/apache/oozie/service/UUIDService.java +++ b/core/src/main/java/org/apache/oozie/service/UUIDService.java @@ -111,7 +111,7 @@ public class UUIDService implements Service { * @param type Type of Id. Generally 'C' for Coordinator, 'W' for Workflow and 'B' for Bundle. * @return unique ID, id = "${sequence}-${systemId}-[C|W|B]" where, * sequence is ${padded_counter}-${startTime} whose length is exactly 7 + 1 + 15 = 23 characters. - * systemId is the value defined in the {@link #CONF_SYSTEM_ID} configuration property. + * systemId is the value defined in the {@link Services#CONF_SYSTEM_ID} configuration property. * Unique ID Example: 0007728-150515180312570-oozie-oozi-W */ public String generateId(ApplicationType type) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java ---------------------------------------------------------------------- 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 97c2007..7f57fec 100644 --- a/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java +++ b/core/src/main/java/org/apache/oozie/servlet/BaseAdminServlet.java @@ -101,10 +101,10 @@ public abstract class BaseAdminServlet extends JsonRestServlet { /** * Get JMS connection Info - * @param request - * @param response - * @throws XServletException - * @throws IOException + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any IO error */ abstract JsonBean getJMSConnectionInfo(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -226,7 +226,7 @@ public abstract class BaseAdminServlet extends JsonRestServlet { * * @param sharelibKey the sharelib key * @return the list of supported share lib - * @throws IOException + * @throws IOException in case of any servlet error */ @SuppressWarnings("unchecked") private JSONObject getShareLib(String sharelibKey) throws IOException {
