org.eclipse.webdav.client
Class WorkspaceHandle

java.lang.Object
  extended by org.eclipse.webdav.client.AbstractResourceHandle
      extended by org.eclipse.webdav.client.CollectionHandle
          extended by org.eclipse.webdav.client.WorkspaceHandle
All Implemented Interfaces:
WebDAVConstants, WebDAVPropertyNames, WebDAVPropertyValues

public class WorkspaceHandle
extends CollectionHandle

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
 
Fields inherited from class org.eclipse.webdav.client.AbstractResourceHandle
davClient, locator
 
Fields inherited from interface org.eclipse.webdav.internal.kernel.WebDAVPropertyNames
DAV_ACTIVITY_CHECKOUT_SET, DAV_ACTIVITY_VERSION_SET, DAV_AUTO_CHECKIN, DAV_AUTO_CHECKOUT, DAV_AUTO_MERGE_SET, DAV_BASELINE_COLLECTION, DAV_BASELINE_CONTROLLED_COLLECTION, DAV_BASELINE_CONTROLLED_COLLECTION_SET, DAV_BASELINE_SELECTOR, DAV_CHECKED_IN, DAV_CHECKED_OUT, DAV_CHECKIN_DATE, DAV_CHECKIN_FORK, DAV_CHECKOUT_FORK, DAV_CHECKOUT_SET, DAV_COMMENT, DAV_CREATION_DATE, DAV_CREATOR_DISPLAYNAME, DAV_CURRENT_ACTIVITY_SET, DAV_CURRENT_WORKSPACE_SET, DAV_DISPLAY_NAME, DAV_GET_CONTENT_LANGUAGE, DAV_GET_CONTENT_LENGTH, DAV_GET_CONTENT_TYPE, DAV_GET_E_TAG, DAV_GET_LAST_MODIFIED, DAV_HREF, DAV_LABEL_NAME_SET, DAV_LATEST_VERSION, DAV_LOCK_DISCOVERY, DAV_MERGE_SET, DAV_MUTABLE, DAV_PRECURSOR_SET, DAV_PREDECESSOR_SET, DAV_RESOURCE_ID, DAV_RESOURCE_TYPE, DAV_ROOT_VERSION, DAV_SOURCE, DAV_SUBACTIVITY_SET, DAV_SUBBASELINE_SET, DAV_SUCCESSOR_SET, DAV_SUPPORTED_LIVE_PROPERTY_SET, DAV_SUPPORTED_LOCK, DAV_SUPPORTED_METHOD_SET, DAV_SUPPORTED_REPORT_SET, DAV_UNRESERVED, DAV_VERSION_CONTROLLED_CONFIGURATION, DAV_VERSION_HISTORY, DAV_VERSION_NAME, DAV_VERSION_SET, DAV_WORKING_RESOURCE, DAV_WORKSPACE, DAV_WORKSPACE_CHECKOUT_SET, DAV_WORKSPACE_COLLECTION_SET
 
Fields inherited from interface org.eclipse.webdav.internal.kernel.WebDAVPropertyValues
DAV_ACTIVITY_RESOURCE_TYPE, DAV_BASELINE_RESOURCE_TYPE, DAV_COLLECTION_RESOURCE_TYPE, DAV_DISCOURAGED, DAV_FORBIDDEN, DAV_HISTORY_RESOURCE_TYPE, DAV_KEEP_CHECKED_OUT, DAV_LOCKED_UPDATE, DAV_NEW_VERSION, DAV_OK, DAV_OVERWRITE, DAV_UNLOCKED_UPDATE, DAV_VERSION_HISTORY_RESOURCE_TYPE, DAV_WORKSPACE_RESOURCE_TYPE
 
Fields inherited from interface org.eclipse.webdav.internal.kernel.WebDAVConstants
DAV_URI
 
Constructor Summary
WorkspaceHandle(DAVClient davClient, ILocator locator)
           
 
Method Summary
 AbstractResourceHandle checkOut()
          Check out this resource.
 void create()
          Create a new workspace in the location described by this handle.
 
Methods inherited from class org.eclipse.webdav.client.CollectionHandle
baselineControl, baselineControl, bind, bind, getCollectionHandle, getMember, getMembers, getResourceHandle, getWorkspaceHandle, isWorkspace, mkdirs, mkdirs
 
Methods inherited from class org.eclipse.webdav.client.AbstractResourceHandle
asCollectionHandle, asResourceHandle, canTalkDAV, checkIn, closeResponse, copy, copy, delete, delete, equals, examineMultiStatusResponse, examineResponse, examineStatusCode, exists, extractPropStats, getContent, getDAVClient, getLocator, getLocks, getParent, getProperties, getProperties, getProperty, getPropertyNames, getVersionTree, getWorkspaceCollections, hashCode, head, isCheckedIn, isCheckedOut, isCollection, isLocked, isVersion, isVersionControlled, isWorkingResource, lock, lock, move, move, newContext, newDocument, propertyHasChild, protectedCheckIn, protectedCheckOut, refreshLock, removeProperties, removeProperty, setContent, setContent, setProperties, setProperty, supportsLiveProperty, toString, trace, unlock, update, versionControl
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WorkspaceHandle

public WorkspaceHandle(DAVClient davClient,
                       ILocator locator)
Method Detail

checkOut

public AbstractResourceHandle checkOut()
                                throws DAVException
Check out this resource. Returns a resource handle on the checked out version selector, or the working resource if a version is checked out.

Overrides:
checkOut in class CollectionHandle
Returns:
the checked out resource as a CollectionHandle.
Throws:
DAVException - if there is a problem checking out the receiver.

create

public void create()
            throws DAVException
Create a new workspace in the location described by this handle.

A new workspace is created using a MKWORKSPACE method call.

Overrides:
create in class CollectionHandle
Throws:
DAVException - if a problem occured creating the workspace on the WebDAV server.
See Also:
IServer#mkcol(ILocator, IContext, IElement)


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.