org.modeshape.web.client

Interface JcrService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

JcrServiceImpl

@RemoteServiceRelativePath(value="jcr")
public interface JcrService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the RPC service.

Method Summary

Modifier and Type	Method and Description
void	addAccessList(String repository, String workspace, String path, String principal) Creates empty access list for given principal.
void	addMixin(String repository, String workspace, String path, String mixin) Adds mixin to the node.
JcrNode	addNode(String repository, String workspace, String path, String name, String primaryType) Adds new node.
void	backup(String repository, String name, BackupParams params)
Collection<JcrNode>	childNodes(String repository, String workspace, String path, int index, int count) Gets set of child nodes for the node at the given path.
void	export(String repository, String workspace, String path, String location, boolean skipBinary, boolean noRecurse)
Collection<RepositoryName>	findRepositories(String criteria) Searches repositories with given criteria
String[]	getDurationMetrics() Gets names of available duration metrics.
Collection<Stats>	getDurationStats(String repository, String param, String tu) Obtains repository metrics.
String[]	getMixinTypes(String repository, String workspace, boolean allowAbstract) Reads list of mixin types.
String[]	getPrimaryTypes(String repository, String workspace, String superType, boolean allowAbstract) Reads list of primary types.
Collection<RepositoryName>	getRepositories() Lists all available repositories.
String	getRequestedURI() Initial URI requested by user.
String[]	getTimeUnits() Gets possible time frames.
String	getUserName() Currently logged in user.
String[]	getValueMetrics() Gets names of available value metrics.
Collection<Stats>	getValueStats(String repository, String param, String tu) Obtains repository metrics.
String[]	getWorkspaces(String repositoryName) Enlists workspaces available for the given repository and user previously logged in.
void	importXML(String repository, String workspace, String path, String location, int option)
void	login(String userName, String password) Provides access for the given user to the given repository.
String	logout() Logs out from all repositories.
JcrNode	node(String repository, String workspace, String path) Gets node at the given path.
Collection<JcrNodeType>	nodeTypes(String repository, String workspace) Gets all registered node types.
ResultSet	query(String repository, String workspace, String text, String lang) Executes query.
void	refreshSession(String repository, String workspace, boolean keepChanges) Reload session to the given workspace and repository.
void	removeAccessList(String repository, String workspace, String path, String principal) Deletes access list.
void	removeMixin(String repository, String workspace, String path, String mixin) Removes mixin from the given node.
void	removeNode(String repository, String workspace, String path) Deletes node.
void	renameNode(String repository, String workspace, String path, String name)
JcrRepositoryDescriptor	repositoryInfo(String repository) Gets repository capabilities.
void	restore(String repository, String name, RestoreParams params)
void	save(String repository, String workspace) Saves changes in the current session.
void	setProperty(JcrNode node, String name, Boolean value)
void	setProperty(JcrNode node, String name, Date value)
void	setProperty(JcrNode node, String name, String value)
String[]	supportedQueryLanguages(String repository, String workspace) Gets supported query languages.
void	updateAccessList(String repository, String workspace, String path, String principal, JcrPermission permission, boolean enabled)

Method Detail

getRequestedURI

String getRequestedURI()

Initial URI requested by user.

Returns:

URI as text.

getUserName

String getUserName()
            throws RemoteException

Currently logged in user.

Returns:

user's name of null if not logged in.

Throws:

RemoteException

getRepositories

Collection<RepositoryName> getRepositories()
                                    throws RemoteException

Lists all available repositories.

Returns:

collection of object representing repository.

Throws:

RemoteException - if there is a problem communicating with a remote service

findRepositories

Collection<RepositoryName> findRepositories(String criteria)
                                     throws RemoteException

Searches repositories with given criteria

Parameters:

criteria - the parameter for searching repository

Returns:

collection of object representing repository.

Throws:

RemoteException - if there is a problem communicating with a remote service

getWorkspaces

String[] getWorkspaces(String repositoryName)
                throws RemoteException

Enlists workspaces available for the given repository and user previously logged in.

Parameters:

repositoryName - the name of the repository.

Returns:

names of the available workspaces or empty array.

Throws:

RemoteException

login

void login(String userName,
           String password)
    throws RemoteException

Provides access for the given user to the given repository.

Parameters:

userName - the name of the user

password - the user's password

Throws:

RemoteException - if there is a problem using the repository

logout

String logout()

Logs out from all repositories.

node

JcrNode node(String repository,
             String workspace,
             String path)
      throws RemoteException

Gets node at the given path.

Parameters:

repository -

workspace -

path -

Returns:

Throws:

RemoteException

childNodes

Collection<JcrNode> childNodes(String repository,
                               String workspace,
                               String path,
                               int index,
                               int count)
                        throws RemoteException

Gets set of child nodes for the node at the given path.

Parameters:

repository -

workspace -

path -

index -

count -

Returns:

Throws:

RemoteException

repositoryInfo

JcrRepositoryDescriptor repositoryInfo(String repository)
                                throws RemoteException

Gets repository capabilities.

Parameters:

repository - the repository

Returns:

description of the repository capabilities.

Throws:

RemoteException

nodeTypes

Collection<JcrNodeType> nodeTypes(String repository,
                                  String workspace)
                           throws RemoteException

Gets all registered node types.

Parameters:

repository -

workspace -

Returns:

the node types

Throws:

RemoteException - if there is a problem using the repository

supportedQueryLanguages

String[] supportedQueryLanguages(String repository,
                                 String workspace)
                          throws RemoteException

Gets supported query languages.

Parameters:

repository -

workspace -

Returns:

language names

Throws:

RemoteException - if there is a problem using the repository

query

ResultSet query(String repository,
                String workspace,
                String text,
                String lang)
         throws RemoteException

Executes query.

Parameters:

repository -

workspace -

text - the query text.

lang - query language name

Returns:

Query result

Throws:

RemoteException - if there is a problem using the repository

addNode

JcrNode addNode(String repository,
                String workspace,
                String path,
                String name,
                String primaryType)
         throws RemoteException

Adds new node.

Parameters:

repository -

workspace -

path - the path to the parent node

name - the name of node to add

primaryType - the primary type of the node to add.

Returns:

the node

Throws:

RemoteException - if there is a problem using the repository

renameNode

void renameNode(String repository,
                String workspace,
                String path,
                String name)
         throws RemoteException

Parameters:

repository -

workspace -

path -

name -

Throws:

RemoteException

removeNode

void removeNode(String repository,
                String workspace,
                String path)
         throws RemoteException

Deletes node.

Parameters:

repository -

workspace -

path - the pass to the node to be deleted.

Throws:

RemoteException - if there is a problem using the repository

addMixin

void addMixin(String repository,
              String workspace,
              String path,
              String mixin)
       throws RemoteException

Adds mixin to the node.

Parameters:

repository -

workspace -

path - the path to the node

mixin - mixin to add

Throws:

RemoteException - Any exception on the server side

removeMixin

void removeMixin(String repository,
                 String workspace,
                 String path,
                 String mixin)
          throws RemoteException

Removes mixin from the given node.

Parameters:

repository -

workspace -

path - the path to the node

mixin - mixin to remove

Throws:

RemoteException - any server side exception.

setProperty

void setProperty(JcrNode node,
                 String name,
                 String value)
          throws RemoteException

Throws:

RemoteException

setProperty

void setProperty(JcrNode node,
                 String name,
                 Boolean value)
          throws RemoteException

Throws:

RemoteException

setProperty

void setProperty(JcrNode node,
                 String name,
                 Date value)
          throws RemoteException

Throws:

RemoteException

addAccessList

void addAccessList(String repository,
                   String workspace,
                   String path,
                   String principal)
            throws RemoteException

Creates empty access list for given principal.

Parameters:

repository -

workspace -

path - the path to the node.

principal - the principal name

Throws:

RemoteException

removeAccessList

void removeAccessList(String repository,
                      String workspace,
                      String path,
                      String principal)
               throws RemoteException

Deletes access list.

Parameters:

repository -

workspace -

path -

principal -

Throws:

RemoteException

updateAccessList

void updateAccessList(String repository,
                      String workspace,
                      String path,
                      String principal,
                      JcrPermission permission,
                      boolean enabled)
               throws RemoteException

Throws:

RemoteException

getPrimaryTypes

String[] getPrimaryTypes(String repository,
                         String workspace,
                         String superType,
                         boolean allowAbstract)
                  throws RemoteException

Reads list of primary types.

Parameters:

repository -

workspace -

superType -

allowAbstract - true if allow to load abstract node types.

Returns:

list of type names.

Throws:

RemoteException

getMixinTypes

String[] getMixinTypes(String repository,
                       String workspace,
                       boolean allowAbstract)
                throws RemoteException

Reads list of mixin types.

Parameters:

repository -

workspace -

allowAbstract - true if allow to load abstract node types.

Returns:

list of type names.

Throws:

RemoteException

save

void save(String repository,
          String workspace)
   throws RemoteException

Saves changes in the current session.

Parameters:

repository -

workspace -

Throws:

RemoteException - if there is a problem using the repository

backup

void backup(String repository,
            String name,
            BackupParams params)
     throws RemoteException

Throws:

RemoteException

restore

void restore(String repository,
             String name,
             RestoreParams params)
      throws RemoteException

Throws:

RemoteException

export

void export(String repository,
            String workspace,
            String path,
            String location,
            boolean skipBinary,
            boolean noRecurse)
     throws RemoteException

Throws:

RemoteException

importXML

void importXML(String repository,
               String workspace,
               String path,
               String location,
               int option)
        throws RemoteException

Throws:

RemoteException

refreshSession

void refreshSession(String repository,
                    String workspace,
                    boolean keepChanges)
             throws RemoteException

Reload session to the given workspace and repository.

Parameters:

repository - the repository name

workspace - the workspace name

keepChanges - true if session should keep modification and false otherwise

Throws:

RemoteException

getValueStats

Collection<Stats> getValueStats(String repository,
                                String param,
                                String tu)
                         throws RemoteException

Obtains repository metrics.

Parameters:

repository -

param - value metric name

tu - time window name

Returns:

Throws:

RemoteException

getDurationStats

Collection<Stats> getDurationStats(String repository,
                                   String param,
                                   String tu)
                            throws RemoteException

Obtains repository metrics.

Parameters:

repository -

param - duration metric name

tu - time window name

Returns:

Throws:

RemoteException

getValueMetrics

String[] getValueMetrics()
                  throws RemoteException

Gets names of available value metrics.

Returns:

Throws:

RemoteException

getDurationMetrics

String[] getDurationMetrics()
                     throws RemoteException

Gets names of available duration metrics.

Returns:

Throws:

RemoteException

getTimeUnits

String[] getTimeUnits()
               throws RemoteException

Gets possible time frames.

Returns:

Throws:

RemoteException