org.jboss.dna.web.jcr.rest.client.json
Class JsonRestClient

java.lang.Object
  org.jboss.dna.web.jcr.rest.client.json.JsonRestClient

All Implemented Interfaces:

IRestClient

public final class JsonRestClient
extends Object
implements IRestClient

The JsonRestClient class is an implementation of IRestClient that works with the DNA REST server that uses JSON as its interface protocol.

Constructor Summary

JsonRestClient()

Method Summary

Collection<Repository>	getRepositories(Server server) Obtains the DNA repositories defined within the specified server.
URL	getUrl(File file, String path, Workspace workspace)
Collection<Workspace>	getWorkspaces(Repository repository) Obtains the workspaces defined within the specified DNA respository.
boolean	pathExists(Workspace workspace, String path, File file)
Status	publish(Workspace workspace, String path, File file) Publishes, or uploads, a local file to the workspace at the specified path.
Status	unpublish(Workspace workspace, String path, File file) Unpublishes, or deletes, the resource at the specified path in the workspace.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonRestClient

public JsonRestClient()

Method Detail

getRepositories

public Collection<Repository> getRepositories(Server server)
                                       throws Exception

Obtains the DNA repositories defined within the specified server.

Specified by:

getRepositories in interface IRestClient

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

See Also:

IRestClient.getRepositories(org.jboss.dna.web.jcr.rest.client.domain.Server)

getUrl

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

Specified by:

getUrl in interface IRestClient

Parameters:

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

path - the path in the DNA 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

See Also:

IRestClient.getUrl(java.io.File, java.lang.String, org.jboss.dna.web.jcr.rest.client.domain.Workspace)

getWorkspaces

public Collection<Workspace> getWorkspaces(Repository repository)
                                    throws Exception

Obtains the workspaces defined within the specified DNA respository.

Specified by:

getWorkspaces in interface IRestClient

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

See Also:

IRestClient.getWorkspaces(org.jboss.dna.web.jcr.rest.client.domain.Repository)

pathExists

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

Parameters:

workspace - the workspace being checked (never null)

path - the path in workspace (never null)

file - the file being checked (never null)

Returns:

true if the file exists in the workspace at the specified path

Throws:

Exception - if there is a problem checking the existence of the file

publish

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

Publishes, or uploads, a local file to the workspace at the specified path.

Specified by:

publish in interface IRestClient

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)

See Also:

IRestClient.publish(org.jboss.dna.web.jcr.rest.client.domain.Workspace, java.lang.String, java.io.File)

unpublish

public 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.

Specified by:

unpublish in interface IRestClient

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)

See Also:

IRestClient.unpublish(org.jboss.dna.web.jcr.rest.client.domain.Workspace, java.lang.String, java.io.File)