com.atlassian.confluence.plugins.rest.resources
Class SearchService
java.lang.Object
com.atlassian.confluence.plugins.rest.resources.AbstractResource
com.atlassian.confluence.plugins.rest.resources.SearchService
public class SearchService
- extends AbstractResource
A service providing search results using the Confluence search with various parameters.
Method Summary |
javax.ws.rs.core.Response |
doContentNameSearch(String query,
String type,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
boolean groupResults,
boolean searchParentName,
String preferredSpaceKey,
int startIndex,
Integer pageSize)
Search is performed on the name of content only e.g. |
javax.ws.rs.core.Response |
doSearch(String query,
String type,
String search,
int startIndex,
Integer pageSize,
Integer maxResults,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
boolean groupResults,
boolean searchParentName,
String preferredSpaceKey)
Search Confluence using the given parameters. |
javax.ws.rs.core.Response |
doSiteSearch(String query,
String type,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
int startIndex,
Integer pageSize)
Site wide Confluence search. |
javax.ws.rs.core.Response |
doUserSearch(String query,
int maxResults)
User specific search. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SearchService
public SearchService(UserAccessor userAccessor,
RestSearchService searchService,
SpacePermissionManager spacePermissionManager)
doSearch
public javax.ws.rs.core.Response doSearch(String query,
String type,
String search,
int startIndex,
Integer pageSize,
Integer maxResults,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
boolean groupResults,
boolean searchParentName,
String preferredSpaceKey)
- Search Confluence using the given parameters.
- Parameters:
query
- Query string.type
- Content types to search for. Can be one of: PAGE, COMMENT,
BLOG, ATTACHMENT, PERSONAL_INFORMATION, SPACE_DESCRIPTION,
PERSONAL_SPACE_DESCRIPTION, MAIL or USER_STATUS. You can specify
multiple types by passing a comma separated list like: &type=mail,blogsearch
- The type of search. Can be one of: name, site (case sensitive,
if no match is found site is assumed).startIndex
- Start index for site/ungrouped name searches.pageSize
- Max size of page for site/ungrouped name searches.spaceKey
- Keys of spaces to search in. If not specified, Confluence
searches in all spaces.attachmentType
- Attachment types to search in. If not specified,
Confluence searches all attachments. Can be one or more of: PDF IMAGE,
XML, HTML, TEXT, WORD, EXCEL, POWERPOINT, JAVA_SOURCE, JAVA_ARCHIVE, ZIP.
You can specify multiple types like this: ?attachmentType=image&attachmentType=pdflabel
- Filters the results for content with the specified labels,
if not specified all results are returnedgroupResults
- indicates whether results should be grouped (default is true) for name searchessearchParentName
- indicates whether search should include the parent name (e.g. a page title for an attachment) for name searchespreferredSpaceKey
- the space key that is used to search by
- Returns:
doSiteSearch
public javax.ws.rs.core.Response doSiteSearch(String query,
String type,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
int startIndex,
Integer pageSize)
- Site wide Confluence search.
- Parameters:
query
- query stringtype
- content types to search forspaceKey
- keys of spaces to search in, if not specified it searches in all spacesattachmentType
- attachment types to search in, if not specified it searches all attachmentsstartIndex
- start index of search resultspageSize
- max page size of search resultslabel
- Filters the results for content with the specified labels, if not specified all results are returned
doContentNameSearch
public javax.ws.rs.core.Response doContentNameSearch(String query,
String type,
String spaceKey,
Set<String> attachmentType,
Set<String> label,
boolean groupResults,
boolean searchParentName,
String preferredSpaceKey,
int startIndex,
Integer pageSize)
- Search is performed on the name of content only e.g. title of page, name of attachment
- Parameters:
query
- query stringtype
- content types to search forspaceKey
- keys of spaces to search in, if not specified it searches in all spacesattachmentType
- attachment types to search in, if not specified it searches all attachmentslabel
- Filters the results for content with the specified labels, if not specified all results are returnedgroupResults
- indicates whether results should be grouped (default is true)searchParentName
- indicates whether search should include the parent name (e.g. a page title for an attachment)startIndex
- start index of search results (ignored when groupResults is true)pageSize
- max page size of search results (ignored when groupResults is true)
doUserSearch
public javax.ws.rs.core.Response doUserSearch(String query,
int maxResults)
- User specific search. Searches on username and full name.
- Parameters:
query
- query stringmaxResults
- maximum number of search results
Copyright © 2003-2011 Atlassian. All Rights Reserved.