net.brutex.xservices.ws.rs

Interface DIMCMInfo

All Known Implementing Classes:

DIMCMInfoImpl

@Path(value="/")
public interface DIMCMInfo

The Dim CM Browsing Rest Service.

Author:

Brian Rosenberger, bru(at)brutex.de

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_PATH
static java.lang.String	SERVICE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getFiles(javax.ws.rs.core.HttpHeaders paramHttpHeaders, javax.ws.rs.core.UriInfo uriInfo, java.lang.String project, java.lang.String directory, boolean recursive, boolean includeFiles, int depth, java.lang.String search, int itemsPerPage, int page, boolean useCache) Get the file/ directory listing.

Field Detail

BASE_PATH

static final java.lang.String BASE_PATH

See Also:

Constant Field Values

SERVICE_NAME

static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

getFiles

@Path(value="getItems/")
javax.ws.rs.core.Response getFiles(@Context
                                      javax.ws.rs.core.HttpHeaders paramHttpHeaders,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      java.lang.String project,
                                      java.lang.String directory,
                                      boolean recursive,
                                      boolean includeFiles,
                                      int depth,
                                      java.lang.String search,
                                      int itemsPerPage,
                                      int page,
                                      boolean useCache)
                                   throws org.apache.jcs.access.exception.CacheException

Get the file/ directory listing.

Parameters:

paramHttpHeaders - the param http headers

uriInfo - request url info

directory - The directory to list.

includeDirectories - Whether or not to include directories in the listing. Default is true.

includeFiles - Whether or not to include files in the listing. Default is true.

depth - Include subdirectories down to a given depth. Default is 1.

search - Additional "Glob search pattern" for the file/ directory name. I.e. '*.log'

itemsPerPage - How many items to return with one call. Default is 50.

page - Paging support. Default is 1.

useCache - whether or not to use cache. Defaults to true.

Returns:

the FileInfo Set as an XML structure

Throws:

org.apache.jcs.access.exception.CacheException