org.modeshape.web.jcr.rest.client

Interface IRestClient

All Known Implementing Classes:

JsonRestClient

public interface IRestClient

The IRestClient interface is the API for all REST clients used by the Eclipse ModeShape plugin.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	fileExists(File file, Workspace workspace, String path) Checks if the given file exists or not on the server, by issuing a GET request.
Map<String,NodeType>	getNodeTypes(Repository repository) Obtains the ModeShape node types defined within the specified workspace.
Collection<Repository>	getRepositories(Server server) Obtains the ModeShape repositories defined within the specified server.
URL	getUrl(File file, String path, Workspace workspace) Returns a url string, representing a "server recognizable" url for a the given file.
Collection<Workspace>	getWorkspaces(Repository repository) Obtains the workspaces defined within the specified ModeShape respository.
Status	markAsPublishArea(Workspace workspace, String path, String title, String description) Marks the last folder of the given path as a publish area, by adding the mode:publishArea mixin.
String	planForQuery(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables) Compute the plan for the supplied query in the workspace.
Status	publish(Workspace workspace, String path, File file) Publishes, or uploads, a local file to the workspace at the specified path.
Status	publish(Workspace workspace, String path, File file, boolean useVersioning) Publishes, or uploads, a local file to the workspace at the specified path.
List<QueryRow>	query(Workspace workspace, String language, String statement) Executes the given query in the workspace.
List<QueryRow>	query(Workspace workspace, String language, String statement, int offset, int limit) Executes the given query in the workspace.
List<QueryRow>	query(Workspace workspace, String language, String statement, int offset, int limit, Map<String,String> variables) Executes the given query in the workspace.
Status	unmarkAsPublishArea(Workspace workspace, String path) Unmarks the last folder of the given path as a publish area, by removing the mode:publishArea mixin.
Status	unpublish(Workspace workspace, String path, File file) Unpublishes, or deletes, the resource at the specified path in the workspace.
Server	validate(Server server) Determines whether the specified server is valid and can be used to establish a connection.

Method Detail

validate

Server validate(Server server)
                throws Exception

Determines whether the specified server is valid and can be used to establish a connection. This method returns a Server instance (that may be slightly different than the supplied Server instance, based upon the version of the server being used) and which should be used in all subsequent operations.

Parameters:

server - the server (never null)

Returns:

the validated server, which should be used in all subsequent operations (never null)

Throws:

Exception - if there is a problem validating the server

Since:

3.0

getRepositories

Collection<Repository> getRepositories(Server server)
                                       throws Exception

Obtains the ModeShape repositories defined within the specified server.

Parameters:

server - the server whose repositories are being requested (never null)

Returns:

the repositories within the specified server (never null)

Throws:

Exception - if there is a problem obtaining the repositories

getNodeTypes

Map<String,NodeType> getNodeTypes(Repository repository)
                                  throws Exception

Obtains the ModeShape node types defined within the specified workspace.

Parameters:

repository - for whose node types are being requested (never null)

Returns:

the node types defined within the specified workspace (never null)

Throws:

Exception - if there is a problem obtaining the node types

getUrl

URL getUrl(File file,
         String path,
         Workspace workspace)
           throws Exception

Returns a url string, representing a "server recognizable" url for a the given file. NOTE: This does not issue a request

Parameters:

file - the file whose URL is being requested (never null)

path - the path in the ModeShape workspace where the file is/could be located (never null)

workspace - the workspace where the file is/could be located (never null)

Returns:

the workspace URL for the specified file (never null)

Throws:

Exception - if there is a problem obtaining the URL or if the file is a directory

fileExists

boolean fileExists(File file,
                 Workspace workspace,
                 String path)
                   throws Exception

Checks if the given file exists or not on the server, by issuing a GET request.

Parameters:

file - the file whose existence is checked, (never null)

workspace - the workspace where the file is/could be located (never null)

path - the path in the ModeShape workspace to the parent of the file (never null)

Returns:

true if the file exists on the server, or false otherwise.

Throws:

Exception - if there is a problem while performing the check

getWorkspaces

Collection<Workspace> getWorkspaces(Repository repository)
                                    throws Exception

Obtains the workspaces defined within the specified ModeShape respository.

Parameters:

repository - the repository whose workspaces are being requested (never null)

Returns:

the workspaces within the specified repository (never null)

Throws:

Exception - if there is a problem obtaining the workspaces

publish

Status publish(Workspace workspace,
             String path,
             File file)

Publishes, or uploads, a local file to the workspace at the specified path. This method does not utilize any versioning, and is equivalent to calling "publish(workspace,path,file,false) ".

Parameters:

workspace - the workspace where the resource will be published (never null)

path - the unencoded path to the folder where the file will be published (never null)

file - the resource being published (never null)

Returns:

a status of the publishing operation outcome (never null)

publish

Status publish(Workspace workspace,
             String path,
             File file,
             boolean useVersioning)

Publishes, or uploads, a local file to the workspace at the specified path. This method allows the client to specify whether the uploaded file should be versioned. If so, this method will add the "mix:versionable" mixin to the "nt:file" node, and subsequent attempts to re-publish will result in new versions in the version history of the file. If no versioning is to be done, then no version history is maintained for the file, and subsequent attemps to re-publish will simply overwrite any existing content.

Parameters:

workspace - the workspace where the resource will be published (never null)

path - the unencoded path to the folder where the file will be published (never null)

file - the resource being published (never null)

useVersioning - true if the uploaded file should be versioned, or false if no JCR versioning be used

Returns:

a status of the publishing operation outcome (never null)

unpublish

Status unpublish(Workspace workspace,
               String path,
               File file)

Unpublishes, or deletes, the resource at the specified path in the workspace. If a file being unpublished is not found in the workspace an info status is returned.

Parameters:

workspace - the workspace where the resource will be unpublished (never null)

path - the unencoded path to the folder where the file is published (never null)

file - the file being unpublished (never null)

Returns:

a status of the unpublishing operation outcome (never null)

markAsPublishArea

Status markAsPublishArea(Workspace workspace,
                       String path,
                       String title,
                       String description)

Marks the last folder of the given path as a publish area, by adding the mode:publishArea mixin.

The path is made up of folder segments. If any folder segment does not exist, it will be created. The folder corresponding to the last path segment will become the publish area. If the last folder already is a publish area, the title and/or description will be updated.

Parameters:

workspace - the workspace where the operation will be performed (never null)

path - the unencoded path to the folder which will become the publish area (never null).

title - an optional String representing the title of the area (can be null)

description - an optional String representing the description of the area (can be null)

Returns:

the status of the operation (never null).

unmarkAsPublishArea

Status unmarkAsPublishArea(Workspace workspace,
                         String path)

Unmarks the last folder of the given path as a publish area, by removing the mode:publishArea mixin.

The path is made up of folder segments. If any folder segment does not exist, no changes will be performed If the last folder segment from the path is not a publish area, no changes will be performed.

Parameters:

workspace - the workspace where the operation will be performed (never null)

path - the unencoded path to the folder which will be cleared as a publish area (never null).

Returns:

the status of the operation (never null).

planForQuery

String planForQuery(Workspace workspace,
                  String language,
                  String statement,
                  int offset,
                  int limit,
                  Map<String,String> variables)
                    throws Exception

Compute the plan for the supplied query in the workspace. This method does not return any results.

Parameters:

workspace - the workspace where the resource will be unpublished (never null)

language - the JCR query language to use (never null)

statement - the query itself (never null)

offset - the first row to be returned; if this value is negative, rows are returned starting with the first row

limit - the maximum number of rows to be returned; if this value is negative, all rows are returned

variables - the query variables; may be null

Returns:

the string representation of the query plan

Throws:

Exception - if there is a problem obtaining the workspaces

query

List<QueryRow> query(Workspace workspace,
                   String language,
                   String statement)
                     throws Exception

Executes the given query in the workspace.

Parameters:

workspace - the workspace where the resource will be unpublished (never null)

language - the JCR query language to use (never null)

statement - the query itself (never null)

Returns:

the list of rows returned by the query (never null)

Throws:

Exception - if there is a problem obtaining the workspaces

query

List<QueryRow> query(Workspace workspace,
                   String language,
                   String statement,
                   int offset,
                   int limit)
                     throws Exception

Executes the given query in the workspace.

Parameters:

workspace - the workspace where the resource will be unpublished (never null)

language - the JCR query language to use (never null)

statement - the query itself (never null)

offset - the first row to be returned; if this value is negative, rows are returned starting with the first row

limit - the maximum number of rows to be returned; if this value is negative, all rows are returned

Returns:

the list of rows returned by the query (never null)

Throws:

Exception - if there is a problem obtaining the workspaces

query

List<QueryRow> query(Workspace workspace,
                   String language,
                   String statement,
                   int offset,
                   int limit,
                   Map<String,String> variables)
                     throws Exception

Executes the given query in the workspace.

Parameters:

workspace - the workspace where the resource will be unpublished (never null)

language - the JCR query language to use (never null)

statement - the query itself (never null)

offset - the first row to be returned; if this value is negative, rows are returned starting with the first row

limit - the maximum number of rows to be returned; if this value is negative, all rows are returned

variables - the query variables; may be null

Returns:

the list of rows returned by the query (never null)

Throws:

Exception - if there is a problem obtaining the workspaces