org.exist.xmldb
Class RemoteCollectionManagementService

java.lang.Object
  org.exist.xmldb.RemoteCollectionManagementService

All Implemented Interfaces:

CollectionManagementServiceImpl, Configurable, Service, CollectionManagementService

public class RemoteCollectionManagementService
extends Object
implements CollectionManagementServiceImpl

Field Summary

Fields inherited from interface org.xmldb.api.modules.CollectionManagementService

SERVICE_NAME

Constructor Summary

RemoteCollectionManagementService(RemoteCollection parent, org.apache.xmlrpc.XmlRpcClient client)

Method Summary

void	copy(String collectionPath, String destinationPath, String newName)
void	copy(XmldbURI collectionPath, XmldbURI destinationPath, XmldbURI newName)
void	copyResource(String resourcePath, String destinationPath, String newName)
void	copyResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName)
Collection	createCollection(String collName) Creates a new Collection in the database.
Collection	createCollection(String collName, Date created)
Collection	createCollection(String path, Document configuration) Implements createCollection from interface CollectionManager.
Collection	createCollection(XmldbURI collName)
Collection	createCollection(XmldbURI collName, Date created)
String	getName() Returns the name associated with the Service instance.
String	getProperty(String property) Returns the value of the property identified by name.
String	getVersion() Gets the Version attribute of the Service object
void	move(String collectionPath, String destinationPath, String newName)
void	move(XmldbURI collectionPath, XmldbURI destinationPath, XmldbURI newName)
void	moveResource(String resourcePath, String destinationPath, String newName)
void	moveResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName)
void	removeCollection(String collName) Removes a named Collection from the system.
void	removeCollection(XmldbURI collName)
void	setCollection(Collection parent) Sets the Collection attribute of the Service object
void	setProperty(String property, String value) Sets the property name to have the value provided in value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCollectionManagementService

public RemoteCollectionManagementService(RemoteCollection parent,
                                         org.apache.xmlrpc.XmlRpcClient client)

Method Detail

createCollection

public Collection createCollection(String collName)
                            throws XMLDBException

Description copied from interface: CollectionManagementService

Creates a new Collection in the database. The default configuration of the database is determined by the implementer. The new Collection will be created relative to the Collection from which the CollectionManagementService was retrieved.

Specified by:

createCollection in interface CollectionManagementServiceImpl

Specified by:

createCollection in interface CollectionManagementService

Parameters:

collName - The name of the collection to create.

Returns:

The created Collection instance.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

createCollection

public Collection createCollection(XmldbURI collName)
                            throws XMLDBException

Specified by:

createCollection in interface CollectionManagementServiceImpl

Throws:

XMLDBException

createCollection

public Collection createCollection(String collName,
                                   Date created)
                            throws XMLDBException

Specified by:

createCollection in interface CollectionManagementServiceImpl

Throws:

XMLDBException

createCollection

public Collection createCollection(XmldbURI collName,
                                   Date created)
                            throws XMLDBException

Specified by:

createCollection in interface CollectionManagementServiceImpl

Throws:

XMLDBException

createCollection

public Collection createCollection(String path,
                                   Document configuration)
                            throws XMLDBException

Implements createCollection from interface CollectionManager. Gets called by some applications based on Xindice.

Parameters:

path - Description of the Parameter

configuration - Description of the Parameter

Returns:

Description of the Return Value

Throws:

XMLDBException - Description of the Exception

getName

public String getName()
               throws XMLDBException

Description copied from interface: Service

Returns the name associated with the Service instance.

Specified by:

getName in interface Service

Returns:

the name of the object.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getProperty

public String getProperty(String property)

Description copied from interface: Configurable

Returns the value of the property identified by name.

Specified by:

getProperty in interface Configurable

Parameters:

property - the name of the property to retrieve.

Returns:

the property value or null if no property exists.

getVersion

public String getVersion()
                  throws XMLDBException

Description copied from interface: Service

Gets the Version attribute of the Service object

Specified by:

getVersion in interface Service

Returns:

The Version value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

removeCollection

public void removeCollection(String collName)
                      throws XMLDBException

Description copied from interface: CollectionManagementService

Removes a named Collection from the system. The name for the Collection to remove is relative to the Collection from which the CollectionManagementService was retrieved.

Specified by:

removeCollection in interface CollectionManagementServiceImpl

Specified by:

removeCollection in interface CollectionManagementService

Parameters:

collName - The name of the collection to remove.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

removeCollection

public void removeCollection(XmldbURI collName)
                      throws XMLDBException

Specified by:

removeCollection in interface CollectionManagementServiceImpl

Throws:

XMLDBException

setCollection

public void setCollection(Collection parent)
                   throws XMLDBException

Description copied from interface: Service

Sets the Collection attribute of the Service object

Specified by:

setCollection in interface Service

Parameters:

parent - The new Collection value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setProperty

public void setProperty(String property,
                        String value)

Description copied from interface: Configurable

Sets the property name to have the value provided in value.

Specified by:

setProperty in interface Configurable

Parameters:

property - the name of the property to set.

value - the value to set for the property.

move

public void move(String collectionPath,
                 String destinationPath,
                 String newName)
          throws XMLDBException

Specified by:

move in interface CollectionManagementServiceImpl

Throws:

XMLDBException

move

public void move(XmldbURI collectionPath,
                 XmldbURI destinationPath,
                 XmldbURI newName)
          throws XMLDBException

Specified by:

move in interface CollectionManagementServiceImpl

Throws:

XMLDBException

moveResource

public void moveResource(String resourcePath,
                         String destinationPath,
                         String newName)
                  throws XMLDBException

Specified by:

moveResource in interface CollectionManagementServiceImpl

Throws:

XMLDBException

moveResource

public void moveResource(XmldbURI resourcePath,
                         XmldbURI destinationPath,
                         XmldbURI newName)
                  throws XMLDBException

Specified by:

moveResource in interface CollectionManagementServiceImpl

Throws:

XMLDBException

copy

public void copy(String collectionPath,
                 String destinationPath,
                 String newName)
          throws XMLDBException

Specified by:

copy in interface CollectionManagementServiceImpl

Throws:

XMLDBException

copy

public void copy(XmldbURI collectionPath,
                 XmldbURI destinationPath,
                 XmldbURI newName)
          throws XMLDBException

Specified by:

copy in interface CollectionManagementServiceImpl

Throws:

XMLDBException

copyResource

public void copyResource(String resourcePath,
                         String destinationPath,
                         String newName)
                  throws XMLDBException

Specified by:

copyResource in interface CollectionManagementServiceImpl

Throws:

XMLDBException

copyResource

public void copyResource(XmldbURI resourcePath,
                         XmldbURI destinationPath,
                         XmldbURI newName)
                  throws XMLDBException

Specified by:

copyResource in interface CollectionManagementServiceImpl

Throws:

XMLDBException