| <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>AbstractJobEntry.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Turbine</a> > <a href="index.source.html" class="el_package">org.apache.turbine.services.schedule</a> > <span class="el_source">AbstractJobEntry.java</span></div><h1>AbstractJobEntry.java</h1><pre class="source lang-java linenums">package org.apache.turbine.services.schedule; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| import java.util.Calendar; |
| import java.util.Date; |
| |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.logging.log4j.LogManager; |
| import org.apache.logging.log4j.Logger; |
| import org.apache.turbine.util.TurbineException; |
| |
| /** |
| * This class provides the basic implementation of common features for a scheduled job entry. |
| * |
| * @author <a href="mailto:tv@apache.org">Thomas Vandahl</a> |
| */ |
| public abstract class AbstractJobEntry implements JobEntry |
| { |
| /** Logging */ |
| <span class="nc" id="L38"> protected static final Logger log = LogManager.getLogger(ScheduleService.LOGGER_NAME);</span> |
| |
| /** indicates if job is currently running */ |
| <span class="nc" id="L41"> private boolean jobIsActive = false;</span> |
| |
| /** Next runtime. **/ |
| <span class="nc" id="L44"> private long runtime = 0;</span> |
| |
| /** schedule types **/ |
| <span class="nc" id="L47"> protected enum ScheduleType {</span> |
| <span class="nc" id="L48"> SECOND,</span> |
| <span class="nc" id="L49"> MINUTE,</span> |
| <span class="nc" id="L50"> WEEK_DAY,</span> |
| <span class="nc" id="L51"> DAY_OF_MONTH,</span> |
| <span class="nc" id="L52"> DAILY</span> |
| } |
| |
| /** |
| * Default constructor |
| */ |
| public AbstractJobEntry() |
| { |
| <span class="nc" id="L60"> super();</span> |
| <span class="nc" id="L61"> }</span> |
| |
| /** |
| * Constructor. |
| * |
| * Schedule a job to run on a certain point of time.<br> |
| * |
| * Example 1: Run the DefaultScheduledJob at 8:00am every 15th of |
| * the month - <br> |
| * |
| * JobEntry je = new JobEntry(0,0,8,-1,15,"DefaultScheduledJob");<br> |
| * |
| * Example 2: Run the DefaultScheduledJob at 8:00am every day - |
| * <br> |
| * |
| * JobEntry je = new JobEntry(0,0,8,-1,-1,"DefaultScheduledJob");<br> |
| * |
| * Example 3: Run the DefaultScheduledJob every 2 hours. - <br> |
| * |
| * JobEntry je = new JobEntry(0,120,-1,-1,-1,"DefaultScheduledJob");<br> |
| * |
| * Example 4: Run the DefaultScheduledJob every 30 seconds. - <br> |
| * |
| * JobEntry je = new JobEntry(30,-1,-1,-1,-1,"DefaultScheduledJob");<br> |
| * |
| * @param sec Value for entry "seconds". |
| * @param min Value for entry "minutes". |
| * @param hour Value for entry "hours". |
| * @param wd Value for entry "week days". |
| * @param day_mo Value for entry "month days". |
| * @param task Task to execute. |
| * @throws TurbineException a generic exception. |
| */ |
| public AbstractJobEntry(int sec, |
| int min, |
| int hour, |
| int wd, |
| int day_mo, |
| String task) |
| throws TurbineException |
| { |
| <span class="nc" id="L102"> this();</span> |
| |
| <span class="nc bnc" id="L104" title="All 2 branches missed."> if (StringUtils.isEmpty(task))</span> |
| { |
| <span class="nc" id="L106"> throw new TurbineException("Error in JobEntry. " +</span> |
| "Bad Job parameter. Task not set."); |
| } |
| |
| <span class="nc" id="L110"> setSecond(sec);</span> |
| <span class="nc" id="L111"> setMinute(min);</span> |
| <span class="nc" id="L112"> setHour(hour);</span> |
| <span class="nc" id="L113"> setWeekDay(wd);</span> |
| <span class="nc" id="L114"> setDayOfMonth(day_mo);</span> |
| <span class="nc" id="L115"> setTask(task);</span> |
| |
| <span class="nc" id="L117"> calcRunTime();</span> |
| <span class="nc" id="L118"> }</span> |
| |
| /** |
| * Used for ordering Jobentries |
| * Note: this comparator imposes orderings that are inconsistent with |
| * equals. |
| * |
| * @param je The first <code>JobEntry</code> object. |
| * @return An <code>int</code> indicating the result of the comparison. |
| */ |
| @Override |
| public int compareTo(JobEntry je) |
| { |
| <span class="nc" id="L131"> return getJobId() - je.getJobId();</span> |
| } |
| |
| /** |
| * Sets whether the job is running. |
| * |
| * @param isActive Whether the job is running. |
| */ |
| @Override |
| public void setActive(boolean isActive) |
| { |
| <span class="nc" id="L142"> jobIsActive = isActive;</span> |
| <span class="nc" id="L143"> }</span> |
| |
| /** |
| * Check to see if job is currently active/running |
| * |
| * @return true if job is currently queuing run by the |
| * worker thread, otherwise false |
| */ |
| @Override |
| public boolean isActive() |
| { |
| <span class="nc" id="L154"> return jobIsActive;</span> |
| } |
| |
| /** |
| * Get the next runtime for this job as a long. |
| * |
| * @return The next run time as a long. |
| */ |
| @Override |
| public long getNextRuntime() |
| { |
| <span class="nc" id="L165"> return runtime;</span> |
| } |
| |
| /** |
| * Gets the next runtime as a date |
| * |
| * @return Next run date |
| */ |
| @Override |
| public Date getNextRunDate() |
| { |
| <span class="nc" id="L176"> return new Date(runtime);</span> |
| } |
| |
| /** |
| * Get the next runtime for this job as a String. |
| * |
| * @return The next run time as a String. |
| */ |
| @Override |
| public String getNextRunAsString() |
| { |
| <span class="nc" id="L187"> return getNextRunDate().toString();</span> |
| } |
| |
| /** |
| * Calculate how long before the next runtime.<br> |
| * |
| * The runtime determines it's position in the job queue. |
| * Here's the logic:<br> |
| * |
| * 1. Create a date the represents when this job is to run.<br> |
| * |
| * 2. If this date has expired, them "roll" appropriate date |
| * fields forward to the next date.<br> |
| * |
| * 3. Calculate the diff in time between the current time and the |
| * next run time.<br> |
| * |
| * @throws TurbineException a generic exception. |
| */ |
| @Override |
| public void calcRunTime() |
| throws TurbineException |
| { |
| <span class="nc" id="L210"> Calendar schedrun = Calendar.getInstance();</span> |
| <span class="nc" id="L211"> Calendar now = Calendar.getInstance();</span> |
| |
| <span class="nc bnc" id="L213" title="All 6 branches missed."> switch (evaluateJobType())</span> |
| { |
| case SECOND: |
| // SECOND (every so many seconds...) |
| <span class="nc" id="L217"> schedrun.add(Calendar.SECOND, getSecond());</span> |
| <span class="nc" id="L218"> runtime = schedrun.getTime().getTime();</span> |
| <span class="nc" id="L219"> break;</span> |
| |
| case MINUTE: |
| // MINUTE (every so many minutes...) |
| <span class="nc" id="L223"> schedrun.add(Calendar.SECOND, getSecond());</span> |
| <span class="nc" id="L224"> schedrun.add(Calendar.MINUTE, getMinute());</span> |
| <span class="nc" id="L225"> runtime = schedrun.getTime().getTime();</span> |
| <span class="nc" id="L226"> break;</span> |
| |
| case WEEK_DAY: |
| // WEEKDAY (day of the week) |
| <span class="nc" id="L230"> schedrun.set(Calendar.SECOND, getSecond());</span> |
| <span class="nc" id="L231"> schedrun.set(Calendar.MINUTE, getMinute());</span> |
| <span class="nc" id="L232"> schedrun.set(Calendar.HOUR_OF_DAY, getHour());</span> |
| <span class="nc" id="L233"> schedrun.set(Calendar.DAY_OF_WEEK, getWeekDay());</span> |
| |
| <span class="nc bnc" id="L235" title="All 2 branches missed."> if (now.before(schedrun))</span> |
| { |
| // Scheduled time has NOT expired. |
| <span class="nc" id="L238"> runtime = schedrun.getTime().getTime();</span> |
| } |
| else |
| { |
| // Scheduled time has expired; roll to the next week. |
| <span class="nc" id="L243"> schedrun.add(Calendar.DAY_OF_WEEK, 7);</span> |
| <span class="nc" id="L244"> runtime = schedrun.getTime().getTime();</span> |
| } |
| <span class="nc" id="L246"> break;</span> |
| |
| case DAY_OF_MONTH: |
| // DAY_OF_MONTH (date of the month) |
| <span class="nc" id="L250"> schedrun.set(Calendar.SECOND, getSecond());</span> |
| <span class="nc" id="L251"> schedrun.set(Calendar.MINUTE, getMinute());</span> |
| <span class="nc" id="L252"> schedrun.set(Calendar.HOUR_OF_DAY, getHour());</span> |
| <span class="nc" id="L253"> schedrun.set(Calendar.DAY_OF_MONTH, getDayOfMonth());</span> |
| |
| <span class="nc bnc" id="L255" title="All 2 branches missed."> if (now.before(schedrun))</span> |
| { |
| // Scheduled time has NOT expired. |
| <span class="nc" id="L258"> runtime = schedrun.getTime().getTime();</span> |
| } |
| else |
| { |
| // Scheduled time has expired; roll to the next month. |
| <span class="nc" id="L263"> schedrun.add(Calendar.MONTH, 1);</span> |
| <span class="nc" id="L264"> runtime = schedrun.getTime().getTime();</span> |
| } |
| <span class="nc" id="L266"> break;</span> |
| |
| case DAILY: |
| // DAILY (certain hour:minutes of the day) |
| <span class="nc" id="L270"> schedrun.set(Calendar.SECOND, getSecond());</span> |
| <span class="nc" id="L271"> schedrun.set(Calendar.MINUTE, getMinute());</span> |
| <span class="nc" id="L272"> schedrun.set(Calendar.HOUR_OF_DAY, getHour());</span> |
| |
| // Scheduled time has NOT expired. |
| <span class="nc bnc" id="L275" title="All 2 branches missed."> if (now.before(schedrun))</span> |
| { |
| <span class="nc" id="L277"> runtime = schedrun.getTime().getTime();</span> |
| } |
| else |
| { |
| // Scheduled time has expired; roll forward 24 hours. |
| <span class="nc" id="L282"> schedrun.add(Calendar.HOUR_OF_DAY, 24);</span> |
| <span class="nc" id="L283"> runtime = schedrun.getTime().getTime();</span> |
| } |
| <span class="nc" id="L285"> break;</span> |
| |
| default: |
| // Do nothing. |
| } |
| |
| <span class="nc" id="L291"> log.info("Next runtime for task {} is {}", this::getTask, this::getNextRunDate);</span> |
| <span class="nc" id="L292"> }</span> |
| |
| /** |
| * What schedule am I on? |
| * |
| * I know this is kinda ugly! If you can think of a cleaner way |
| * to do this, please jump in! |
| * |
| * @return A number specifying the type of schedule. See |
| * calcRunTime(). |
| * @throws TurbineException a generic exception. |
| */ |
| private ScheduleType evaluateJobType() |
| throws TurbineException |
| { |
| |
| // First start by checking if it's a day of the month job. |
| <span class="nc bnc" id="L309" title="All 2 branches missed."> if (getDayOfMonth() < 0)</span> |
| { |
| // Not a day of the month job... check weekday. |
| <span class="nc bnc" id="L312" title="All 2 branches missed."> if (getWeekDay() < 0)</span> |
| { |
| // Not a weekday job...check if by the hour. |
| <span class="nc bnc" id="L315" title="All 2 branches missed."> if (getHour() < 0)</span> |
| { |
| // Not an hourly job...check if it is by the minute |
| <span class="nc bnc" id="L318" title="All 2 branches missed."> if (getMinute() < 0)</span> |
| { |
| // Not a by the minute job so must be by the second |
| <span class="nc bnc" id="L321" title="All 2 branches missed."> if (getSecond() < 0)</span> |
| { |
| <span class="nc" id="L323"> throw new TurbineException("Error in JobEntry. Bad Job parameter.");</span> |
| } |
| |
| <span class="nc" id="L326"> return ScheduleType.SECOND;</span> |
| } |
| else |
| { |
| // Must be a job run by the minute so we need minutes and |
| // seconds. |
| <span class="nc bnc" id="L332" title="All 4 branches missed."> if (getMinute() < 0 || getSecond() < 0)</span> |
| { |
| <span class="nc" id="L334"> throw new TurbineException("Error in JobEntry. Bad Job parameter.");</span> |
| } |
| |
| <span class="nc" id="L337"> return ScheduleType.MINUTE;</span> |
| } |
| } |
| else |
| { |
| // Must be a daily job by hours minutes, and seconds. In |
| // this case, we need the minute, second, and hour params. |
| <span class="nc bnc" id="L344" title="All 6 branches missed."> if (getMinute() < 0 || getHour() < 0 || getSecond() < 0)</span> |
| { |
| <span class="nc" id="L346"> throw new TurbineException("Error in JobEntry. Bad Job parameter.");</span> |
| } |
| |
| <span class="nc" id="L349"> return ScheduleType.DAILY;</span> |
| } |
| } |
| else |
| { |
| // Must be a weekday job. In this case, we need |
| // minute, second, and hour params |
| <span class="nc bnc" id="L356" title="All 6 branches missed."> if (getMinute() < 0 || getHour() < 0 || getSecond() < 0)</span> |
| { |
| <span class="nc" id="L358"> throw new TurbineException("Error in JobEntry. Bad Job parameter.");</span> |
| } |
| |
| <span class="nc" id="L361"> return ScheduleType.WEEK_DAY;</span> |
| } |
| } |
| else |
| { |
| // Must be a day of the month job. In this case, we need |
| // minute, second, and hour params |
| <span class="nc bnc" id="L368" title="All 4 branches missed."> if (getMinute() < 0 || getHour() < 0)</span> |
| { |
| <span class="nc" id="L370"> throw new TurbineException("Error in JobEntry. Bad Job parameter.");</span> |
| } |
| |
| <span class="nc" id="L373"> return ScheduleType.DAY_OF_MONTH;</span> |
| } |
| } |
| |
| /** |
| * Get the value of jobId. |
| * |
| * @return int |
| */ |
| @Override |
| public abstract int getJobId(); |
| |
| /** |
| * Set the value of jobId. |
| * |
| * @param v new value |
| */ |
| @Override |
| public abstract void setJobId(int v); |
| |
| /** |
| * Get the value of second. |
| * |
| * @return int |
| */ |
| public abstract int getSecond(); |
| |
| /** |
| * Set the value of second. |
| * |
| * @param v new value |
| */ |
| public abstract void setSecond(int v); |
| |
| /** |
| * Get the value of minute. |
| * |
| * @return int |
| */ |
| public abstract int getMinute(); |
| |
| /** |
| * Set the value of minute. |
| * |
| * @param v new value |
| */ |
| public abstract void setMinute(int v); |
| |
| /** |
| * Get the value of hour. |
| * |
| * @return int |
| */ |
| public abstract int getHour(); |
| |
| /** |
| * Set the value of hour. |
| * |
| * @param v new value |
| */ |
| public abstract void setHour(int v); |
| |
| /** |
| * Get the value of weekDay. |
| * |
| * @return int |
| */ |
| public abstract int getWeekDay(); |
| |
| /** |
| * Set the value of weekDay. |
| * |
| * @param v new value |
| */ |
| public abstract void setWeekDay(int v); |
| |
| /** |
| * Get the value of dayOfMonth. |
| * |
| * @return int |
| */ |
| public abstract int getDayOfMonth(); |
| |
| /** |
| * Set the value of dayOfMonth. |
| * |
| * @param v new value |
| */ |
| public abstract void setDayOfMonth(int v); |
| |
| /** |
| * Get the value of task. |
| * |
| * @return String |
| */ |
| @Override |
| public abstract String getTask(); |
| |
| /** |
| * Set the value of task. |
| * |
| * @param v new value |
| */ |
| @Override |
| public abstract void setTask(String v); |
| } |
| </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html> |
