SMILA (incubation) API documentation

org.eclipse.smila.solr.admin
Class SolrAdminAgent

java.lang.Object
  extended by org.eclipse.smila.management.LocatedManagementAgentBase
      extended by org.eclipse.smila.solr.admin.SolrAdminAgent
All Implemented Interfaces:
LocatedManagementAgent, ManagementAgent

public class SolrAdminAgent
extends LocatedManagementAgentBase

The SolrAdminAgent class.

Author:
pwissel

Constructor Summary
SolrAdminAgent(SolrAdmin solrAdmin)
          Constructor.
 
Method Summary
 java.lang.String alias(java.lang.String coreName, java.lang.String aliasName)
          Execute alias action.
 java.lang.String create(java.lang.String srcCore, java.lang.String targetCoreName)
          Execute create action.
 java.lang.String create(java.lang.String coreName, java.lang.String intanceDir, java.lang.String dataDir)
          Execute create action.
protected  java.lang.String getCategory()
          Gets the category.
protected  java.lang.String getName()
          Gets the name.
 java.lang.String merge(java.lang.String targetCoreName, java.lang.String sourceIndexDir1, java.lang.String sourceIndexDir2)
          Execute merge action.
 java.lang.String reload(java.lang.String coreName)
          Execute reload action.
 java.lang.String rename(java.lang.String coreName, java.lang.String newName)
          Execute rename action.
 java.lang.String status(java.lang.String coreName)
          Execute status action.
 java.lang.String unload(java.lang.String coreName)
          Execute unload action.
 
Methods inherited from class org.eclipse.smila.management.LocatedManagementAgentBase
getLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SolrAdminAgent

public SolrAdminAgent(SolrAdmin solrAdmin)
Constructor.

Parameters:
solrAdmin - the SolrAdmin.
Method Detail

getCategory

protected java.lang.String getCategory()
Gets the category.

Specified by:
getCategory in class LocatedManagementAgentBase
Returns:
the category
See Also:
LocatedManagementAgentBase.getCategory()

getName

protected java.lang.String getName()
Gets the name.

Specified by:
getName in class LocatedManagementAgentBase
Returns:
the name
See Also:
LocatedManagementAgentBase.getName()

alias

public java.lang.String alias(java.lang.String coreName,
                              java.lang.String aliasName)
Execute alias action.

Parameters:
coreName - the core name.
aliasName - the alias name.
Returns:
the response message.

create

public java.lang.String create(java.lang.String coreName,
                               java.lang.String intanceDir,
                               java.lang.String dataDir)
Execute create action.

Parameters:
coreName - the core name.
intanceDir - the instance directory.
dataDir - the data directory.
Returns:
the response message.

create

public java.lang.String create(java.lang.String srcCore,
                               java.lang.String targetCoreName)
Execute create action.

Parameters:
coreName - the core name.
Returns:
the response message.

merge

public java.lang.String merge(java.lang.String targetCoreName,
                              java.lang.String sourceIndexDir1,
                              java.lang.String sourceIndexDir2)
Execute merge action.

Parameters:
targetCoreName - the target core name.
sourceIndexDir1 - the first source index directory.
sourceIndexDir2 - the second source index directory.
Returns:
the response message.

reload

public java.lang.String reload(java.lang.String coreName)
Execute reload action.

Parameters:
coreName - the core name.
Returns:
the response message.

rename

public java.lang.String rename(java.lang.String coreName,
                               java.lang.String newName)
Execute rename action.

Parameters:
coreName - the core name.
newName - the new core name.
Returns:
the response message.

status

public java.lang.String status(java.lang.String coreName)
Execute status action.

Parameters:
coreName - the core name or null (for all cores).
Returns:
the response message.

unload

public java.lang.String unload(java.lang.String coreName)
Execute unload action.

Parameters:
coreName - the core name.
Returns:
the response message.

SMILA (incubation) API documentation