org.apache.xindice.server.rpc.messages
Class GetCollectionMeta

java.lang.Object
  |
  +--org.apache.xindice.server.rpc.RPCDefaultMessage
        |
        +--org.apache.xindice.server.rpc.messages.GetCollectionMeta

All Implemented Interfaces:

RPCMessage

public class GetCollectionMeta

extends RPCDefaultMessage

XML-RPC message to fetch the meta data associated with a document

Version:

$Revision: 511426 $, $Date: 2007-02-24 22:25:02 -0500 (Sat, 24 Feb 2007) $

Author:

Dave Viner

Fields inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage

API_NAME, API_VERSION, COLLECTION, COMPRESSED, CONFIGURATION, DOCUMENT, MAXKEYSIZE, META, MISSING_COLLECTION_PARAM, MISSING_CONFIGURATION_PARAM, MISSING_DOCUMENT_PARAM, MISSING_META_CONFIGURATION, MISSING_META_PARAM, MISSING_NAME_PARAM, MISSING_PATTERN_PARAM, MISSING_QUERY_PARAM, MISSING_TIMESTAMP_PARAM, MISSING_TYPE_PARAM, NAME, NAMESPACES, PAGESIZE, PATTERN, QUERY, RESULT, TIMESTAMP, TYPE

Constructor Summary

GetCollectionMeta()

Method Summary

Hashtable

execute(Hashtable message) Return the MetaData object for the requested collection.

Methods inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage

getCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCollectionMeta

public GetCollectionMeta()

Method Detail

execute

public Hashtable execute(Hashtable message)
                  throws Exception

Return the MetaData object for the requested collection. This method expects the Hashtable to contain the name of the collection in the RPCDefaultMessage.COLLECTION key. It will return an XML representation of the MetaData object associated with this collection. The XML will be stored in the RPCDefaultMessage.RESULT key.

Parameters:

message - the parameters passed to the xmlrpc method.

Returns:

Hashtable containing the XML for the requested MetaData object.