/**
* Licensed to Jasig under one or more contributor license
* agreements. See the NOTICE file distributed with this work
* for additional information regarding copyright ownership.
* Jasig 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.
*/
package org.jasig.portal.concurrency.locking;
import java.util.Date;
import org.jasig.portal.concurrency.IEntityLock;
import org.jasig.portal.concurrency.IEntityLockService;
import org.jasig.portal.concurrency.LockingException;
/**
* An implementation of IEntityLock. A lock is granted to a
* <code>lockOwner</code> for an <code>entityType</code> and
* <code>entityKey</code>. It guarantees some degree of exclusive
* access to the entity, depending on <code>lockType</code> and
* <code>expirationTime</code>.
*
* @author Dan Ellentuck
* @version $Revision: 19776 $
* @see org.jasig.portal.concurrency.IEntityLock
*/
public class EntityLockImpl implements IEntityLock {
private Class entityType;
private String entityKey;
private String lockOwner;
private Date expirationTime;
private int lockType;
private IEntityLockService service;
/**
*
*/
protected EntityLockImpl (
Class newEntityType,
String newEntityKey,
int newLockType,
Date newExpirationTime,
String newLockOwner )
{
super();
setEntityType(newEntityType);
setEntityKey(newEntityKey);
setLockType(newLockType);
setExpirationTime(newExpirationTime);
setLockOwner(newLockOwner);
}
/**
*
*/
protected EntityLockImpl (
Class newEntityType,
String newEntityKey,
int newLockType,
Date newExpirationTime,
String newLockOwner,
IEntityLockService newService)
{
super();
setEntityType(newEntityType);
setEntityKey(newEntityKey);
setLockType(newLockType);
setExpirationTime(newExpirationTime);
setLockOwner(newLockOwner);
setService(newService);
}
/**
* Delegate to the service.
* @param newType int
* @exception org.jasig.portal.concurrency.LockingException - if the conversion fails.
*/
public void convert(int newType) throws LockingException
{
getService().convert(this, newType);
}
/**
* Delegate to the service.
* @param newType int
* @param duration int
* @exception org.jasig.portal.concurrency.LockingException - if the conversion fails.
*/
public void convert(int newType, int duration) throws LockingException
{
getService().convert(this, newType);
}
/**
* @param obj the Object to compare with
* @return true if these Objects are equal; false otherwise.
* @see java.util.Hashtable
*/
public boolean equals(Object obj)
{
if ( obj == null )
return false;
if ( obj == this )
return true;
if ( ! ( obj instanceof EntityLockImpl))
return false;
IEntityLock candidate = (IEntityLock) obj;
return this.getEntityType().equals(candidate.getEntityType()) &&
this.getEntityKey().equals(candidate.getEntityKey()) &&
this.getLockOwner().equals(candidate.getLockOwner()) &&
this.getLockType() == candidate.getLockType() &&
this.getExpirationTime().equals(candidate.getExpirationTime());
}
/**
*/
protected void expire()
{
setExpirationTime(new Date(0));
}
/**
* @throws Throwable
*/
protected void finalize() throws Throwable
{
super.finalize();
}
/**
* @return java.lang.String
*/
public String getEntityKey() {
return entityKey;
}
/**
* @see org.jasig.portal.EntityTypes for known types.
* @return java.lang.Class
*/
public Class getEntityType() {
return entityType;
}
/**
* @return java.util.Date
*/
public Date getExpirationTime() {
return expirationTime;
}
/**
* Could be the portal user or the framework or ...?
* @return java.lang.String
*/
public String getLockOwner() {
return lockOwner;
}
/**
* See IEntityLockingService for a description of lock types.
* @return int
*/
public int getLockType() {
return lockType;
}
/**
* @return org.jasig.portal.concurrency.locking.IEntityLockService
*/
protected IEntityLockService getService() {
return service;
}
/**
* This method is supported primarily for hash tables, such as those provided in java.util.
* @return an integer hash code for the receiver
* @see java.util.Hashtable
*/
public int hashCode()
{
return getEntityType().hashCode() + getEntityKey().hashCode() + getLockOwner().hashCode();
}
/**
* Answer if the lock is unexpired.
* @return boolean
*/
public boolean isLocked() {
return getExpirationTime().after(new Date());
}
/**
* Delegate to the service.
* @return boolean
*/
public boolean isValid() throws LockingException
{
return getService().isValid(this);
}
/**
* Delegate to the service.
*/
public void release() throws LockingException
{
getService().release(this);
}
/**
* Delegate to the service.
*/
public void renew() throws LockingException
{
getService().renew(this);
}
/**
* Delegate to the service.
*/
public void renew(int duration) throws LockingException
{
getService().renew(this, duration);
}
/**
* @param newEntityKey
*/
private void setEntityKey(String newEntityKey) {
entityKey = newEntityKey;
}
/**
* @param newEntityType
*/
private void setEntityType(Class newEntityType) {
entityType = newEntityType;
}
/**
* @param newExpirationTime
*/
void setExpirationTime(Date newExpirationTime) {
expirationTime = newExpirationTime;
}
/**
* @param newLockOwner
*/
private void setLockOwner(String newLockOwner) {
lockOwner = newLockOwner;
}
/**
* @param newLockType
*/
void setLockType(int newLockType) {
lockType = newLockType;
}
/**
* @param newService org.jasig.portal.concurrency.locking.IEntityLockService
*/
private void setService(IEntityLockService newService) {
service = newService;
}
/**
* Returns a String that represents the value of this object.
* @return a string representation of the receiver
*/
public String toString()
{
return "EntityLockImpl for " + getEntityType().getName() + "(" + getEntityKey() + ")" +
" type " + getLockType() + " owner " + getLockOwner() + " " + getExpirationTime();
}
}