org.exoplatform.services.jcr.webdav

Interface WebDavService

All Known Implementing Classes:

WebDavServiceImpl

public interface WebDavService

Created by The eXo Platform SARL .
JCR WebDAV entry point. Defines WebDav protocol methods: RFC-2518 HTTP Extensions for Distributed Authoring -- WEBDAV RFC-3253 Versioning Extensions to WebDAV RFC-3648: Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol

Author:

Gennady Azarenkov

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acl(String repoName, String repoPath, String lockTokenHeader, String ifHeader, org.exoplatform.common.util.HierarchicalProperty body) WebDAV ACL method according to protocol extension - Access Control Protocol: RFC3744 More details here: Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol
javax.ws.rs.core.Response	checkin(String repoName, String repoPath, String lockTokenHeader, String ifHeader)
javax.ws.rs.core.Response	checkout(String repoName, String repoPath, String lockTokenHeader, String ifHeader)
javax.ws.rs.core.Response	copy(String repoName, String repoPath, String destinationHeader, String lockTokenHeader, String ifHeader, String depthHeader, String overwriteHeader, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	delete(String repoName, String repoPath, String lockTokenHeader, String ifHeader)
javax.ws.rs.core.Response	get(String repoName, String repoPath, String range, String ifModifiedSince, String ifNoneMatch, String version, javax.ws.rs.core.UriInfo baseURI) WedDAV "GET" method.
javax.ws.rs.core.Response	head(String repoName, String repoPath, javax.ws.rs.core.UriInfo baseURI) WedDAV "HEAD" method.
javax.ws.rs.core.Response	lock(String repoName, String repoPath, String lockTokenHeader, String ifHeader, String depth, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	mkcol(String repoName, String repoPath, String lockTokenHeader, String ifHeader, String nodeTypeHeader, String mixinTypesHeader, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	move(String repoName, String repoPath, String destinationHeader, String lockTokenHeader, String ifHeader, String depthHeader, String overwriteHeader, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	options(String repoName)
javax.ws.rs.core.Response	order(String repoName, String repoPath, String lockTokenHeader, String ifHeader, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	propfind(String repoName, String repoPath, String depthHeader, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	proppatch(String repoName, String repoPath, String lockTokenHeader, String ifHeader, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	put(String repoName, String repoPath, String lockTokenHeader, String ifHeader, String fileNodeTypeHeader, String contentNodeTypeHeader, String mixinTypes, javax.ws.rs.core.MediaType mediaType, String userAgent, InputStream inputStream, javax.ws.rs.core.UriInfo uriInfo) WedDAV "PUT" method.
javax.ws.rs.core.Response	report(String repoName, String repoPath, String depth, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	search(String repoName, String repoPath, javax.ws.rs.core.UriInfo baseURI, org.exoplatform.common.util.HierarchicalProperty body)
javax.ws.rs.core.Response	uncheckout(String repoName, String repoPath, String lockTokenHeader, String ifHeader)
javax.ws.rs.core.Response	unlock(String repoName, String repoPath, String lockTokenHeader, String ifHeader)
javax.ws.rs.core.Response	versionControl(String repoName, String repoPath, String lockTokenHeader, String ifHeader)

Method Detail

get

javax.ws.rs.core.Response get(String repoName,
                              String repoPath,
                              String range,
                              String ifModifiedSince,
                              String ifNoneMatch,
                              String version,
                              javax.ws.rs.core.UriInfo baseURI)

WedDAV "GET" method. See HTTP methods for distributed authoring sec. 8.4 "GET, HEAD for Collections".

Parameters:

repoName - repository name

repoPath - path in repository

range - Range HTTP header

version - version name

ifModifiedSince - if-modified-since header

ifModifiedSince - if-none-match header

baseURI - base URI info

Returns:

the instance of javax.ws.rs.core.Response

head

javax.ws.rs.core.Response head(String repoName,
                               String repoPath,
                               javax.ws.rs.core.UriInfo baseURI)

WedDAV "HEAD" method. see HTTP methods for distributed authoring sec. 8.4 "GET, HEAD for Collections".

Parameters:

repoName - repository name

repoPath - path in repository

baseURI - base URI info

Returns:

the instance of javax.ws.rs.core.Response

put

javax.ws.rs.core.Response put(String repoName,
                              String repoPath,
                              String lockTokenHeader,
                              String ifHeader,
                              String fileNodeTypeHeader,
                              String contentNodeTypeHeader,
                              String mixinTypes,
                              javax.ws.rs.core.MediaType mediaType,
                              String userAgent,
                              InputStream inputStream,
                              javax.ws.rs.core.UriInfo uriInfo)

WedDAV "PUT" method. See HTTP methods for distributed authoring sec. 8.7 "PUT".

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If HTTP Header

fileNodeTypeHeader - JCR NodeType header

contentNodeTypeHeader - JCR Content-NodeType header

mixinTypes - JCR Mixin types header

mediaType - Content-Type HTTP header

userAgent - User-Agent HTTP header

inputStream - stream that contain incoming data

uriInfo - URI info

Returns:

the instance of javax.ws.rs.core.Response

delete

javax.ws.rs.core.Response delete(String repoName,
                                 String repoPath,
                                 String lockTokenHeader,
                                 String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

copy

javax.ws.rs.core.Response copy(String repoName,
                               String repoPath,
                               String destinationHeader,
                               String lockTokenHeader,
                               String ifHeader,
                               String depthHeader,
                               String overwriteHeader,
                               javax.ws.rs.core.UriInfo baseURI,
                               org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

destinationHeader - Destination HTTP Header

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

depthHeader - Depth HTTP header

overwriteHeader - Overwrite HTTP header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

mkcol

javax.ws.rs.core.Response mkcol(String repoName,
                                String repoPath,
                                String lockTokenHeader,
                                String ifHeader,
                                String nodeTypeHeader,
                                String mixinTypesHeader,
                                javax.ws.rs.core.UriInfo uriInfo)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

nodeTypeHeader - JCR Node-Type header

mixinTypesHeader - JCR Mixin-Types header

Returns:

the instance of javax.ws.rs.core.Response

move

javax.ws.rs.core.Response move(String repoName,
                               String repoPath,
                               String destinationHeader,
                               String lockTokenHeader,
                               String ifHeader,
                               String depthHeader,
                               String overwriteHeader,
                               javax.ws.rs.core.UriInfo baseURI,
                               org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

destinationHeader - Destination HTTP header

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

depthHeader - Depth HTTP header

overwriteHeader - Overwrite HTTP header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

options

javax.ws.rs.core.Response options(String repoName)

Parameters:

repoName - repository name

Returns:

the instance of javax.ws.rs.core.Response

propfind

javax.ws.rs.core.Response propfind(String repoName,
                                   String repoPath,
                                   String depthHeader,
                                   javax.ws.rs.core.UriInfo baseURI,
                                   org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

depthHeader - Depth HTTP header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response HTTP response

proppatch

javax.ws.rs.core.Response proppatch(String repoName,
                                    String repoPath,
                                    String lockTokenHeader,
                                    String ifHeader,
                                    javax.ws.rs.core.UriInfo baseURI,
                                    org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response HTTP response

lock

javax.ws.rs.core.Response lock(String repoName,
                               String repoPath,
                               String lockTokenHeader,
                               String ifHeader,
                               String depth,
                               org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

depth - Depth HTTP header

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

unlock

javax.ws.rs.core.Response unlock(String repoName,
                                 String repoPath,
                                 String lockTokenHeader,
                                 String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

checkin

javax.ws.rs.core.Response checkin(String repoName,
                                  String repoPath,
                                  String lockTokenHeader,
                                  String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

checkout

javax.ws.rs.core.Response checkout(String repoName,
                                   String repoPath,
                                   String lockTokenHeader,
                                   String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

report

javax.ws.rs.core.Response report(String repoName,
                                 String repoPath,
                                 String depth,
                                 javax.ws.rs.core.UriInfo baseURI,
                                 org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

depth - Depth HTTP header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

uncheckout

javax.ws.rs.core.Response uncheckout(String repoName,
                                     String repoPath,
                                     String lockTokenHeader,
                                     String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

versionControl

javax.ws.rs.core.Response versionControl(String repoName,
                                         String repoPath,
                                         String lockTokenHeader,
                                         String ifHeader)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

Returns:

the instance of javax.ws.rs.core.Response

order

javax.ws.rs.core.Response order(String repoName,
                                String repoPath,
                                String lockTokenHeader,
                                String ifHeader,
                                javax.ws.rs.core.UriInfo baseURI,
                                org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

search

javax.ws.rs.core.Response search(String repoName,
                                 String repoPath,
                                 javax.ws.rs.core.UriInfo baseURI,
                                 org.exoplatform.common.util.HierarchicalProperty body)

Parameters:

repoName - repository name

repoPath - path in repository

baseURI - base URI info

body - Request body

Returns:

the instance of javax.ws.rs.core.Response

acl

javax.ws.rs.core.Response acl(String repoName,
                              String repoPath,
                              String lockTokenHeader,
                              String ifHeader,
                              org.exoplatform.common.util.HierarchicalProperty body)

WebDAV ACL method according to protocol extension - Access Control Protocol: RFC3744 More details here: Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol

Parameters:

repoName - repository name

repoPath - path in repository

lockTokenHeader - Lock-Token HTTP header

ifHeader - If- HTTP Header

body - Request body

Returns:

the instance of javax.ws.rs.core.Response