com.sssw.webdav.event.api
Class EboLockEvent

java.lang.Object
 |
 +--com.sssw.fw.event.api.EboEvent
       |
       +--com.sssw.fw.event.api.EboStateChangeEvent
             |
             +--com.sssw.webdav.event.api.EboWebdavEvent
                   |
                   +--com.sssw.webdav.event.api.EboLockEvent

All Implemented Interfaces:

Serializable

public class EboLockEvent

extends EboWebdavEvent

This event is fired off when a WebDAV LOCK method is executed.

See Also:

Serialized Form

Fields inherited from class com.sssw.fw.event.api.EboStateChangeEvent

EVENT_ID_BASE, EVENT_ID_LAST, EVENT_ID_UNKNOWN, SC_BASE, SC_CHECK_ACCESS, SC_CLEAR, SC_COPY, SC_CREATE, SC_DEFAULT, SC_DELETE, SC_EXECUTE, SC_EXPORT, SC_FAIL, SC_GENERATE, SC_IMPORT, SC_INVALIDATE, SC_LAST, SC_LIST, SC_LOGOFF, SC_LOGON, SC_MOVE, SC_PUT, SC_QUERY, SC_REDEPLOY, SC_REGISTERED, SC_RETRIEVE, SC_SELECT, SC_SILENCE, SC_START, SC_STATUS, SC_STOP, SC_UNREGISTERED, SC_UPDATE, STR_SC_CHECK_ACCESS, STR_SC_CLEAR, STR_SC_COPY, STR_SC_CREATE, STR_SC_DEFAULT, STR_SC_DELETE, STR_SC_EXECUTE, STR_SC_EXPORT, STR_SC_FAIL, STR_SC_GENERATE, STR_SC_IMPORT, STR_SC_INVALIDATE, STR_SC_LIST, STR_SC_LOGOFF, STR_SC_LOGON, STR_SC_MOVE, STR_SC_QUERY, STR_SC_REGISTERED, STR_SC_RETRIEVE, STR_SC_SELECT, STR_SC_SILENCE, STR_SC_START, STR_SC_STATUS, STR_SC_STOP, STR_SC_UNKNOWN, STR_SC_UNREGISTERED, STR_SC_UPDATE

Constructor Summary

EboLockEvent()
Constructor.

Method Summary

int	getDepth() Gets the depth for the LOCK method.
int	getDuration() Gets the lock duration.
int	getEventID() Gets the event ID.
String	getLockInfoType() Gets the lock type string.
int	getLockType() Gets the lock type.
boolean	getMsProprietary() Gets the flag that indicates the WebDAV client is a Microsoft client.
String	getOwner() Gets the owner of the lock.
String	getResource() Gets the URI of CM resource to lock.
String	getScope() Gets the scope for the LOCK method.
String	getVerboseDescr() Gets a verbose description of the event.
void	setDepth(int depth) Sets the depth for the LOCK method.
void	setDuration(int duration) Sets the lock duration.
void	setLockInfoType(String lockInfoType) Sets the lock type string.
void	setLockType(int lockType) Sets the lock type.
void	setMsProprietary(boolean isMsProprietary) Sets the flag that indicates the WebDAV client is a Microsoft client.
void	setOwner(String owner) Sets the owner of the lock.
void	setResource(String entry) Sets the URI of CM resource to lock.
void	setScope(String scope) Sets the scope for the LOCK method.

Methods inherited from class com.sssw.webdav.event.api.EboWebdavEvent

getContext, getStateDescr, setContext

Methods inherited from class com.sssw.fw.event.api.EboStateChangeEvent

getState, setState

Methods inherited from class com.sssw.fw.event.api.EboEvent

getObject, setObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EboLockEvent

public EboLockEvent()

Constructor. Initializes the state to WEBDAV_SC_LOCK

Method Detail

getResource

public String getResource()

Gets the URI of CM resource to lock.

Returns:

the CM resource URI

getDepth

public int getDepth()

Gets the depth for the LOCK method.

Returns:

the depth

getDuration

public int getDuration()

Gets the lock duration.

Returns:

the lock duration

getLockType

public int getLockType()

Gets the lock type. Lock type is one of the following values:
Lock Creation = 0
Lock Refresh = 1

Returns:

the lock type

getScope

public String getScope()

Gets the scope for the LOCK method.

Returns:

the scope

getOwner

public String getOwner()

Gets the owner of the lock.

Returns:

the lock owner

getMsProprietary

public boolean getMsProprietary()

Gets the flag that indicates the WebDAV client is a Microsoft client.

Returns:

the Microsoft client flag

getLockInfoType

public String getLockInfoType()

Gets the lock type string.

Returns:

the lock type string

setLockInfoType

public void setLockInfoType(String lockInfoType)

Sets the lock type string.

Parameters:

lockInfoType - the lock type string

setMsProprietary

public void setMsProprietary(boolean isMsProprietary)

Sets the flag that indicates the WebDAV client is a Microsoft client.

Parameters:

isMsProprietary - the Microsoft client flag

setOwner

public void setOwner(String owner)

Sets the owner of the lock.

Parameters:

the - lock owner

setScope

public void setScope(String scope)

Sets the scope for the LOCK method.

Parameters:

scope - the scope

setLockType

public void setLockType(int lockType)

Sets the lock type. Lock type is one of the following values:
Lock Creation = 0
Lock Refresh = 1

Parameters:

lockType - the lock type

setDepth

public void setDepth(int depth)

Sets the depth for the LOCK method.

Parameters:

depth - the depth

setDuration

public void setDuration(int duration)

Sets the lock duration.

Parameters:

duration - the lock duration

setResource

public void setResource(String entry)

Sets the URI of CM resource to lock.

Parameters:

entry - the CM resource URI

getVerboseDescr

public String getVerboseDescr()

Gets a verbose description of the event.

Overrides:

getVerboseDescr in class EboWebdavEvent

Returns:

a verbose description of the event

getEventID

public int getEventID()

Gets the event ID.

Overrides:

getEventID in class EboWebdavEvent

Returns:

the event ID