|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.concurrency.locking.EntityLockImpl
An implementation of IEntityLock. A lock is granted to a
lockOwner
for an entityType
and
entityKey
. It guarantees some degree of exclusive
access to the entity, depending on lockType
and
expirationTime
.
IEntityLock
Method Summary | |
void |
convert(int newType)
Delegate to the service. |
void |
convert(int newType,
int duration)
Delegate to the service. |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getEntityKey()
|
java.lang.Class |
getEntityType()
|
java.util.Date |
getExpirationTime()
|
java.lang.String |
getLockOwner()
Could be the portal user or the framework or ...? |
int |
getLockType()
See IEntityLockingService for a description of lock types. |
int |
hashCode()
This method is supported primarily for hash tables, such as those provided in java.util. |
boolean |
isLocked()
Answer if the lock is unexpired. |
boolean |
isValid()
Delegate to the service. |
void |
release()
Delegate to the service. |
void |
renew()
Delegate to the service. |
void |
renew(int duration)
Delegate to the service. |
java.lang.String |
toString()
Returns a String that represents the value of this object. |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
public void convert(int newType) throws LockingException
convert
in interface IEntityLock
newType
- int
LockingException
- - if the conversion fails.public void convert(int newType, int duration) throws LockingException
convert
in interface IEntityLock
newType
- intduration
- int
LockingException
- - if the conversion fails.public boolean equals(java.lang.Object obj)
obj
- the Object to compare with
Hashtable
public java.lang.String getEntityKey()
getEntityKey
in interface IEntityLock
public java.lang.Class getEntityType()
getEntityType
in interface IEntityLock
for known types.
public java.util.Date getExpirationTime()
getExpirationTime
in interface IEntityLock
public java.lang.String getLockOwner()
getLockOwner
in interface IEntityLock
public int getLockType()
getLockType
in interface IEntityLock
public int hashCode()
Hashtable
public boolean isLocked()
public boolean isValid() throws LockingException
isValid
in interface IEntityLock
LockingException
public void release() throws LockingException
release
in interface IEntityLock
LockingException
public void renew() throws LockingException
renew
in interface IEntityLock
LockingException
public void renew(int duration) throws LockingException
renew
in interface IEntityLock
LockingException
public java.lang.String toString()
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |