org.apache.camel.component.box.api.BoxSearchManager Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.component.box.api;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import com.box.sdk.BoxAPIConnection;
import com.box.sdk.BoxAPIException;
import com.box.sdk.BoxItem;
import com.box.sdk.BoxSearch;
import com.box.sdk.BoxSearchParameters;
import com.box.sdk.PartialCollection;
import org.apache.camel.RuntimeCamelException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static org.apache.camel.component.box.api.BoxHelper.buildBoxApiErrorMessage;
/**
* Provides operations to manage Box searches.
*/
public class BoxSearchManager {
private static final Logger LOG = LoggerFactory.getLogger(BoxSearchManager.class);
//200 is maximal value used for search (see javadoc for BoxSearch.searchRange)
private static final int SEARCH_MAX_LIMIT = 200;
/**
* Box connection to authenticated user account.
*/
private BoxAPIConnection boxConnection;
/**
* Create search manager to manage the searches of Box connection's authenticated user.
*
* @param boxConnection - Box connection to authenticated user account.
*/
public BoxSearchManager(BoxAPIConnection boxConnection) {
this.boxConnection = boxConnection;
}
/**
* Search folder and all descendant folders using the given query.
*
* @param folderId - the id of folder searched.
* @param query - the search query.
*
* @return A collection of matching items.
*/
public Collection searchFolder(String folderId, String query) {
try {
LOG.debug("Searching folder(id={}) with query={}", folderId, query);
BoxHelper.notNull(folderId, BoxHelper.FOLDER_ID);
BoxHelper.notNull(query, BoxHelper.QUERY);
// New box API for search requires offset and limit as parameters.
// To preserve api from previous functionality fro previous version, we will execute more searches if needed and merge results
BoxSearchParameters bsp = new BoxSearchParameters();
bsp.setAncestorFolderIds(Collections.singletonList(folderId));
bsp.setQuery(query);
LinkedList result = new LinkedList<>();
BoxSearch bs = new BoxSearch(boxConnection);
PartialCollection partialResult;
int offset = 0;
do {
partialResult = bs.searchRange(offset, SEARCH_MAX_LIMIT, bsp);
offset += partialResult.size();
partialResult.stream().map(i -> (BoxItem) i.getResource()).forEachOrdered(result::add);
} while (partialResult.size() == partialResult.limit());
return result;
} catch (BoxAPIException e) {
throw new RuntimeCamelException(
buildBoxApiErrorMessage(e), e);
}
}
}