/*
Copyright 2013 Nationale-Nederlanden
Licensed 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.
*/
package nl.nn.adapterframework.util;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.jdbc.JdbcException;
import nl.nn.adapterframework.jdbc.JdbcFacade;
import nl.nn.adapterframework.util.Misc;
import org.apache.commons.lang.StringUtils;
/**
* Locker of scheduler jobs and pipes.
*
* Tries to set a lock (by inserting a record in the database table IbisLock) and only if this is done
* successfully the job is executed.
* <p><b>Configuration:</b>
* <table border="1">
* <tr><th>attributes</th><th>description</th><th>default</th></tr>
* <tr><td>classname</td><td>nl.nn.adapterframework.scheduler.Locker</td><td> </td></tr>
* <tr><td>{@link #setObjectId(String) objectId}</td><td>identifier for this lock</td><td> </td></tr>
* <tr><td>{@link #setType(String) type}</td><td>type for this lock: P(ermanent) or T(emporary). A temporary lock is deleted after the job has completed</td><td>T</td></tr>
* <tr><td>{@link #setDateFormatSuffix(String) dateFormatSuffix}</td><td>format for date which is added after <code>objectId</code> (e.g. yyyyMMdd to be sure the job is executed only once a day)</td><td> </td></tr>
* <tr><td>{@link #setJmsRealm(String) jmsRealm}</td><td> </td><td> </td></tr>
* <tr><td>{@link #setRetention(int) retention}</td><td>the time (for type=P in days and for type=T in hours) to keep the record in the database before making it eligible for deletion by a cleanup process</td><td>30 days (type=P), 4 hours (type=T)</td></tr>
* <tr><td>{@link #setNumRetries(int) numRetries}</td><td>the number of times an attempt should be made to acquire a lock, after this many times an exception is thrown when no lock could be acquired, when -1 the number of retries is unlimited</td><td>0</td></tr>
* <tr><td>{@link #setFirstDelay(int) firstDelay}</td><td>the time in ms to wait before the first attempt to acquire a lock is made, this may be 0 but keep in mind that the other thread or Ibis instance will propably not get much change to acquire a lock when another message is already waiting for the thread having the current lock in which case it will probably acquire a new lock soon after releasing the current lock</td><td>10000</td></tr>
* <tr><td>{@link #setRetryDelay(int) retryDelay}</td><td>the time in ms to wait before another attempt to acquire a lock is made</td><td>10000</td></tr>
* </table>
* </p>
*
* For an Oracle database the following objects are used:
* <pre>
CREATE TABLE <schema_owner>.IBISLOCK
(
OBJECTID VARCHAR2(100 CHAR),
TYPE CHAR(1 CHAR),
HOST VARCHAR2(100 CHAR),
CREATIONDATE TIMESTAMP(6),
EXPIRYDATE TIMESTAMP(6)
CONSTRAINT PK_IBISLOCK PRIMARY KEY (OBJECTID)
);
CREATE INDEX <schema_owner>.IX_IBISLOCK ON <schema_owner>.IBISLOCK
(EXPIRYDATE);
GRANT DELETE, INSERT, SELECT, UPDATE ON <schema_owner>.IBISLOCK TO <rolename>;
GRANT SELECT ON SYS.DBA_PENDING_TRANSACTIONS TO <rolename>;
COMMIT;
* </pre>
*
* @author Peter Leeuwenburgh
*/
public class Locker extends JdbcFacade {
private String name;
private String objectId;
private String type = "T";
private String dateFormatSuffix;
private int retention = -1;
private String insertQuery = "INSERT INTO ibisLock (objectId, type, host, creationDate, expiryDate) VALUES (?, ?, ?, ?, ?)";
private String deleteQuery = "DELETE FROM ibisLock WHERE objectId=?";
private SimpleDateFormat formatter;
private int numRetries = 0;
private int firstDelay = 10000;
private int retryDelay = 10000;
public void configure() throws ConfigurationException {
if (StringUtils.isEmpty(getObjectId())) {
throw new ConfigurationException(getLogPrefix()+ "an objectId must be specified");
}
if (!getType().equalsIgnoreCase("T") && !getType().equalsIgnoreCase("P")) {
throw new ConfigurationException(getLogPrefix()+"illegal value for type ["+getType()+"], must be 'T' or 'P'");
}
if (StringUtils.isNotEmpty(getDateFormatSuffix())) {
try {
formatter = new SimpleDateFormat(getDateFormatSuffix());
} catch (IllegalArgumentException ex){
throw new ConfigurationException(getLogPrefix()+"has an illegal value for dateFormat", ex);
}
}
if (retention<0) {
if (getType().equalsIgnoreCase("T")) {
retention = 4;
} else {
retention = 30;
}
}
}
public String lock() throws JdbcException, SQLException, InterruptedException {
String objectIdWithSuffix = null;
int r = -1;
while (objectIdWithSuffix == null && (numRetries == -1 || r < numRetries)) {
r++;
if (r == 0 && firstDelay > 0) {
Thread.sleep(firstDelay);
}
if (r > 0) {
Thread.sleep(retryDelay);
}
Date date = new Date();
objectIdWithSuffix = getObjectId();
if (StringUtils.isNotEmpty(getDateFormatSuffix())) {
String formattedDate = formatter.format(date);
objectIdWithSuffix = objectIdWithSuffix.concat(formattedDate);
}
log.debug("preparing to set lock [" + objectIdWithSuffix + "]");
Connection conn;
conn = getConnection();
try {
PreparedStatement stmt = conn.prepareStatement(insertQuery);
stmt.clearParameters();
stmt.setString(1,objectIdWithSuffix);
stmt.setString(2,getType());
stmt.setString(3,Misc.getHostname());
stmt.setTimestamp(4, new Timestamp(date.getTime()));
Calendar cal = Calendar.getInstance();
cal.setTime(date);
if (getType().equalsIgnoreCase("T")) {
cal.add(Calendar.HOUR_OF_DAY, getRetention());
} else {
cal.add(Calendar.DAY_OF_MONTH, getRetention());
}
stmt.setTimestamp(5, new Timestamp(cal.getTime().getTime()));
stmt.executeUpdate();
log.debug("lock ["+objectIdWithSuffix+"] set");
} catch (SQLException e) {
log.debug(getLogPrefix()+"error executing insert query (as part of locker): " + e.getMessage());
if (numRetries == -1 || r < numRetries) {
log.debug(getLogPrefix()+"will try again");
objectIdWithSuffix = null;
} else {
log.debug(getLogPrefix()+"will not try again");
throw e;
}
} finally {
try {
conn.close();
} catch (SQLException e) {
log.error("error closing JdbcConnection", e);
}
}
}
return objectIdWithSuffix;
}
public void unlock(String objectIdWithSuffix) throws JdbcException, SQLException {
if (getType().equalsIgnoreCase("T")) {
log.debug("preparing to remove lock [" + objectIdWithSuffix + "]");
Connection conn;
conn = getConnection();
try {
PreparedStatement stmt = conn.prepareStatement(deleteQuery);
stmt.clearParameters();
stmt.setString(1,objectIdWithSuffix);
stmt.executeUpdate();
log.debug("lock ["+objectIdWithSuffix+"] removed");
} finally {
try {
conn.close();
} catch (SQLException e) {
log.error("error closing JdbcConnection", e);
}
}
}
}
protected String getLogPrefix() {
return getName()+" ";
}
public void setName(String name) {
this.name = name;
}
public String getName() {
return name;
}
public void setDateFormatSuffix(String dateFormatSuffix) {
this.dateFormatSuffix = dateFormatSuffix;
}
public String getDateFormatSuffix() {
return dateFormatSuffix;
}
public void setType(String type) {
this.type = type;
}
public String getType() {
return type;
}
public void setObjectId(String objectId) {
this.objectId = objectId;
}
public String getObjectId() {
return objectId;
}
public void setRetention(int retention) {
this.retention = retention;
}
public int getRetention() {
return retention;
}
public int getNumRetries() {
return numRetries;
}
public void setNumRetries(int numRetries) {
this.numRetries = numRetries;
}
public int getFirstDelay() {
return firstDelay;
}
public void setFirstDelay(int firstDelay) {
this.firstDelay = firstDelay;
}
public int getRetryDelay() {
return retryDelay;
}
public void setRetryDelay(int retryDelay) {
this.retryDelay = retryDelay;
}
}