mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-31 17:39:05 +00:00
RM-5416 - reverted auto formatting for SearchAPI
This commit is contained in:
@@ -68,26 +68,28 @@ public class SearchAPI extends BaseAPI
|
|||||||
private static final String RM_SEARCH_ENDPOINT = "{0}alfresco/s/slingshot/rmsearch/{1}?{2}";
|
private static final String RM_SEARCH_ENDPOINT = "{0}alfresco/s/slingshot/rmsearch/{1}?{2}";
|
||||||
|
|
||||||
/** RM document search filters */
|
/** RM document search filters */
|
||||||
private static final String RM_DEFAULT_RECORD_FILTERS = "records/true,undeclared/true,vital/false,folders/false,categories/false,frozen/false,cutoff/false";
|
private static final String RM_DEFAULT_RECORD_FILTERS =
|
||||||
|
"records/true,undeclared/true,vital/false,folders/false,categories/false,frozen/false,cutoff/false";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Perform search request on search endpoint as a user.
|
* Perform search request on search endpoint as a user.
|
||||||
* <p>
|
* <p>
|
||||||
* This method is applicable only to endpoints that support HTTP GET requests and return JSON body as response.
|
* This method is applicable only to endpoints that support HTTP GET requests and return JSON body as response.
|
||||||
*
|
|
||||||
* @param searchEndpoint
|
* @param searchEndpoint
|
||||||
* @param searchUser
|
* @param searchUser
|
||||||
* @param searchPassword
|
* @param searchPassword
|
||||||
* @return search results as a {@link JSONObject}, please refer to API documentation for details
|
* @return search results as a {@link JSONObject}, please refer to API documentation for details
|
||||||
*/
|
*/
|
||||||
private JSONObject doSearch(String searchEndpoint, String searchUser, String searchPassword)
|
private JSONObject doSearch(
|
||||||
|
String searchEndpoint,
|
||||||
|
String searchUser,
|
||||||
|
String searchPassword)
|
||||||
{
|
{
|
||||||
return facetedRequest(searchUser, searchPassword, null, searchEndpoint);
|
return facetedRequest(searchUser, searchPassword, null, searchEndpoint);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generic rm search.
|
* Generic rm search.
|
||||||
*
|
|
||||||
* @param username
|
* @param username
|
||||||
* @param password
|
* @param password
|
||||||
* @param site
|
* @param site
|
||||||
@@ -95,36 +97,45 @@ public class SearchAPI extends BaseAPI
|
|||||||
* @param filters
|
* @param filters
|
||||||
* @return search results (see API reference for more details), null for any errors
|
* @return search results (see API reference for more details), null for any errors
|
||||||
*/
|
*/
|
||||||
public JSONObject rmSearch(String username, String password, String site, String query, String filters)
|
public JSONObject rmSearch(
|
||||||
|
String username,
|
||||||
|
String password,
|
||||||
|
String site,
|
||||||
|
String query,
|
||||||
|
String filters)
|
||||||
{
|
{
|
||||||
List<BasicNameValuePair> searchParameters = new ArrayList<BasicNameValuePair>();
|
List<BasicNameValuePair> searchParameters = new ArrayList<BasicNameValuePair>();
|
||||||
searchParameters.add(new BasicNameValuePair("query", query));
|
searchParameters.add(new BasicNameValuePair("query", query));
|
||||||
searchParameters.add(new BasicNameValuePair("filters", filters));
|
searchParameters.add(new BasicNameValuePair("filters", filters));
|
||||||
|
|
||||||
String requestURL = MessageFormat.format(RM_SEARCH_ENDPOINT,
|
String requestURL = MessageFormat.format(
|
||||||
alfrescoHttpClientFactory.getObject().getAlfrescoUrl(), (site != null) ? site : RM_SITE_ID,
|
RM_SEARCH_ENDPOINT,
|
||||||
URLEncodedUtils.format(searchParameters, "UTF-8"));
|
alfrescoHttpClientFactory.getObject().getAlfrescoUrl(),
|
||||||
|
(site != null) ? site : RM_SITE_ID,
|
||||||
|
URLEncodedUtils.format(searchParameters, "UTF-8"));
|
||||||
|
|
||||||
return doSearch(requestURL, username, password);
|
return doSearch(requestURL, username, password);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Search as a user for records on site "rm" matching query, using SearchAPI.RM_DEFAULT_RECORD_FILTERS <br>
|
* Search as a user for records on site "rm" matching query, using SearchAPI.RM_DEFAULT_RECORD_FILTERS
|
||||||
|
* <br>
|
||||||
* If more fine-grained control of search parameters is required, use rmSearch() directly.
|
* If more fine-grained control of search parameters is required, use rmSearch() directly.
|
||||||
*
|
|
||||||
* @param username
|
* @param username
|
||||||
* @param password
|
* @param password
|
||||||
* @param query
|
* @param query
|
||||||
* @return list of record names
|
* @return list of record names
|
||||||
*/
|
*/
|
||||||
public List<String> searchForRecordsAsUser(String username, String password, String query)
|
public List<String> searchForRecordsAsUser(
|
||||||
|
String username,
|
||||||
|
String password,
|
||||||
|
String query)
|
||||||
{
|
{
|
||||||
return getItemNames(rmSearch(username, password, "rm", query, RM_DEFAULT_RECORD_FILTERS));
|
return getItemNames(rmSearch(username, password, "rm", query, RM_DEFAULT_RECORD_FILTERS));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generic faceted search.
|
* Generic faceted search.
|
||||||
*
|
|
||||||
* @param username
|
* @param username
|
||||||
* @param password
|
* @param password
|
||||||
* @param parameters
|
* @param parameters
|
||||||
@@ -137,7 +148,6 @@ public class SearchAPI extends BaseAPI
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute faceted search for term.
|
* Execute faceted search for term.
|
||||||
*
|
|
||||||
* @param searchUser
|
* @param searchUser
|
||||||
* @param searchPassword
|
* @param searchPassword
|
||||||
* @param searchTerm
|
* @param searchTerm
|
||||||
@@ -145,12 +155,14 @@ public class SearchAPI extends BaseAPI
|
|||||||
*/
|
*/
|
||||||
public JSONObject facetedSearchForTerm(String searchUser, String searchPassword, String searchTerm)
|
public JSONObject facetedSearchForTerm(String searchUser, String searchPassword, String searchTerm)
|
||||||
{
|
{
|
||||||
return facetedSearch(searchUser, searchPassword, Arrays.asList(new BasicNameValuePair("term", searchTerm)));
|
return facetedSearch(
|
||||||
|
searchUser,
|
||||||
|
searchPassword,
|
||||||
|
Arrays.asList(new BasicNameValuePair("term", searchTerm)));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Helper method to search for documents as a user using faceted search.
|
* Helper method to search for documents as a user using faceted search.
|
||||||
*
|
|
||||||
* @param username to search as
|
* @param username to search as
|
||||||
* @param password for username
|
* @param password for username
|
||||||
* @param term search term
|
* @param term search term
|
||||||
@@ -158,13 +170,12 @@ public class SearchAPI extends BaseAPI
|
|||||||
*/
|
*/
|
||||||
public List<String> searchForDocumentsAsUser(String username, String password, String term)
|
public List<String> searchForDocumentsAsUser(String username, String password, String term)
|
||||||
{
|
{
|
||||||
|
|
||||||
return getItemNames(facetedSearchForTerm(username, password, term));
|
return getItemNames(facetedSearchForTerm(username, password, term));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Helper method to search for documents or folders as a user using search.
|
* Helper method to search for documents or folders as a user using search.
|
||||||
*
|
*
|
||||||
* @param username to search as
|
* @param username to search as
|
||||||
* @param password for username
|
* @param password for username
|
||||||
* @param term search term
|
* @param term search term
|
||||||
@@ -190,7 +201,6 @@ public class SearchAPI extends BaseAPI
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Helper method to extract list of names from search result.
|
* Helper method to extract list of names from search result.
|
||||||
*
|
|
||||||
* @param searchResult
|
* @param searchResult
|
||||||
* @return list of document or record names in search result
|
* @return list of document or record names in search result
|
||||||
* @throws RuntimeException for malformed search response
|
* @throws RuntimeException for malformed search response
|
||||||
|
Reference in New Issue
Block a user