Repository: oozie Updated Branches: refs/heads/master 299370b44 -> 4a0589851
http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java ---------------------------------------------------------------------- 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 b6a896f..e1bd3cf 100644 --- a/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java +++ b/core/src/main/java/org/apache/oozie/servlet/BaseJobServlet.java @@ -385,10 +385,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to start a job, either workflow or coordinator * - * @param request - * @param response - * @throws XServletException - * @throws IOException TODO + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract void startJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -396,10 +396,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to resume a job, either workflow or coordinator * - * @param request - * @param response - * @throws XServletException - * @throws IOException TODO + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract void resumeJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -407,10 +407,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to suspend a job, either workflow or coordinator * - * @param request - * @param response - * @throws XServletException - * @throws IOException TODO + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract void suspendJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -418,11 +418,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to kill a job, either workflow or coordinator * - * @param request - * @param response - * @return JSONObject - * @throws XServletException - * @throws IOException TODO + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract JSONObject killJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -430,35 +429,34 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to change a coordinator job * - * @param request - * @param response - * @throws XServletException - * @throws IOException TODO - */ + * @param request the request + * @param response the response + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error + */ abstract void changeJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; /** * abstract method to re-run a job, either workflow or coordinator * - * @param request - * @param response - * @param conf - * @throws XServletException - * @throws IOException TODO + * @param request the request + * @param response the response + * @param conf the configuration to use + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract JSONObject reRunJob(HttpServletRequest request, HttpServletResponse response, Configuration conf) throws XServletException, IOException; /** * abstract method to get a job, either workflow or coordinator, in JsonBean representation - * - * @param request - * @param response + * @param request the request + * @param response the response * @return JsonBean representation of a job, either workflow or coordinator - * @throws XServletException - * @throws IOException TODO - * @throws BaseEngineException + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error + * @throws BaseEngineException thrown if the job could not be retrieved */ abstract JsonBean getJob(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException, BaseEngineException; @@ -466,11 +464,11 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to get definition of a job, either workflow or coordinator * - * @param request - * @param response + * @param request the request + * @param response the response * @return job, either workflow or coordinator, definition in string format - * @throws XServletException - * @throws IOException TODO + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract String getJobDefinition(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -478,10 +476,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to get and stream log information of job, either workflow or coordinator * - * @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 I/O error */ abstract void streamJobLog(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -489,10 +487,10 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to get and stream error log information of job, either workflow, coordinator or bundle * - * @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 I/O error */ abstract void streamJobErrorLog(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -504,20 +502,20 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to create and stream image for runtime DAG -- workflow only * - * @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 I/O error */ abstract void streamJobGraph(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; /** * abstract method to get JMS topic name for a job - * @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 I/O error */ abstract String getJMSTopicName(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; @@ -525,11 +523,11 @@ public abstract class BaseJobServlet extends JsonRestServlet { /** * abstract method to get workflow job ids from the parent id * i.e. coordinator action - * @param request - * @param response + * @param request the request + * @param response the response * @return comma-separated list of workflow job ids - * @throws XServletException - * @throws IOException + * @throws XServletException in case of any servlet error + * @throws IOException in case of any I/O error */ abstract JSONObject getJobsByParentId(HttpServletRequest request, HttpServletResponse response) throws XServletException, IOException; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/servlet/ErrorServlet.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/servlet/ErrorServlet.java b/core/src/main/java/org/apache/oozie/servlet/ErrorServlet.java index 94e93bf..17dc838 100644 --- a/core/src/main/java/org/apache/oozie/servlet/ErrorServlet.java +++ b/core/src/main/java/org/apache/oozie/servlet/ErrorServlet.java @@ -55,9 +55,9 @@ public class ErrorServlet extends HttpServlet{ /** * Writes error message as JSON to response - * @param request - * @param response - * @throws IOException + * @param request the request to get the error message from + * @param response the response to write the error to + * @throws IOException IOException */ private void handleError(HttpServletRequest request, HttpServletResponse response) throws IOException { Object errorMsg = request.getAttribute("javax.servlet.error.message"); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/servlet/JsonRestServlet.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/servlet/JsonRestServlet.java b/core/src/main/java/org/apache/oozie/servlet/JsonRestServlet.java index 0f22796..404d3cd 100644 --- a/core/src/main/java/org/apache/oozie/servlet/JsonRestServlet.java +++ b/core/src/main/java/org/apache/oozie/servlet/JsonRestServlet.java @@ -587,8 +587,8 @@ public abstract class JsonRestServlet extends HttpServlet { * Gets proxy user. * If there is any proxy user, then <code>HttpServletRequest</code> contains proxy user. * Otherwise it is the normal user. - * @param request - * @return + * @param request the request + * @return the username */ protected String getProxyUser(HttpServletRequest request) { return (String) request.getAttribute(USER_NAME); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/servlet/ServletUtilities.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/servlet/ServletUtilities.java b/core/src/main/java/org/apache/oozie/servlet/ServletUtilities.java index a7b0921..9cdd915 100644 --- a/core/src/main/java/org/apache/oozie/servlet/ServletUtilities.java +++ b/core/src/main/java/org/apache/oozie/servlet/ServletUtilities.java @@ -30,7 +30,7 @@ public class ServletUtilities { * * @param wfPath workflow app path * @param coordPath coordinator app path - * @throws XServletException + * @throws XServletException if either path is not valid */ protected static void ValidateAppPath(String wfPath, String coordPath) throws XServletException { if (wfPath != null && coordPath != null) { @@ -53,7 +53,7 @@ public class ServletUtilities { * @param wfPath workflow app path * @param coordPath coordinator app path * @param bundlePath bundle app path - * @throws XServletException + * @throws XServletException if either path is not valid */ protected static void ValidateAppPath(String wfPath, String coordPath, String bundlePath) throws XServletException { int n = 0; @@ -83,7 +83,7 @@ public class ServletUtilities { * accessory static method to check the lib path parameter for the request * * @param libPath lib path - * @throws XServletException + * @throws XServletException if either path is not valid */ protected static void ValidateLibPath(String libPath) throws XServletException { if (libPath == null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/test/EmbeddedServletContainer.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/test/EmbeddedServletContainer.java b/core/src/main/java/org/apache/oozie/test/EmbeddedServletContainer.java index 59d20b5..fc9d840 100644 --- a/core/src/main/java/org/apache/oozie/test/EmbeddedServletContainer.java +++ b/core/src/main/java/org/apache/oozie/test/EmbeddedServletContainer.java @@ -96,7 +96,7 @@ public class EmbeddedServletContainer { * * @param servletPath servlet path for the servlet, it should be prefixed with '/", it may contain a wild card at * the end. - * @param servletClass servlet instance + * @param servlet servlet instance */ public void addServletEndpoint(String servletPath, Servlet servlet) { ServletHolder holder = new ServletHolder(servlet); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/CoordActionsInDateRange.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/CoordActionsInDateRange.java b/core/src/main/java/org/apache/oozie/util/CoordActionsInDateRange.java index 1c565ef..9f02c22 100644 --- a/core/src/main/java/org/apache/oozie/util/CoordActionsInDateRange.java +++ b/core/src/main/java/org/apache/oozie/util/CoordActionsInDateRange.java @@ -53,7 +53,7 @@ public class CoordActionsInDateRange { * @param scope the date range for log. format is comma-separated list of date ranges. * Each date range element is specified with two dates separated by '::' * @return the list of coordinator action Ids for the date range - * + * @throws XException if the scope is not well formatted * Internally involves a database operation by invoking method 'getActionIdsFromDateRange'. */ public static List<String> getCoordActionIdsFromDates(String jobId, String scope) throws XException { @@ -79,8 +79,9 @@ public class CoordActionsInDateRange { * Get the coordinator actions for a given date range * @param jobId the coordinator job id * @param range the date range separated by '::' + * @param active to list only active (non-terminated) actions * @return the list of Coordinator actions for the date range - * @throws XException + * @throws XException if range is not well formatted or invalid */ public static List<CoordinatorActionBean> getCoordActionsFromDateRange(String jobId, String range, boolean active) throws XException { @@ -114,7 +115,7 @@ public class CoordActionsInDateRange { * @param jobId the coordinator job id * @param range the date range separated by '::' * @return the list of Coordinator actions for the date range - * @throws XException + * @throws XException if range is not well formatted or invalid */ public static List<String> getCoordActionIdsFromDateRange(String jobId, String range) throws XException{ String[] dateRange = range.split("::"); @@ -153,7 +154,9 @@ public class CoordActionsInDateRange { * @param jobId coordinator job id * @param start start time * @param end end time + * @param active to list only active (non-terminated) actions * @return a list of coordinator actions that correspond to the date range + * @throws XException if the actions can't be retrieved */ private static List<CoordinatorActionBean> getActionsFromDateRange(String jobId, Date start, Date end, boolean active) throws XException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/DateUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/DateUtils.java b/core/src/main/java/org/apache/oozie/util/DateUtils.java index 64fded5..261dc3d 100644 --- a/core/src/main/java/org/apache/oozie/util/DateUtils.java +++ b/core/src/main/java/org/apache/oozie/util/DateUtils.java @@ -197,6 +197,7 @@ public class DateUtils { * The format mask must be a {@link SimpleDateFormat} valid format mask. * * @param d {@link Date} to format. + * @param format the {@link SimpleDateFormat} format mask to use * @return the string for the given date using the specified format mask, * <code>NULL</code> if the {@link Date} instance was <code>NULL</code> */ @@ -313,10 +314,10 @@ public class DateUtils { /** * Create a Calendar instance using the specified date and Time zone - * @param dateString + * @param dateString the date * @param tz : TimeZone * @return appropriate Calendar object - * @throws Exception + * @throws Exception if the date can't be parsed */ public static Calendar getCalendar(String dateString, TimeZone tz) throws Exception { Date date = DateUtils.parseDateOozieTZ(dateString); @@ -328,9 +329,9 @@ public class DateUtils { /** * Create a Calendar instance for UTC time zone using the specified date. - * @param dateString + * @param dateString the date * @return appropriate Calendar object - * @throws Exception + * @throws Exception if the date can't be parsed */ public static Calendar getCalendar(String dateString) throws Exception { return getCalendar(dateString, ACTIVE_TIMEZONE); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/ELEvaluator.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/ELEvaluator.java b/core/src/main/java/org/apache/oozie/util/ELEvaluator.java index 84eaa3d..90d7977 100644 --- a/core/src/main/java/org/apache/oozie/util/ELEvaluator.java +++ b/core/src/main/java/org/apache/oozie/util/ELEvaluator.java @@ -190,6 +190,7 @@ public class ELEvaluator { /** * Evaluate an EL expression. <p> * + * @param <T> the return type of the expression * @param expr EL expression to evaluate. * @param clazz return type of the EL expression. * @return the object the EL expression evaluated to. http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/JobUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/JobUtils.java b/core/src/main/java/org/apache/oozie/util/JobUtils.java index 681b58a..721a8a0 100644 --- a/core/src/main/java/org/apache/oozie/util/JobUtils.java +++ b/core/src/main/java/org/apache/oozie/util/JobUtils.java @@ -142,7 +142,7 @@ public class JobUtils { * @param file Path of the file to be added * @param conf Configuration that contains the classpath setting * @param fs FileSystem with respect to which path should be interpreted (may be null) - * @throws IOException + * @throws IOException if the file can't be added to the classpath */ public static void addFileToClassPath(Path file, Configuration conf, FileSystem fs) throws IOException { if (fs == null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/MappingRule.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/MappingRule.java b/core/src/main/java/org/apache/oozie/util/MappingRule.java index c1f615e..379c4a6 100644 --- a/core/src/main/java/org/apache/oozie/util/MappingRule.java +++ b/core/src/main/java/org/apache/oozie/util/MappingRule.java @@ -69,7 +69,7 @@ public class MappingRule { /** * Applies rules based on the input - * @param input + * @param input input to apply the rule to * @return result Applies rules based on the input */ public String applyRule(String input) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/MetricsInstrumentation.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/MetricsInstrumentation.java b/core/src/main/java/org/apache/oozie/util/MetricsInstrumentation.java index 9d69f74..1288a3f 100644 --- a/core/src/main/java/org/apache/oozie/util/MetricsInstrumentation.java +++ b/core/src/main/java/org/apache/oozie/util/MetricsInstrumentation.java @@ -381,7 +381,7 @@ public class MetricsInstrumentation extends Instrumentation { * Converts the current state of the metrics and writes them to the OutputStream. * * @param os The OutputStream to write the metrics to - * @throws IOException + * @throws IOException in case of error during writing to the stream */ public void writeJSONResponse(OutputStream os) throws IOException { jsonMapper.writer().writeValue(os, metricRegistry); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/ParamChecker.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/ParamChecker.java b/core/src/main/java/org/apache/oozie/util/ParamChecker.java index 8debeef..e445dd8 100644 --- a/core/src/main/java/org/apache/oozie/util/ParamChecker.java +++ b/core/src/main/java/org/apache/oozie/util/ParamChecker.java @@ -36,6 +36,7 @@ public class ParamChecker { /** * Check that a value is not null. If null throws an IllegalArgumentException. * + * @param <T> the type of the object * @param obj value. * @param name parameter name for the exception message. * @return the given value. @@ -51,6 +52,7 @@ public class ParamChecker { * Check that a list is not null and that none of its elements is null. If null or if the list has emtpy elements * throws an IllegalArgumentException. * + * @param <T> the type of the list * @param list the list of strings. * @param name parameter name for the exception message. * @return the given list. http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/PollablePriorityDelayQueue.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/PollablePriorityDelayQueue.java b/core/src/main/java/org/apache/oozie/util/PollablePriorityDelayQueue.java index 7228620..03279eb 100644 --- a/core/src/main/java/org/apache/oozie/util/PollablePriorityDelayQueue.java +++ b/core/src/main/java/org/apache/oozie/util/PollablePriorityDelayQueue.java @@ -88,6 +88,7 @@ public class PollablePriorityDelayQueue<E> extends PriorityDelayQueue<E> { * This method should be overriden for checking purposes. * * @param element the element to check + * @return if the element is eligible to be polled */ protected boolean eligibleToPoll(QueueElement<?> element) { return true; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/PropertiesUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/PropertiesUtils.java b/core/src/main/java/org/apache/oozie/util/PropertiesUtils.java index 3e24e00..8d32ad0 100644 --- a/core/src/main/java/org/apache/oozie/util/PropertiesUtils.java +++ b/core/src/main/java/org/apache/oozie/util/PropertiesUtils.java @@ -101,7 +101,8 @@ public class PropertiesUtils { * Validate against DISALLOWED Properties. * * @param conf : configuration to check. - * @throws CommandException + * @param set the set containing the disallowed properties + * @throws CommandException if a property in the set is not null in the conf */ public static void checkDisallowedProperties(Configuration conf, Set<String> set) throws CommandException { ParamChecker.notNull(conf, "conf"); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/SimpleTimestampedMessageParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/SimpleTimestampedMessageParser.java b/core/src/main/java/org/apache/oozie/util/SimpleTimestampedMessageParser.java index 0b96ad4..386023f 100644 --- a/core/src/main/java/org/apache/oozie/util/SimpleTimestampedMessageParser.java +++ b/core/src/main/java/org/apache/oozie/util/SimpleTimestampedMessageParser.java @@ -36,7 +36,7 @@ public class SimpleTimestampedMessageParser extends TimestampedMessageParser { * This implementation simply returns the next line from the Reader. * * @return LogLine containing the next line from the Reader - * @throws IOException + * @throws IOException if the next line can't be read */ @Override protected LogLine parseNextLogLine() throws IOException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/StatusUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/StatusUtils.java b/core/src/main/java/org/apache/oozie/util/StatusUtils.java index 69d7265..8598390 100644 --- a/core/src/main/java/org/apache/oozie/util/StatusUtils.java +++ b/core/src/main/java/org/apache/oozie/util/StatusUtils.java @@ -148,7 +148,7 @@ public class StatusUtils { /** * Get the status of coordinator job for Oozie versions (3.2 and before) when RUNNINGWITHERROR, * SUSPENDEDWITHERROR and PAUSEDWITHERROR are not supported - * @param currentJobStatus + * @param currentJobStatus the current job status * @return newStatus Get the status of coordinator job */ public static Job.Status getStatusIfBackwardSupportTrue(Job.Status currentJobStatus) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/StringSerializationUtil.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/StringSerializationUtil.java b/core/src/main/java/org/apache/oozie/util/StringSerializationUtil.java index feefb69..e78659b 100644 --- a/core/src/main/java/org/apache/oozie/util/StringSerializationUtil.java +++ b/core/src/main/java/org/apache/oozie/util/StringSerializationUtil.java @@ -39,9 +39,9 @@ public final class StringSerializationUtil { * Writes out value to dOut. Converts it to byte array if the length of the UTF-8 byte array representation of the * string is longer than 60k bytes. * - * @param dOut - * @param value - * @throws IOException + * @param dOut the targed output stream + * @param value the string to write + * @throws IOException in case of error during serialization */ public static void writeString(DataOutput dOut, String value) throws IOException { if (value == null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/TimestampedMessageParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/TimestampedMessageParser.java b/core/src/main/java/org/apache/oozie/util/TimestampedMessageParser.java index 7fa8a60..1b87605 100644 --- a/core/src/main/java/org/apache/oozie/util/TimestampedMessageParser.java +++ b/core/src/main/java/org/apache/oozie/util/TimestampedMessageParser.java @@ -36,7 +36,8 @@ import org.apache.oozie.util.LogLine.MATCHED_PATTERN; * Reader. It will return true if there are more messages and false if not. Calling * {@link TimestampedMessageParser#getLastMessage()} and {@link TimestampedMessageParser#getLastTimestamp()} will return the last * message and timestamp, respectively, that were parsed when {@link TimestampedMessageParser#increment()} was called. Calling - * {@link TimestampedMessageParser#processRemaining(java.io.Writer)} will write the remaining log messages to the given Writer. + * {@link TimestampedMessageParser#processRemaining(java.io.Writer,org.apache.oozie.util.XLogStreamer)} will write the + * remaining log messages to the given Writer. */ public class TimestampedMessageParser { @@ -129,7 +130,7 @@ public class TimestampedMessageParser { /** * Closes the Reader. * - * @throws IOException + * @throws IOException if the reader can't be closed */ public void closeReader() throws IOException { reader.close(); @@ -141,7 +142,7 @@ public class TimestampedMessageParser { * it returns null, then there are no lines left in the Reader. * * @return LogLine - * @throws IOException + * @throws IOException in case of an error in the Reader */ protected LogLine parseNextLogLine() throws IOException { String line; @@ -197,9 +198,9 @@ public class TimestampedMessageParser { * Streams log messages to the passed in Writer, with zero bytes already * written * - * @param writer + * @param writer the target writer * @param logStreamer the log streamer - * @throws IOException + * @throws IOException in case of IO error */ public void processRemaining(Writer writer, XLogStreamer logStreamer) throws IOException { while (increment()) { @@ -214,7 +215,7 @@ public class TimestampedMessageParser { /** * Splits the log message into parts * - * @param line + * @param line the line to split * @return List of log parts */ protected ArrayList<String> splitLogMessage(String line) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/WritableUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/WritableUtils.java b/core/src/main/java/org/apache/oozie/util/WritableUtils.java index 5a4cb24..6ee4655 100644 --- a/core/src/main/java/org/apache/oozie/util/WritableUtils.java +++ b/core/src/main/java/org/apache/oozie/util/WritableUtils.java @@ -64,6 +64,7 @@ public class WritableUtils { /** * Read a writable from a byte array. * + * @param <T> the object type * @param array byte array with the serialized writable. * @param clazz writable class. * @return writable deserialized from the byte array. http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XCallable.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XCallable.java b/core/src/main/java/org/apache/oozie/util/XCallable.java index 2c034a4..26b0838 100644 --- a/core/src/main/java/org/apache/oozie/util/XCallable.java +++ b/core/src/main/java/org/apache/oozie/util/XCallable.java @@ -23,7 +23,7 @@ import java.util.concurrent.Callable; /** * Extends Callable adding the concept of priority. <p> The priority is useful when queuing callables for later * execution via the {@link org.apache.oozie.service.CallableQueueService}. <p> A higher number means a higher - * priority. <p> + * priority. */ public interface XCallable<T> extends Callable<T> { @@ -73,6 +73,7 @@ public interface XCallable<T> extends Callable<T> { /** * set the mode of execution for the callable. True if in interrupt, false * if not + * @param mode the mode to set */ void setInterruptMode(boolean mode); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XLog.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XLog.java b/core/src/main/java/org/apache/oozie/util/XLog.java index 9ecac4d..006e56a 100644 --- a/core/src/main/java/org/apache/oozie/util/XLog.java +++ b/core/src/main/java/org/apache/oozie/util/XLog.java @@ -72,7 +72,7 @@ public class XLog implements Log { } /** - * Remove all defined context parameters. <p> + * Remove all defined context parameters. */ public static void reset() { template = ""; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XLogFilter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XLogFilter.java b/core/src/main/java/org/apache/oozie/util/XLogFilter.java index 1fba33b..a5897bf 100644 --- a/core/src/main/java/org/apache/oozie/util/XLogFilter.java +++ b/core/src/main/java/org/apache/oozie/util/XLogFilter.java @@ -120,7 +120,7 @@ public class XLogFilter { /** * Checks if the logLevel and logMessage goes through the logFilter. - * @param logParts ArrayList of logParts + * @param logLine the log line * @return true if line contains the permitted logLevel */ public boolean splitsMatches(LogLine logLine) { @@ -147,7 +147,7 @@ public class XLogFilter { /** * Checks if the logLevel and logMessage goes through the logFilter. * - * @param logParts + * @param logParts the arrayList of log parts * @return true if the logLevel and logMessage goes through the logFilter */ public boolean matches(ArrayList<String> logParts) { @@ -172,7 +172,7 @@ public class XLogFilter { * Returns array containing timestamp, logLevel, and logMessage if the * pattern matches i.e A new log statement, else returns null. * - * @param logLine + * @param logLine the line * @return Array containing log level and log message */ public ArrayList<String> splitLogMessage(String logLine) { @@ -198,8 +198,8 @@ public class XLogFilter { * matching in future.</li> * <li>Record the pattern to which <code>logLine</code> has matched.</li> * </ol> - * @param logLine - * @param splitPattern + * @param logLine the line to split + * @param splitPattern the pattern to use */ public void splitLogMessage(LogLine logLine, Pattern splitPattern) { Matcher splitterWithJobId = splitPattern.matcher(logLine.getLine()); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XLogStreamer.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XLogStreamer.java b/core/src/main/java/org/apache/oozie/util/XLogStreamer.java index 012fbef..f0291af 100644 --- a/core/src/main/java/org/apache/oozie/util/XLogStreamer.java +++ b/core/src/main/java/org/apache/oozie/util/XLogStreamer.java @@ -89,10 +89,10 @@ public class XLogStreamer { * Gets the files that are modified between startTime and endTime in the given logPath and streams the log after * applying the filters. * - * @param writer - * @param startTime - * @param endTime - * @throws IOException + * @param writer the target writer + * @param startTime the start time + * @param endTime the end time + * @throws IOException Signals that an I/O exception has occurred. */ public void streamLog(Writer writer, Date startTime, Date endTime) throws IOException { streamLog(writer, startTime, endTime, true); @@ -131,10 +131,10 @@ public class XLogStreamer { /** * Returns a BufferedReader configured to read the log files based on the given startTime and endTime. * - * @param startTime - * @param endTime + * @param startTime the start time + * @param endTime the end time * @return A BufferedReader for the log files - * @throws IOException + * @throws IOException Signals that an I/O exception has occurred. */ private MultiFileReader getReader(Date startTime, Date endTime) throws IOException { @@ -212,11 +212,11 @@ public class XLogStreamer { /** * Gets the file list that will have the logs between startTime and endTime. * - * @param dir - * @param startTime - * @param endTime - * @param logRotationTime - * @param logFile + * @param dir the directory to list + * @param startTime the start time + * @param endTime the end time + * @param logRotationTime the log rotation time + * @param logFile the file to look up * @return List of files to be streamed */ private ArrayList<File> getFileList(File dir, long startTime, long endTime, long logRotationTime, String logFile) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XLogUserFilterParam.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XLogUserFilterParam.java b/core/src/main/java/org/apache/oozie/util/XLogUserFilterParam.java index 1fe59e3..3bc948e 100644 --- a/core/src/main/java/org/apache/oozie/util/XLogUserFilterParam.java +++ b/core/src/main/java/org/apache/oozie/util/XLogUserFilterParam.java @@ -103,7 +103,6 @@ public class XLogUserFilterParam { * Parse filter param * * @param param the param - * @param map the map * @throws Exception */ private void parseFilterParam(String param) throws Exception { @@ -195,7 +194,8 @@ public class XLogUserFilterParam { /** * Validate log level. * - * @throws CommandException + * @param loglevel the log level to validate + * @throws CommandException in case of a non-supported log level. */ public void validateLogLevel(String loglevel) throws CommandException { if (StringUtils.isEmpty(loglevel)) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/XmlUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/XmlUtils.java b/core/src/main/java/org/apache/oozie/util/XmlUtils.java index f850236..6875eec 100644 --- a/core/src/main/java/org/apache/oozie/util/XmlUtils.java +++ b/core/src/main/java/org/apache/oozie/util/XmlUtils.java @@ -277,6 +277,8 @@ public class XmlUtils { * * @param schema for validation * @param xml to be validated + * @throws SAXException in case of validation error + * @throws IOException in case of IO error */ public static void validateXml(Schema schema, String xml) throws SAXException, IOException { @@ -312,9 +314,9 @@ public class XmlUtils { /** * Convert Properties to string * - * @param props + * @param props the properties to convert * @return xml string - * @throws IOException + * @throws IOException if there is an error during conversion */ public static String writePropToString(Properties props) throws IOException { try { @@ -372,6 +374,9 @@ public class XmlUtils { * "'" to "'" * <p> * Note that JSTL's {@code <c:out>} escapes the exact same set of characters as this method. + * + * @param aText the text to escape + * @return the escaped text */ public static String escapeCharsForXML(String aText) { final StringBuilder result = new StringBuilder(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/ZKUtils.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/ZKUtils.java b/core/src/main/java/org/apache/oozie/util/ZKUtils.java index 5835fb2..6cdada3 100644 --- a/core/src/main/java/org/apache/oozie/util/ZKUtils.java +++ b/core/src/main/java/org/apache/oozie/util/ZKUtils.java @@ -157,7 +157,7 @@ public class ZKUtils { * * @param user The calling class * @return the ZKUtils singleton - * @throws Exception + * @throws Exception if there is an issue when connecting to ZooKeeper */ public static synchronized ZKUtils register(Object user) throws Exception { if (zk == null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/BasicDataSourceWrapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/db/BasicDataSourceWrapper.java b/core/src/main/java/org/apache/oozie/util/db/BasicDataSourceWrapper.java index c972ea2..826f95b 100644 --- a/core/src/main/java/org/apache/oozie/util/db/BasicDataSourceWrapper.java +++ b/core/src/main/java/org/apache/oozie/util/db/BasicDataSourceWrapper.java @@ -31,21 +31,21 @@ public class BasicDataSourceWrapper extends BasicDataSource { /** * Fixing a bug within {@link BasicDataSource#createConnectionFactory()} for {@code driverClassName} to have real effect. - * <p/> + * <p> * Because we use currently Apache Commons DBCP 1.4.0 that has a bug not considering {@code driverClassName}, thus, we're unable * to create a JDBC driver using a user-provided driver class name (we try to do that by setting explicitly a value for * {@code openJpa.connectionProperties="DriverClassName=..."}), unless we perform the exact same fix that is applied by the DBCP * patch. - * <p/> + * <p> * Note: when DBCP 1.4.1 will be released, and Oozie will update to 1.4.1, we can remove this class. - * <p/> - * Please see {@link https://issues.apache.org/jira/browse/DBCP-333 the DBCP bug} and - * {@link https://github.com/apache/commons-dbcp/blob/DBCP_1_4_x_BRANCH/src/java/org/apache/commons/dbcp/BasicDataSource.java - * #L1588-L1660 the fixed method} + * <p> + * Please see <a href="https://issues.apache.org/jira/browse/DBCP-333";>the DBCP bug</a> and + * <a href="https://github.com/apache/commons-dbcp/blob/DBCP_1_4_x_BRANCH/src/java/org/apache/commons/dbcp/BasicDataSource.java#L1588-L1660";> + * the fixed method </a> * for details. - * <p/> + * <p> * Please also see how OpenJPA - * {@linkplain http://openjpa.apache.org/builds/2.2.1/apache-openjpa/docs/ref_guide_integration_dbcp.html is integrated} + * <a href="http://openjpa.apache.org/builds/2.2.1/apache-openjpa/docs/ref_guide_integration_dbcp.html";> is integrated</a> * with DBCP. */ protected ConnectionFactory createConnectionFactory() throws SQLException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/FailingMySQLDriverWrapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/db/FailingMySQLDriverWrapper.java b/core/src/main/java/org/apache/oozie/util/db/FailingMySQLDriverWrapper.java index f7af57c..f0e2b18 100644 --- a/core/src/main/java/org/apache/oozie/util/db/FailingMySQLDriverWrapper.java +++ b/core/src/main/java/org/apache/oozie/util/db/FailingMySQLDriverWrapper.java @@ -26,7 +26,7 @@ import java.util.Properties; /** * Used for runtime database error injection on MySQL. - * <p/> + * <p> * Necessary steps: * <ul> * <li>set {@code oozie.service.JPAService.connection.data.source} to http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/PersistenceExceptionSubclassFilterRetryPredicate.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/db/PersistenceExceptionSubclassFilterRetryPredicate.java b/core/src/main/java/org/apache/oozie/util/db/PersistenceExceptionSubclassFilterRetryPredicate.java index ddf38d2..1e4413b 100644 --- a/core/src/main/java/org/apache/oozie/util/db/PersistenceExceptionSubclassFilterRetryPredicate.java +++ b/core/src/main/java/org/apache/oozie/util/db/PersistenceExceptionSubclassFilterRetryPredicate.java @@ -36,7 +36,7 @@ import java.util.Set; /** * A {@link DatabaseRetryPredicate} which applies when a given {@link Exception} (or its causes) are NOT blacklisted. - * <p/> + * <p> * Blacklisted exceptions in this class do not indicate a network failure, therefore no retry should take place. */ public class PersistenceExceptionSubclassFilterRetryPredicate extends DatabaseRetryPredicate { @@ -62,7 +62,7 @@ public class PersistenceExceptionSubclassFilterRetryPredicate extends DatabaseRe /** * If the {@code Throwable} to be checked doesn't have a cause, these {@code Exception} classes are used as blacklist: if one of * them is assignable from the one to be checked, no retry will happen. - * <p/> + * <p> * Note that this blacklist is different from {@link #BLACKLIST_WITH_CAUSE} because this handles the use case where * {@code Exception}s are inserted by a failure injection framework or piece of code rather than the database layer that is * failing. http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/SLADbXOperations.java ---------------------------------------------------------------------- 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 285827d..37615bc 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 @@ -41,7 +41,8 @@ public class SLADbXOperations { * @param appType SLA app type * @param user user name * @param groupName group name - * @throws Exception + * @return the event + * @throws Exception in case of error */ public static SLAEventBean createSlaRegistrationEvent(Element eSla, String slaId, SlaAppType appType, String user, String groupName) @@ -118,7 +119,8 @@ public class SLADbXOperations { * @param id SLA Id * @param status SLA status * @param appType SLA app type - * @throws Exception + * @return the event + * @throws Exception in case of error */ public static SLAEventBean createSlaStatusEvent(String id, Status status, SlaAppType appType) throws Exception { @@ -138,7 +140,8 @@ public class SLADbXOperations { * @param id SLA Id * @param stat SLA status * @param appType SLA app type - * @throws CommandException + * @return the report + * @throws CommandException in case of error */ public static SLAEventBean createStatusEvent(String slaXml, String id, Status stat, SlaAppType appType) throws CommandException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/Schema.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/db/Schema.java b/core/src/main/java/org/apache/oozie/util/db/Schema.java index cb0e24d..1278be1 100644 --- a/core/src/main/java/org/apache/oozie/util/db/Schema.java +++ b/core/src/main/java/org/apache/oozie/util/db/Schema.java @@ -108,8 +108,8 @@ public class Schema { /** * Returns the appropriate DB type for given column according to the DB Type * - * @param column - * @param dbType + * @param column the column that need the type + * @param dbType the database type * @return column type */ public static String getDbDataType(Column column, DBType dbType) { @@ -151,9 +151,9 @@ public class Schema { /** * Generates the SQL Statement for creating the table * - * @param table - * @param dbType - * @param tableColumns + * @param table the table name + * @param dbType the database type + * @param tableColumns the columns of the table * @return CREATE TABLE SQL Statement */ public static String generateCreateTableScript(Table table, DBType dbType, List<Column> tableColumns) { @@ -185,8 +185,8 @@ public class Schema { /** * Generates the SQL Statement for droping the table * - * @param table - * @param dbType + * @param table the table name + * @param dbType the database type * @return DROP TABLE SQL Statement */ public static String generateDropTableScript(Table table, DBType dbType) { @@ -201,8 +201,8 @@ public class Schema { /** * Generates the SQL statement for creating the Index * - * @param index - * @param dbType + * @param index the index + * @param dbType the database type * @return CREATE INDEX SQL Statement */ public static String generateCreateIndexScript(Index index, DBType dbType) { @@ -214,9 +214,9 @@ public class Schema { /** * Checks if the given connection's driver is HSQL Database Driver * - * @param conn + * @param conn the connection * @return true if the driver is HSQL - * @throws SQLException + * @throws SQLException if the connection type could not be determined */ public static boolean isHsqlConnection(Connection conn) throws SQLException { if (conn.getMetaData().getDriverName().toLowerCase().contains(DBType.HSQL.name().toLowerCase())) { @@ -228,9 +228,9 @@ public class Schema { /** * Checks if the given connection's driver is MySQL Database Driver * - * @param conn + * @param conn the connection * @return true if the driver is MySQL - * @throws SQLException + * @throws SQLException if the connection type could not be determined */ public static boolean isMySqlConnection(Connection conn) throws SQLException { if (conn.getMetaData().getDriverName().toLowerCase().contains(DBType.MySQL.name().toLowerCase())) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/db/SqlStatement.java ---------------------------------------------------------------------- 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 e2e0613..1229ad2 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 + * @throws SQLException in case of error */ public boolean next() throws SQLException { return rSet.next(); @@ -72,7 +72,7 @@ public abstract class SqlStatement { /** * Close the Result Set * - * @throws SQLException + * @throws SQLException in case of error */ public void close() throws SQLException { rSet.close(); @@ -85,7 +85,7 @@ public abstract class SqlStatement { * @param clazz Class of the Type * @param col Column name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ @SuppressWarnings("unchecked") public <T> T get(Class<T> clazz, Column col) throws SQLException { @@ -108,7 +108,7 @@ public abstract class SqlStatement { * * @param col Column name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ public byte[] getByteArray(Column col) throws SQLException { byte[] bArray = null; @@ -142,7 +142,7 @@ public abstract class SqlStatement { * * @param col Column Name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ public String getString(Column col) throws SQLException { return get(String.class, col); @@ -153,7 +153,7 @@ public abstract class SqlStatement { * * @param col Column name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ public Timestamp getTimestamp(Column col) throws SQLException { return get(Timestamp.class, col); @@ -164,7 +164,7 @@ public abstract class SqlStatement { * * @param col Column name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ public Boolean getBoolean(Column col) throws SQLException { return get(Boolean.class, col); @@ -175,7 +175,7 @@ public abstract class SqlStatement { * * @param col Column name * @return Column data - * @throws SQLException + * @throws SQLException in case of error */ public Long getLong(Column col) throws SQLException { return get(Long.class, col); @@ -292,8 +292,8 @@ public abstract class SqlStatement { /** * Generate Condition statement for equality check * - * @param column - * @param value + * @param column the column + * @param value the value * @return Equality Condition statement */ public static Condition isEqual(Column column, Object value) { @@ -303,8 +303,8 @@ public abstract class SqlStatement { /** * Generate InEquality Condition statement * - * @param column - * @param value + * @param column the column + * @param value the value * @return Inequality Condition statement */ public static Condition isNotEqual(Column column, Object value) { @@ -314,8 +314,8 @@ public abstract class SqlStatement { /** * Generate Condition statement for LESS THAN condition checking * - * @param column - * @param value + * @param column the column + * @param value the value * @return less than condition statement */ public static Condition lessThan(Column column, Object value) { @@ -325,8 +325,8 @@ public abstract class SqlStatement { /** * Generate Condition statement for GREATER THAN condition checking * - * @param column - * @param value + * @param column the column + * @param value the value * @return greater than condition statement */ public static Condition greaterThan(Column column, Object value) { @@ -336,8 +336,8 @@ public abstract class SqlStatement { /** * Generate Condition statement for LESS THAN OR EQUAL condition checking * - * @param column - * @param value + * @param column the column + * @param value the value * @return less than or equal condition statement */ public static Condition lessThanOrEqual(Column column, Object value) { @@ -347,8 +347,8 @@ public abstract class SqlStatement { /** * Generate Condition statement for GREATER THAN OR EQUAL condition checking * - * @param column - * @param value + * @param column the column + * @param value the value * @return greater than or equal condition statement */ public static Condition greaterThanOrEqual(Column column, Object value) { @@ -385,8 +385,8 @@ public abstract class SqlStatement { /** * IN Condition for checking multiple values * - * @param column - * @param values + * @param column the column + * @param values the values * @return In condition statement */ public static Condition in(Column column, Object... values) { @@ -396,8 +396,8 @@ public abstract class SqlStatement { /** * NOT IN Condition for checking multiple values * - * @param column - * @param values + * @param column the column + * @param values the values * @return not in condition statement */ public static Condition notIn(Column column, Object... values) { @@ -407,8 +407,8 @@ public abstract class SqlStatement { /** * Sub query with IN condition * - * @param column - * @param select + * @param column the column + * @param select the sub query * @return Sub query using in */ public static Condition in(Column column, Select select) { @@ -418,8 +418,8 @@ public abstract class SqlStatement { /** * Sub query with NOT IN condition * - * @param column - * @param select + * @param column the column + * @param select the sub query * @return sub query using not in */ public static Condition notIn(Column column, Select select) { @@ -444,7 +444,7 @@ public abstract class SqlStatement { /** * BETWEEN range checking statement * - * @param column + * @param column the column * @param lVal min value for range checking * @param rVal max value for range checking * @return between condition statement @@ -456,7 +456,7 @@ public abstract class SqlStatement { /** * NOT BETWEEN range checking statement * - * @param column + * @param column the column * @param lVal min value for range checking * @param rVal max value for range checking * @return not between condition statement @@ -633,8 +633,8 @@ public abstract class SqlStatement { /** * Setting the offset and limit for LIMIT clause * - * @param offset - * @param limit + * @param offset the offset + * @param limit the limit * @return <code>Select</code> for cascading */ public Select limit(int offset, int limit) { @@ -803,7 +803,7 @@ public abstract class SqlStatement { /** * Set the VALUES that are to be inserted * - * @param column + * @param column the column * @param value A temporary place holder which will be replaced while preparing * @return retVal Set the VALUES that are to be inserted */ @@ -832,7 +832,7 @@ public abstract class SqlStatement { * * @param conn Connection * @return Prepared SQL Statement - * @throws SQLException + * @throws SQLException in case of error */ public PreparedStatement prepareAndSetValues(Connection conn) throws SQLException { String stmt = toString(); @@ -855,7 +855,7 @@ public abstract class SqlStatement { * * @param pStmt Prepared Statement * @return PreparedStatement with values set - * @throws SQLException + * @throws SQLException in case of error */ public PreparedStatement prepare(PreparedStatement pStmt) throws SQLException { int i = 1; @@ -872,7 +872,7 @@ public abstract class SqlStatement { * * @param conn Connection * @return PreparedStatement - * @throws SQLException + * @throws SQLException in case of error */ public PreparedStatement prepare(Connection conn) throws SQLException { String stmt = toString(); @@ -888,7 +888,7 @@ public abstract class SqlStatement { * @param conn Connection * @param values A list of maps that contains the actual values * @return Prepared Statement - * @throws SQLException + * @throws SQLException in case of error */ public PreparedStatement prepareForBatch(Connection conn, List<? extends Map<Object, Object>> values, PreparedStatement pStmt) throws SQLException { @@ -925,7 +925,7 @@ public abstract class SqlStatement { * Replace the keys(newValues) which are place holders in the sql statements with the corresponding new values. And * Gives back a new SQL Statement so that the actual statement can be re-used * - * @param newValues + * @param newValues the new values * @return A New SQL Statement object with actual values set in its member */ public SqlStatement getNewStatementWithValues(Map<Object, Object> newValues) { @@ -945,7 +945,7 @@ public abstract class SqlStatement { /** * Create the Appropriate SQL Statement with the given values * - * @param temp + * @param temp the values * @return retVal Create the Appropriate SQL Statement with the given values */ private SqlStatement create(ArrayList<Object> temp) { @@ -986,7 +986,7 @@ public abstract class SqlStatement { /** * Return a new Insert Statement * - * @param table + * @param table the target table * @return Insert statement */ public static Insert insertInto(Table table) { @@ -996,7 +996,7 @@ public abstract class SqlStatement { /** * Return a new Update Statement * - * @param table + * @param table the target table * @return Update statement */ public static Update update(Table table) { @@ -1006,7 +1006,7 @@ public abstract class SqlStatement { /** * Return a new Delete Statement * - * @param table + * @param table the target table * @return Delete Statement */ public static Delete deleteFrom(Table table) { @@ -1016,7 +1016,7 @@ public abstract class SqlStatement { /** * Return a Select All Statement * - * @param tables + * @param tables the target tables * @return Select * statement */ public static Select selectAllFrom(Table... tables) { @@ -1036,7 +1036,7 @@ public abstract class SqlStatement { /** * Select count(*) Statement generator. * - * @param tables + * @param tables the target table * @return "select count(*) from tables" statement */ public static Select getCount(Table... tables) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/core/src/main/java/org/apache/oozie/util/graph/GraphGenerator.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/util/graph/GraphGenerator.java b/core/src/main/java/org/apache/oozie/util/graph/GraphGenerator.java index 12848d2..7236b15 100644 --- a/core/src/main/java/org/apache/oozie/util/graph/GraphGenerator.java +++ b/core/src/main/java/org/apache/oozie/util/graph/GraphGenerator.java @@ -35,7 +35,7 @@ import java.io.StringReader; /** * Class to generate and plot runtime workflow DAG. - * <p/> + * <p> * Since it delegates to {@link WorkflowGraphHandler} and a {@link GraphRenderer}, it is the single entry point when changing graph * generation behavior. */ @@ -53,7 +53,7 @@ public class GraphGenerator { * @param xml The workflow definition XML * @param job Current status of the job * @param showKill Flag to whether show 'kill' node - * @param graphRenderer + * @param graphRenderer the renderer */ public GraphGenerator(final String xml, final WorkflowJob job, final boolean showKill, final GraphRenderer graphRenderer) { Preconditions.checkArgument(!Strings.isNullOrEmpty(xml), "xml can't be empty"); @@ -71,7 +71,9 @@ public class GraphGenerator { * * @param out the {@link OutputStream} to use on streaming * @param outputFormat The output format to apply when rendering - * @throws Exception + * @throws ParserConfigurationException if the parser is not configured properly + * @throws SAXException in case of XML error + * @throws IOException in case of any other IO related issues */ public void write(final OutputStream out, final OutputFormat outputFormat) throws ParserConfigurationException, SAXException, IOException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index cc36f2d..203cf78 100644 --- a/pom.xml +++ b/pom.xml @@ -1625,7 +1625,6 @@ <version>2.10.4</version> <configuration> <additionalparam>${maven.javadoc.opts}</additionalparam> - <failOnError>false</failOnError> </configuration> </plugin> <plugin> http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/release-log.txt ---------------------------------------------------------------------- diff --git a/release-log.txt b/release-log.txt index d10bdde..c4c8acc 100644 --- a/release-log.txt +++ b/release-log.txt @@ -1,5 +1,6 @@ -- Oozie 5.0.0 release (trunk - unreleased) +OOZIE-2681 Fix javadoc to compile on JDK8 (dbist13, abhisekbafna, gezapeti) OOZIE-3112 SparkConfigrationService overwrites properties provided via --properties-file option in SparkAction (gezapeti) OOZIE-3126 Add option to allow list of users to access system config (satishsaley) OOZIE-2900 Retrieve tokens for oozie.launcher.mapreduce.job.hdfs-servers before submission (asasvari) http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/server/src/main/java/org/apache/oozie/server/EmbeddedOozieServer.java ---------------------------------------------------------------------- diff --git a/server/src/main/java/org/apache/oozie/server/EmbeddedOozieServer.java b/server/src/main/java/org/apache/oozie/server/EmbeddedOozieServer.java index 620b62f..b6b59b6 100644 --- a/server/src/main/java/org/apache/oozie/server/EmbeddedOozieServer.java +++ b/server/src/main/java/org/apache/oozie/server/EmbeddedOozieServer.java @@ -74,7 +74,7 @@ public class EmbeddedOozieServer { * @param servletContextHandler main web application context handler * @param oozieServletMapper maps servlets to URLs * @param oozieFilterMapper maps filters - * @param constraintSecurityHandler + * @param constraintSecurityHandler constraint security handler */ @Inject public EmbeddedOozieServer(final Server server, @@ -102,9 +102,9 @@ public class EmbeddedOozieServer { /** * Set up the Oozie server by configuring jetty server settings and starts Oozie services * - * @throws URISyntaxException - * @throws IOException - * @throws ServiceException + * @throws URISyntaxException if the server URI is not well formatted + * @throws IOException in case of IO issues + * @throws ServiceException if the server could not start */ public void setup() throws URISyntaxException, IOException, ServiceException { conf = serviceController.get(ConfigurationService.class).getConf(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/server/src/main/java/org/apache/oozie/server/JspHandler.java ---------------------------------------------------------------------- diff --git a/server/src/main/java/org/apache/oozie/server/JspHandler.java b/server/src/main/java/org/apache/oozie/server/JspHandler.java index 453998a..6a6fbfa 100644 --- a/server/src/main/java/org/apache/oozie/server/JspHandler.java +++ b/server/src/main/java/org/apache/oozie/server/JspHandler.java @@ -72,6 +72,9 @@ public class JspHandler { /** * Setup the basic application "context" for this application at "/" * This is also known as the handler tree (in jetty speak) + * @param servletContextHandler the context handler + * @throws IOException in case of IO errors + * @throws URISyntaxException if the server URI is not well formatted */ public void setupWebAppContext(WebAppContext servletContextHandler) throws IOException, URISyntaxException http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/hcatalog/src/main/java/org/apache/oozie/util/HCatURI.java ---------------------------------------------------------------------- diff --git a/sharelib/hcatalog/src/main/java/org/apache/oozie/util/HCatURI.java b/sharelib/hcatalog/src/main/java/org/apache/oozie/util/HCatURI.java index 88ad762..893264d 100644 --- a/sharelib/hcatalog/src/main/java/org/apache/oozie/util/HCatURI.java +++ b/sharelib/hcatalog/src/main/java/org/apache/oozie/util/HCatURI.java @@ -43,7 +43,7 @@ public class HCatURI { * Constructor using default configuration * * @param s HCat URI String - * @throws URISyntaxException + * @throws URISyntaxException if the parameter is not well formatted */ public HCatURI(String s) throws URISyntaxException { this(new URI(s)); @@ -194,11 +194,12 @@ public class HCatURI { /** * static method to create HCatalog URI String * - * @param server - * @param db - * @param table + * @param scheme the scheme to use + * @param server the server address + * @param db the database name + * @param table the table name * @param partitions Partition Map - * @return + * @return the constructed HCat URI */ public static String getHCatURI(String scheme, String server, String db, String table, Map<String, String> partitions) { @@ -289,7 +290,7 @@ public class HCatURI { * In case of type hive-export, it can be used to create entire partition value string * that can be used in Hive query for partition export/import. * - * type hive-export + * @param type must be "hive-export" * @return partition value string */ public String toPartitionValueString(String type) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/HdfsOperations.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/HdfsOperations.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/HdfsOperations.java index fcb0a92..751d0e0 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/HdfsOperations.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/HdfsOperations.java @@ -47,6 +47,11 @@ public class HdfsOperations { /** * Creates a Sequence file which contains the output from an action and uploads it to HDFS. + * @param launcherJobConf the configuration + * @param actionDir the target directory on HDFS + * @param actionData the data to upload + * @throws IOException in case of IO error + * @throws InterruptedException in case of interruption */ public void uploadActionDataToHDFS(final Configuration launcherJobConf, final Path actionDir, final Map<String, String> actionData) throws IOException, InterruptedException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/JavaMain.java ---------------------------------------------------------------------- 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 f98c781..34d1a3e 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 + * @throws Exception in case of error */ public static void main(String[] args) throws Exception { run(JavaMain.class, args); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherAMCallbackNotifier.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherAMCallbackNotifier.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherAMCallbackNotifier.java index 3d86b87..2962bc5 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherAMCallbackNotifier.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherAMCallbackNotifier.java @@ -137,7 +137,7 @@ public class LauncherAMCallbackNotifier { * Notify a server of the completion of a submitted job. * @param actionResult The Action Result (failed/succeeded/running) * - * @throws InterruptedException + * @throws InterruptedException in case of interruption */ public void notifyURL(OozieActionResult actionResult) throws InterruptedException { // Do we need job-end notification? http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherMain.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherMain.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherMain.java index 7bf45e3..e6e182c 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherMain.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherMain.java @@ -322,7 +322,7 @@ public abstract class LauncherMain { * Read action configuration passes through action xml file. * * @return action Configuration - * @throws IOException + * @throws IOException in the configuration could not be read */ public static Configuration loadActionConf() throws IOException { // loading action conf prepared by Oozie @@ -366,7 +366,7 @@ public abstract class LauncherMain { * * @param src The source file * @param dst The destination file(s) - * @throws IOException + * @throws IOException if the files could not be copied */ protected static void copyFileMultiplex(File src, File... dst) throws IOException { InputStream is = null; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandler.java ---------------------------------------------------------------------- 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 ec6ee00..c47144d 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 + * @throws LauncherException in case of error */ 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 + * @throws LauncherException in case of error */ boolean delete(URI uri, Configuration conf) throws LauncherException; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LauncherURIHandlerFactory.java ---------------------------------------------------------------------- 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 82c5f40..04c9175 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 @@ -33,9 +33,9 @@ public class LauncherURIHandlerFactory { /** * Get LauncherURIHandler to perform operations on a URI in the launcher - * @param uri + * @param uri the target uri * @return LauncherURIHandler to perform operations on the URI - * @throws LauncherException + * @throws LauncherException in case of error */ public LauncherURIHandler getURIHandler(URI uri) throws LauncherException { LauncherURIHandler handler; http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LocalFsOperations.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LocalFsOperations.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LocalFsOperations.java index 3784ea3..14f43ef 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LocalFsOperations.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/LocalFsOperations.java @@ -47,7 +47,8 @@ public class LocalFsOperations { /** * Print files and directories in current directory. Will list files in the sub-directory (only 2 level deep) - * @throws IOException + * @param folder the target folder + * @throws IOException if the contents could not be listed */ public void printContentsOfDir(File folder) throws IOException { System.out.println(); http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/OozieActionConfigurator.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/OozieActionConfigurator.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/OozieActionConfigurator.java index c2a100e..d480edd 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/OozieActionConfigurator.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/OozieActionConfigurator.java @@ -31,7 +31,7 @@ public interface OozieActionConfigurator { * Exceptions need to be thrown, they should be wrapped in an OozieActionConfiguratorException * * @param actionConf The action configuration - * @throws OozieActionConfiguratorException + * @throws OozieActionConfiguratorException if the action could not be configured */ void configure(JobConf actionConf) throws OozieActionConfiguratorException; } http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PasswordMasker.java ---------------------------------------------------------------------- diff --git a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PasswordMasker.java b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PasswordMasker.java index b5f7a86..4d4a40d 100644 --- a/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PasswordMasker.java +++ b/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PasswordMasker.java @@ -27,7 +27,7 @@ import java.util.regex.Pattern; /** * A generic password masker that masks {@code Map<String, String>} values given that its keys are considered password keys. - * <p/> + * <p> * Tested with {@link System#getProperties()} and {@link System#getenv()}. */ public class PasswordMasker { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/PrepareActionsHandler.java ---------------------------------------------------------------------- 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 b5377b1..923b085 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 @@ -39,7 +39,11 @@ public class PrepareActionsHandler { * Method to parse the prepare XML and execute the corresponding prepare actions * * @param prepareXML Prepare XML block in string format - * @throws LauncherException + * @param conf the configuration + * @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 */ public void prepareAction(String prepareXML, Configuration conf) throws IOException, SAXException, ParserConfigurationException, LauncherException { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/oozie/src/main/java/org/apache/oozie/action/hadoop/ShellMain.java ---------------------------------------------------------------------- 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 27607f6..55d3d96 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 @@ -53,7 +53,7 @@ public class ShellMain extends LauncherMain { /** * @param args Invoked from LauncherAMUtils:map() - * @throws Exception + * @throws Exception in case of error */ public static void main(String[] args) throws Exception { run(ShellMain.class, args); @@ -77,9 +77,9 @@ public class ShellMain extends LauncherMain { /** * Execute the shell command * - * @param actionConf + * @param actionConf the action configuration * @return command exit value - * @throws IOException + * @throws Exception in case of error during action execution */ private int execute(Configuration actionConf) throws Exception { String exec = getExec(actionConf); @@ -134,7 +134,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 + * @throws IOException in case of error */ private void prepareHadoopConfigs(Configuration actionConf, Map<String, String> envp, File currDir) throws IOException { if (actionConf.getBoolean(CONF_OOZIE_SHELL_SETUP_HADOOP_CONF_DIR, false)) { @@ -162,6 +162,7 @@ public class ShellMain extends LauncherMain { * Otherwise, logging from commands may go into stdout and make it to the Shell's captured output. * @param actionConf the action's configuration, to source log4j contents from * @param confDir the directory to write a {@link #LOG4J_PROPERTIES} file under + * @throws IOException in case of write error */ private static void writeLoggerProperties(Configuration actionConf, File confDir) throws IOException { String log4jContents = actionConf.get( @@ -182,6 +183,9 @@ public class ShellMain extends LauncherMain { /** * Return the environment variable to pass to in shell command execution. * + * @param envp the environment map to fill + * @param actionConf the config to work from + * @return the filled up map */ private Map<String, String> getEnvMap(Map<String, String> envp, Configuration actionConf) { // Adding user-specified environments @@ -199,8 +203,8 @@ public class ShellMain extends LauncherMain { /** * Get the shell commands with the arguments * - * @param exec - * @param args + * @param exec command to execute + * @param args ars of the command * @return command and list of args */ private ArrayList<String> getCmdList(String exec, String[] args) { @@ -333,7 +337,7 @@ public class ShellMain extends LauncherMain { * Retrieve the list of arguments that were originally specified to * Workflow.xml. * - * @param actionConf + * @param actionConf the configuration * @return argument list */ protected List<String> getShellArguments(Configuration actionConf) { @@ -349,7 +353,7 @@ public class ShellMain extends LauncherMain { * Retrieve the executable name that was originally specified to * Workflow.xml. * - * @param actionConf + * @param actionConf the configuration * @return executable */ protected String getExec(Configuration actionConf) { http://git-wip-us.apache.org/repos/asf/oozie/blob/4a058985/sharelib/pig/src/main/java/org/apache/oozie/action/hadoop/PigMain.java ---------------------------------------------------------------------- diff --git a/sharelib/pig/src/main/java/org/apache/oozie/action/hadoop/PigMain.java b/sharelib/pig/src/main/java/org/apache/oozie/action/hadoop/PigMain.java index a0b7165..a4ead77 100644 --- a/sharelib/pig/src/main/java/org/apache/oozie/action/hadoop/PigMain.java +++ b/sharelib/pig/src/main/java/org/apache/oozie/action/hadoop/PigMain.java @@ -314,7 +314,7 @@ public class PigMain extends LauncherMain { * @param pigLog pig log file * @param resetSecurityManager specify if need to reset security manager * @param retrieveStats specify if stats are to be retrieved - * @throws Exception + * @throws Exception in case of error during Pig execution */ protected void runPigJob(String[] args, String pigLog, boolean resetSecurityManager, boolean retrieveStats) throws Exception { PigStats stats = PigRunner.run(args, null);
