org.sakaiproject.search.tool
Class SearchAdminBeanImpl

java.lang.Object
  extended by org.sakaiproject.search.tool.SearchAdminBeanImpl
All Implemented Interfaces:
SearchAdminBean

public class SearchAdminBeanImpl
extends Object
implements SearchAdminBean

Author:
ieb

Nested Class Summary
 class SearchAdminBeanImpl.AdminOptionImpl
           
 
Constructor Summary
SearchAdminBeanImpl(javax.servlet.http.HttpServletRequest request, SearchService searchService, org.sakaiproject.site.api.SiteService siteService, org.sakaiproject.tool.api.ToolManager toolManager, org.sakaiproject.tool.api.SessionManager sessionManager, org.sakaiproject.authz.api.SecurityService securityService, org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
          Construct a SearchAdminBean, checking permissions first
 
Method Summary
 String getAdminOptions(String adminOptionsFormat)
          Get admin options formatted according to pattern
 String getCommandFeedback()
          get feedback from the command
 String getGlobalMasterDocuments(String rowFormat)
          get a list of Global Master documents
 List<MasterRecord> getGlobalMasterRecords()
          get a list of master objects
 String getIndexDocuments(String rowFormat)
          get a BIG list of all documents in the index
 String getIndexStatus(String statusFormat)
          get an HTML fragment representing the status of the index
 List<AdminOption> getOptons()
          get a list of options for the admin user
 SearchStatus getSearchStatus()
          get the search status
 String getSegmentInfo(String rowFormat)
           
 List<Segment> getSegments()
          get a list of segments
 String getSiteMasterDocuments(String rowFormat)
          get a list of Site Master Documents
 List<MasterRecord> getSiteMasterRecords()
          get a list of site master records
 String getTitle()
          Get the Title of the index
 String getWorkers(String rowFormat)
           
 List<WorkerThread> getWorkerThreads()
          get a list of worker threads
 boolean isRedirectRequired()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchAdminBeanImpl

public SearchAdminBeanImpl(javax.servlet.http.HttpServletRequest request,
                           SearchService searchService,
                           org.sakaiproject.site.api.SiteService siteService,
                           org.sakaiproject.tool.api.ToolManager toolManager,
                           org.sakaiproject.tool.api.SessionManager sessionManager,
                           org.sakaiproject.authz.api.SecurityService securityService,
                           org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
                    throws org.sakaiproject.exception.IdUnusedException,
                           org.sakaiproject.exception.PermissionException
Construct a SearchAdminBean, checking permissions first

Parameters:
request -
searchService -
siteService -
portalService -
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException
Method Detail

getTitle

public String getTitle()
Get the Title of the index

Specified by:
getTitle in interface SearchAdminBean
Returns:

getIndexStatus

public String getIndexStatus(String statusFormat)
                      throws org.sakaiproject.exception.PermissionException
get an HTML fragment representing the status of the index

Specified by:
getIndexStatus in interface SearchAdminBean
Parameters:
statusFormat - {0} is the Last Load time {1} is how long it took to load {2} is the current worker node (none if none) {3} is the Latest time of completion of the worker
Returns:
Throws:
org.sakaiproject.exception.PermissionException

getWorkers

public String getWorkers(String rowFormat)
Specified by:
getWorkers in interface SearchAdminBean
Parameters:
rowFormat - {0} is the worker name {1} is the latest time the node should reaapear, after which time the node will be considered overdue and removed from the list of worker nodes.
Returns:

getIndexDocuments

public String getIndexDocuments(String rowFormat)
Description copied from interface: SearchAdminBean
get a BIG list of all documents in the index

Specified by:
getIndexDocuments in interface SearchAdminBean
Returns:

getGlobalMasterDocuments

public String getGlobalMasterDocuments(String rowFormat)
Description copied from interface: SearchAdminBean
get a list of Global Master documents

Specified by:
getGlobalMasterDocuments in interface SearchAdminBean
Returns:

getSiteMasterDocuments

public String getSiteMasterDocuments(String rowFormat)
Description copied from interface: SearchAdminBean
get a list of Site Master Documents

Specified by:
getSiteMasterDocuments in interface SearchAdminBean
Returns:

getAdminOptions

public String getAdminOptions(String adminOptionsFormat)
Get admin options formatted according to pattern

Specified by:
getAdminOptions in interface SearchAdminBean
Parameters:
adminOptionsFormat - format pattern {0} is the URL, {1} is the text
Returns:

getCommandFeedback

public String getCommandFeedback()
Description copied from interface: SearchAdminBean
get feedback from the command

Specified by:
getCommandFeedback in interface SearchAdminBean
Returns:

getSegmentInfo

public String getSegmentInfo(String rowFormat)
Specified by:
getSegmentInfo in interface SearchAdminBean
Returns:

getGlobalMasterRecords

public List<MasterRecord> getGlobalMasterRecords()
Description copied from interface: SearchAdminBean
get a list of master objects

Specified by:
getGlobalMasterRecords in interface SearchAdminBean
Returns:

getOptons

public List<AdminOption> getOptons()
Description copied from interface: SearchAdminBean
get a list of options for the admin user

Specified by:
getOptons in interface SearchAdminBean
Returns:

getSegments

public List<Segment> getSegments()
Description copied from interface: SearchAdminBean
get a list of segments

Specified by:
getSegments in interface SearchAdminBean
Returns:

getSiteMasterRecords

public List<MasterRecord> getSiteMasterRecords()
Description copied from interface: SearchAdminBean
get a list of site master records

Specified by:
getSiteMasterRecords in interface SearchAdminBean
Returns:

getSearchStatus

public SearchStatus getSearchStatus()
Description copied from interface: SearchAdminBean
get the search status

Specified by:
getSearchStatus in interface SearchAdminBean
Returns:

getWorkerThreads

public List<WorkerThread> getWorkerThreads()
Description copied from interface: SearchAdminBean
get a list of worker threads

Specified by:
getWorkerThreads in interface SearchAdminBean
Returns:

isRedirectRequired

public boolean isRedirectRequired()
Specified by:
isRedirectRequired in interface SearchAdminBean
Returns:
the redirect


Copyright © 2003-2012 Sakai Project. All Rights Reserved.