org.gcube.portlets.admin.forwardindexportlet.gwt.client.interfaces
Interface ManagementService

All Superinterfaces:

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

All Known Implementing Classes:

ManagementServiceImpl

public interface ManagementService
extends com.google.gwt.user.client.rpc.RemoteService

A RemoteService interface for the ManagementService following GWT RPC design

Method Summary

String	createIndex(String indexID, String collectionID, String[] keyNames, String[] indexTypeIDs, String RIEPR) Creates a new Index for a specified collection
void	deleteIndexType(IndexTypeBean idxType) Deletes an indexType from the IS.
Map<String,IndexTypeBean>	getAllIndexTypes() Retrieves all the indexType descriptions from the IS.
List<ForwardIndexTypeBean>	getAvailableIndexTypeIDs() A method to get FullTextIndexTypeBeans for every fulltext index type available in the VO
List<CollectionBean>	getCollections() A method to get all collection beans of collections gathered from DIS (real collections) along with all collection beans of collectionIDs indices are stated to belong to (in their collectionID property) but which do not exist in reality (fake collections)
IndexBean[]	getIndices(String collectionID) A method to get IndexBeans for every Index connected to a specific Collection
MgmtPropertiesBean	getResourceProperties(String indexID) A method used to get information about the ResourceProperties of an Index
List<RunningInstanceBean>	getRunningInstances() A method to get all the available FullTextIndexManagement service running instances
List<String>	query(String queryString, String indexID)
Integer	removeIndex(String indexID) Removes/destroys an Index
String	saveIndexType(IndexTypeBean idxType) Saves an indexType to the IS.
String	updateIndex(String indexID, String rsLocator)

Method Detail

getRunningInstances

List<RunningInstanceBean> getRunningInstances()
                                              throws Exception

A method to get all the available FullTextIndexManagement service running instances

Returns:

the list of running instances

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

getCollections

List<CollectionBean> getCollections()
                                    throws Exception

A method to get all collection beans of collections gathered from DIS (real collections) along with all collection beans of collectionIDs indices are stated to belong to (in their collectionID property) but which do not exist in reality (fake collections)

Returns:

- a List of the requested CollectionsByNameBeans containing the Collection information along with Index information (in the for of IndexBeans) for all indices under each collection.

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

getIndices

IndexBean[] getIndices(String collectionID)
                       throws Exception

A method to get IndexBeans for every Index connected to a specific Collection

Parameters:

indexID - - the ID of the Collection to get the Indices from

Returns:

- an array of IndexBeans for all indices connected to the Collection

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

getAvailableIndexTypeIDs

List<ForwardIndexTypeBean> getAvailableIndexTypeIDs()
                                                    throws Exception

A method to get FullTextIndexTypeBeans for every fulltext index type available in the VO

Returns:

- the list of full text index type IDs

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

getResourceProperties

MgmtPropertiesBean getResourceProperties(String indexID)
                                         throws Exception

A method used to get information about the ResourceProperties of an Index

Parameters:

indexID - - The ID of the Index of which to get the ResourceProperties

Returns:

- The resource properties for the specified Index

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

createIndex

String createIndex(String indexID,
                   String collectionID,
                   String[] keyNames,
                   String[] indexTypeIDs,
                   String RIEPR)
                   throws Exception

Creates a new Index for a specified collection

Parameters:

indexID - - The ID of the Index to be created. Null if an ID should be asigned automatically.

collectionID - - the CollectionID of the Collection the Index should belong to

keyNames - - the names of the keys of the Index to create

indexTypeIDs - - the IndexTypes of the keys of the Index to create

contentType - - the Content Type of the Index to create (usually MetaData or RealData)

RIEPR - - the EPR of the Running Instance to use for the index creation

Returns:

the IndexID of the newly created Index

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

removeIndex

Integer removeIndex(String indexID)
                    throws Exception

Removes/destroys an Index

Parameters:

indexID - - The ID of the Index to destroy

Returns:

The number of Index resources destroy

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

getAllIndexTypes

Map<String,IndexTypeBean> getAllIndexTypes()
                                           throws Exception

Retrieves all the indexType descriptions from the IS.

Returns:

the indexType descriptions

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

saveIndexType

String saveIndexType(IndexTypeBean idxType)
                     throws Exception

Saves an indexType to the IS.

Parameters:

idxType - the indexType description

Returns:

the saved indexType resource ID

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

deleteIndexType

void deleteIndexType(IndexTypeBean idxType)
                     throws Exception

Deletes an indexType from the IS.

Parameters:

idxType - the indexType description

Throws:

Exception - - Server side exception as dictated by GWTs RPC framework

updateIndex

String updateIndex(String indexID,
                   String rsLocator)
                   throws com.google.gwt.user.client.rpc.InvocationException

Throws:

com.google.gwt.user.client.rpc.InvocationException

query

List<String> query(String queryString,
                   String indexID)
                   throws Exception

Throws:

Exception