Java Doc for ActiveLock.java in  » Content-Management-System » harmonise » com » ibm » webdav » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » harmonise » com.ibm.webdav   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    com.ibm.webdav.ActiveLock ActiveLock public class ActiveLock extends Object (Code) ActiveLock contains information about locks on this resourece. The information can be used to provide details when obtaining locks, or for holding results from lock queries. It combines the activelock DAV element with the principal, and the lock expiration date. author:    Jim Amsden <jamsden@us.ibm.com> Field Summary final public static  String exclusive      Only one exclusive lock can be granted at any time on a resource. final public static  String shared      A resource may have many concurrent shared locks which indicate an intention to change the resource in some way. final public static  String writeLock      Write locks allow a resource to be updated or deleted. Constructor Summary public   ActiveLock()      The default constructor. public   ActiveLock(Element activeLock)      Convert an activelock Element into a ActiveLock instance for convenient access to the lock information. Method Summary public  Element asXML()      Translate this ActiveLock instance into an activelock XML element. public  String getDepth()      Get the depth of the lock. public  Date getExpiration()      Get the date and time when the lock will timeout. public  String getLockToken()      Get the lock token. public  String getLockType()      Get the type of the lock. public  Element getOwner()      Get the owner of the lock. public  String getPrincipal()      Get the user authorization id of the owner of the lock. public  String getScope()      Get the scope of the lock. public  long getTimeRemaining()      public  String getTimeout()      Get the lock timeout. public  void setDepth(String depth)      Set the depth of the lock. public  void setExpiration(Date value)      Set the date and time when the lock will timeout. public  void setLockToken(String lockToken)      Set the lock token. public  void setLockType(String lockType)      Set the type of the lock. Parameters:   lockType - write (other lock types may be supported in the future) exception:   com.ibm.webdav.ClientException - thrown if the lockType is incorrect. public  void setOwner(Element owner)      Set the owner of the lock. public  void setOwner(String sOwner)      public  void setPrincipal(String value)      Set the user authorization id of the owner of the lock. public  void setScope(String scope)      Set the scope of the lock. public  void setTimeout(int timeout)      Set the lock timeout. Parameters:   timeout - the lock timeout in seconds. public  void setTimeout(String timeout)      Set the lock timeout. Parameters:   timeout - the lock timeout as either Second-n or "Infinite" for notimeout. public  String toString()      Convert this ActiveLock to a String representation (an activelock XML element). Field Detail exclusive final public static String exclusive(Code) Only one exclusive lock can be granted at any time on a resource. shared final public static String shared(Code) A resource may have many concurrent shared locks which indicate an intention to change the resource in some way. It is the responsibilty of the shared lock owners to coordinate their updates appropriately through other means. writeLock final public static String writeLock(Code) Write locks allow a resource to be updated or deleted. Constructor Detail ActiveLock public ActiveLock()(Code) The default constructor. ActiveLock public ActiveLock(Element activeLock) throws WebDAVException(Code) Convert an activelock Element into a ActiveLock instance for convenient access to the lock information. This method uses two IBM extensions to the WebDAV activelock element, one for the principal, and onother for the lock expiration time. Parameters:   an - activelock Element containing information about the lock exception:   com.ibm.webdav.WebDAVException - Method Detail asXML public Element asXML()(Code) Translate this ActiveLock instance into an activelock XML element. The activelock element will include two IBM extensions, one for the principal owning the lock (the authorization id), and another containing the expiration date for the lock. the DOM representation of an activelock XML element getDepth public String getDepth()(Code) Get the depth of the lock. shallow: only this resource is locked or will be locked deep: this resource and recursively, all its internal members are locked shallow or deep getExpiration public Date getExpiration()(Code) Get the date and time when the lock will timeout. Null means it will never timeout. This is an IBM EXTENSION. the expiration date for the lock getLockToken public String getLockToken()(Code) Get the lock token. A lock token represents the lock, and is used to unlock the resource or for any access that might change the resource state. There may be many (shared) locks on a resource, each with its own lock token. Each lock will have its own ActiveLock instance describing the lock and providing access to the lock token. See the lockdiscovery DAV property. the lock token identifying a lock on this resource. getLockType public String getLockType()(Code) Get the type of the lock. write (other lock types may be supported in the future) getOwner public Element getOwner()(Code) Get the owner of the lock. The method provides information about the principal taking out the lock, but not necessarily the principal's authorization ID. any information that might identify the principal taking out thelock. getPrincipal public String getPrincipal()(Code) Get the user authorization id of the owner of the lock. This is an IBM EXTENSION to the WebDAV activelock. the principal owning this lock as given in the Authorizationcontext on lock getScope public String getScope()(Code) Get the scope of the lock. exclusive or shared getTimeRemaining public long getTimeRemaining()(Code) Get the time remaining before the lock times out the number of seconds that must elapse before the lock times out.0 means the lock has timed out. getTimeout public String getTimeout()(Code) Get the lock timeout. the lock timeout as either Second-n or "Infinite" for no timeout. setDepth public void setDepth(String depth) throws ClientException(Code) Set the depth of the lock. shallow: only this resource is locked or will be locked deep: this resource and recursively, all its internal members are locked Parameters:   depth - shallow or deep exception:   com.ibm.webdav.ClientException - thrown if the depth is incorrect setExpiration public void setExpiration(Date value)(Code) Set the date and time when the lock will timeout. Null means it will never timeout. This is an IBM EXTENSION. setLockToken public void setLockToken(String lockToken)(Code) Set the lock token. Parameters:   lockToken - the lock token corresponding to a lock on a resource. setLockType public void setLockType(String lockType) throws ClientException(Code) Set the type of the lock. Parameters:   lockType - write (other lock types may be supported in the future) exception:   com.ibm.webdav.ClientException - thrown if the lockType is incorrect. Currently, only writelocks are supported. setOwner public void setOwner(Element owner)(Code) Set the owner of the lock. The method sets the information about the principal taking out the lock. This is not necessarily the authorization id of the principal owning the lock, and therefore cannot be relied upon for authentication. Parameters:   owner - any information that might identify the principal taking outthe lock. setOwner public void setOwner(String sOwner)(Code) setPrincipal public void setPrincipal(String value)(Code) Set the user authorization id of the owner of the lock. This is and IBM EXTENSION. setScope public void setScope(String scope) throws ClientException(Code) Set the scope of the lock. Parameters:   scope - exclusive or shared exception:   com.ibm.webdav.ClientException - thrown if the scope is invalid setTimeout public void setTimeout(int timeout)(Code) Set the lock timeout. Parameters:   timeout - the lock timeout in seconds. -1 means infinite timeout. setTimeout public void setTimeout(String timeout)(Code) Set the lock timeout. Parameters:   timeout - the lock timeout as either Second-n or "Infinite" for notimeout. Any other syntax is ignored. toString public String toString()(Code) Convert this ActiveLock to a String representation (an activelock XML element). a String representation of the ActiveLock as an activelockelement Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)