org.modeshape.jdbc.rest

Class ModeShapeRestClient

java.lang.Object

org.modeshape.jdbc.rest.ModeShapeRestClient

public final class ModeShapeRestClient
extends Object

A simple java client which communicates via a JSONRestClient to an existing ModeShape REST service and unmarshals the JSON objects into a custom POJO model.

Author:

Horia Chiorean (hchiorea@redhat.com)

Constructor Summary

Constructors

Constructor and Description
ModeShapeRestClient(String repoUrl, String username, String password) Creates a new REST client instance which will always use the given URL as the server connection

Method Summary

Modifier and Type	Method and Description
NodeTypes	getNodeTypes() Returns all the node types that are available in the repository from repoUrl
Repositories	getRepositories() Returns a list with all the available repositories.
Repositories.Repository	getRepository(String name) Returns a repository which has the given name or null.
Workspaces	getWorkspaces(String repositoryName) Returns all the workspaces for the named repository.
QueryResult	query(String query, String queryLanguage) Runs a query in the specified language against the repository from repoUrl.
String	queryPlan(String query, String queryLanguage) Returns a string representation of a query plan in a given language.
String	serverUrl() Returns the URL this client uses to connect to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModeShapeRestClient

public ModeShapeRestClient(String repoUrl,
                           String username,
                           String password)

Creates a new REST client instance which will always use the given URL as the server connection

Parameters:

repoUrl - a String representing a connection to a ModeShape REST service in the format: [protocol]://[host]:[port]/[context]/[repository]/[workspace]. May not be null

username - a String representing the name of the user to use when authenticating with the above server. May be null, in which case no authentication will be performed.

password - a String the password of the above user, if used. May be null

Method Detail

serverUrl

public String serverUrl()

Returns the URL this client uses to connect to the server.

Returns:

a String, never null

getRepositories

public Repositories getRepositories()

Returns a list with all the available repositories.

Returns:

a Repositories instance, never null

getRepository

public Repositories.Repository getRepository(String name)

Returns a repository which has the given name or null.

Parameters:

name - the name of a repository; may not be null

Returns:

a Repositories.Repository instace or null

getWorkspaces

public Workspaces getWorkspaces(String repositoryName)

Returns all the workspaces for the named repository.

Parameters:

repositoryName - a String the name of a repository; may not be null

Returns:

a Workspaces instance; never null

getNodeTypes

public NodeTypes getNodeTypes()

Returns all the node types that are available in the repository from repoUrl

Returns:

a NodeTypes instance; never null

query

public QueryResult query(String query,
                         String queryLanguage)

Runs a query in the specified language against the repository from repoUrl.

Parameters:

query - a String, never null

queryLanguage - the language of the query, never null

Returns:

a QueryResult instance, never null

See Also:

Query

queryPlan

public String queryPlan(String query,
                        String queryLanguage)

Returns a string representation of a query plan in a given language.

Parameters:

query - a String, never null

queryLanguage - the language of the query, never null

Returns:

a String description of the plan, never null