Skip to content

Commit

Permalink
cleanup from merge
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Gross cogross committed Jun 10, 2024
1 parent 988977c commit 361b1ef
Show file tree
Hide file tree
Showing 36 changed files with 133 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ enum State {
*
* Deprecated in 2.2.3, use {@link #getClient(String, Collection, String, Priority, Map)}
*
* @param userDN
* the user's DN
* @param proxyServers
* thecollectiuon of proxy servers
* @param priority
* the connection's Priority
* @param trackingMap
Expand All @@ -50,6 +54,10 @@ enum State {
/**
* Gets a connection from the named pool with the assigned priority
*
* @param userDN
* the user's DN
* @param proxyServers
* collection of proxy servers
* @param poolName
* the name of the pool to retrieve the connection from
* @param priority
Expand All @@ -75,6 +83,8 @@ AccumuloClient getClient(String userDN, Collection<String> proxyServers, String

/**
* Return a report of the current connection factory usage
*
* @return the report
*/
String report();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ public void close() {
* the connection's Priority
* @return accumulo connection
* @throws Exception
* when error encountered getting client
*/
@Override
public AccumuloClient getClient(final String userDN, final Collection<String> proxyServers, Priority priority, Map<String,String> trackingMap)
Expand All @@ -196,6 +197,7 @@ public AccumuloClient getClient(final String userDN, final Collection<String> pr
* the tracking map
* @return Accumulo connection
* @throws Exception
* when error encountered getting client
*/
@Override
public AccumuloClient getClient(final String userDN, final Collection<String> proxyServers, final String cpn, final Priority priority,
Expand Down Expand Up @@ -236,6 +238,7 @@ public AccumuloClient getClient(final String userDN, final Collection<String> pr
* @param client
* The connection to return
* @throws Exception
* when error encountered getting client
*/
@Override
public void returnClient(AccumuloClient client) throws Exception {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package datawave.core.mapreduce.bulkresults.map;

import static org.jgroups.util.Util.assertNotNull;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.StringReader;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,8 @@ public AccumuloConnectionFactory.Priority getPriority() {
* operation
* @param userAuths
* set of user auths
* @param userDetails
* proxied user details
* @return Event
* @throws Exception
* if there are issues
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ public void reloadMutableFieldCache() {

/**
* List the mutable fields in the cache
*
* @return list of mutable fields
*/
public String listMutableFields() {
return cache.toString();
Expand All @@ -100,6 +102,7 @@ public String listMutableFields() {
* Check to see if field for specified datatype is mutable
*
* @param datatype
* the data type
* @param field
* name of field
* @return true if field is mutable for the given datatype
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ public void setSecurityMarkingExemptFields(List<String> securityMarkingExemptFie
/**
* Handle to query service in case the modification service needs to run queries.
*
* @param userDetails
* proxied user details
* @return ModificationQueryService
*/
public ModificationQueryService getQueryService(ProxiedUserDetails userDetails) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public interface CheckpointableQueryLogic {
* handling a previously returned checkpoint.
*
* @param checkpoint
* the checkpoint
* @return The updated checkpoint
*/
QueryCheckpoint updateCheckpoint(QueryCheckpoint checkpoint);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ default void preInitialize(Query settings, Set<Authorizations> userAuthorization
* Set a client configuration for scanner hints and consistency.
*
* @param config
* the client configuration
*/
void setClientConfig(AccumuloClientConfiguration config);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,7 @@ public SelectorExtractor getSelectorExtractor() {
* Setting the current user is called after the logic is created. Pass this on to the children.
*
* @param user
* the proxied user
*/
@Override
public void setCurrentUser(ProxiedUserDetails user) {
Expand All @@ -711,6 +712,7 @@ public void setCurrentUser(ProxiedUserDetails user) {
* /** Setting the server user is called after the logic is created. Pass this on to the children.
*
* @param user
* the proxied user
*/
@Override
public void setServerUser(ProxiedUserDetails user) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ public interface RemoteQueryService {
* @param callerObject
* the caller
* @return the generic response
* @throws QueryException
* on error when creating query
*/
GenericResponse<String> createQuery(String queryLogicName, Map<String,List<String>> queryParameters, ProxiedUserDetails callerObject) throws QueryException;

Expand All @@ -36,6 +38,8 @@ public interface RemoteQueryService {
* @param callerObject
* the caller
* @return the base query response
* @throws QueryException
* on error with query
*/
BaseQueryResponse next(String id, ProxiedUserDetails callerObject) throws QueryException;

Expand All @@ -47,6 +51,8 @@ public interface RemoteQueryService {
* @param callerObject
* the caller
* @return the void response
* @throws QueryException
* on error closing query
*/
VoidResponse close(String id, ProxiedUserDetails callerObject) throws QueryException;

Expand All @@ -60,6 +66,8 @@ public interface RemoteQueryService {
* @param callerObject
* the caller
* @return the generic response
* @throws QueryException
* on error planning query
*/
GenericResponse<String> planQuery(String queryLogicName, Map<String,List<String>> queryParameters, ProxiedUserDetails callerObject) throws QueryException;

Expand All @@ -71,6 +79,8 @@ public interface RemoteQueryService {
* @param callerObject
* the caller
* @return a generic response
* @throws QueryException
* on error planning query
*/
GenericResponse<String> planQuery(String id, ProxiedUserDetails callerObject) throws QueryException;

Expand Down
6 changes: 0 additions & 6 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,6 @@
<version>2.28.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.28.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.picketbox</groupId>
<artifactId>picketbox</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ public AgeOffFileGenerator(AgeOffFileConfiguration configuration) {
/**
* Writes the file to the writer.
*
* @param writer
* the writer
*
* @throws IOException
* i/o exception with writer
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* Creats a transformable node from an AgeOffRuleLoader.RuleConfig
*/
public class RuleConfigDocument extends DocumentImpl {
private static final long serialVersionUID = 0l;
private static final String FILTER_CLASS_ELEMENT_NAME = "filterClass";
private static final String MATCH_PATTERN_ELEMENT_NAME = "matchPattern";
private static final String TTL_ELEMENT_NAME = "ttl";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ public class EdgeModelFields implements Serializable {
/** A mapping of field names to field keys */
private Map<String,FieldKey> reverseMap = new HashMap<>();

private static final long serialVersionUID = 0l;

public static String EQUALS = "==";
public static String EQUALS_REGEX = "=~";
public static String NOT_EQUALS = "!=";
Expand Down Expand Up @@ -146,6 +148,11 @@ public enum FieldKey {

/**
* Returns the FieldKey associated with the actual (ie, configured) edge field name, ie, reverse lookup...
*
* @param internalFieldName
* the internal field name
*
* @return the FieldKey parsed from the internalFieldName provided
*/
public FieldKey parse(String internalFieldName) {
FieldKey key = reverseMap.get(internalFieldName);
Expand Down Expand Up @@ -239,7 +246,7 @@ public String getBadActivityDateFieldName() {
/**
* Returns the subset of all edge-related field names which are common to all application tiers.
*
* @return
* @return the collection of base field names
*/
public Collection<String> getBaseFieldNames() {
return Collections.unmodifiableCollection(baseFieldMap.values());
Expand All @@ -249,7 +256,7 @@ public Collection<String> getBaseFieldNames() {
* Returns the field names associated with key manipulation and processing, a superset of the fields given by the {@link EdgeModelFields#getBaseFieldNames}
* method
*
* @return
* @return the collection of key processing field names
*/
public Collection<String> getKeyProcessingFieldNames() {
HashSet<String> fields = new HashSet<>();
Expand All @@ -262,7 +269,7 @@ public Collection<String> getKeyProcessingFieldNames() {
* Returns the field names associated with query result transformation, a superset of the fields given by the {@link EdgeModelFields#getBaseFieldNames}
* method
*
* @return
* @return collection of transform field names
*/
public Collection<String> getTransformFieldNames() {
HashSet<String> fields = new HashSet<>();
Expand All @@ -274,7 +281,7 @@ public Collection<String> getTransformFieldNames() {
/**
* Returns the mapped fields associated with edge key manipulation and processing, where the keys are represented as FieldKey.name()
*
* @return
* @return key processing field map
*/
public Map<String,String> getKeyProcessingFieldMap() {
HashMap<String,String> all = new HashMap<>();
Expand All @@ -286,7 +293,7 @@ public Map<String,String> getKeyProcessingFieldMap() {
/**
* Returns the mapping for fields associated with query result transformation, where the keys are represented as FieldKey.name()
*
* @return
* @return the transform field map
*/
public Map<String,String> getTransformFieldMap() {
HashMap<String,String> all = new HashMap<>();
Expand All @@ -298,7 +305,7 @@ public Map<String,String> getTransformFieldMap() {
/**
* Returns all mapped field names, where the keys are represented as FieldKey.name()
*
* @return
* @return all the mapped field names
*/
public Map<String,String> getAllFieldsMap() {
HashMap<String,String> all = new HashMap<>();
Expand All @@ -312,7 +319,8 @@ public Map<String,String> getAllFieldsMap() {
* Returns the field name mapped to the specified FieldKey
*
* @param key
* @return
* the key
* @return the field name mapped to the key
*/
public String getFieldName(FieldKey key) {
String name = getAllFieldsMap().get(key.name());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ public UniqueFields clear() {
* Set the field map
*
* @param fields
* fields to add to field map
* @return the unique fields
*/
public UniqueFields set(Multimap<String,UniqueGranularity> fields) {
return clear().putAll(fields);
Expand All @@ -194,6 +196,7 @@ public UniqueFields set(Multimap<String,UniqueGranularity> fields) {
* the field
* @param uniqueGranularity
* the granularity
* @return the field map
*/
public UniqueFields put(String field, UniqueGranularity uniqueGranularity) {
fieldMap.put(JexlASTHelper.deconstructIdentifier(field).toUpperCase(), uniqueGranularity);
Expand All @@ -205,6 +208,7 @@ public UniqueFields put(String field, UniqueGranularity uniqueGranularity) {
*
* @param fieldMap
* the field map to add entries from
* @return the field map
*/
public UniqueFields putAll(Multimap<String,UniqueGranularity> fieldMap) {
if (fieldMap != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@ public EdgeExtendedSummaryConfiguration(EdgeExtendedSummaryConfiguration other)
* needs to be copied over here.
*
* @param other
* the other configuration
* @param queries
* the collection of queries
*/
public EdgeExtendedSummaryConfiguration(EdgeExtendedSummaryConfiguration other, Collection<QueryData> queries) {
this(other);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,9 @@ public EdgeQueryConfiguration(EdgeQueryConfiguration other) {
* needs to be copied over here.
*
* @param other
* the other edge query configuration
* @param queries
* the collection of queries
*/
public EdgeQueryConfiguration(EdgeQueryConfiguration other, Collection<QueryData> queries) {
this(other);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ public RemoteQueryConfiguration(RemoteQueryConfiguration other) {
* needs to be copied over here.
*
* @param other
* another RemoteQueryConfiguration instance
* @param queries
* collection of queries
*/
public RemoteQueryConfiguration(RemoteQueryConfiguration other, Collection<QueryData> queries) {
this(other);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -727,7 +727,9 @@ public ShardQueryConfiguration(ShardQueryConfiguration other) {
* needs to be copied over here.
*
* @param other
* another ShardQueryConfiguration
* @param queries
* collection of queries
*/
public ShardQueryConfiguration(ShardQueryConfiguration other, Collection<QueryData> queries) {
super(other);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,9 @@ public ShardIndexQueryTable clone() {
*
* @param scanner
* a batch scanner
* @return iterator for discoveredthings
* @param queryData
* the query data
* @return iterator for discovered things
*/
public static Iterator<DiscoveredThing> transformScanner(final BatchScanner scanner, final QueryData queryData) {
return concat(transform(scanner.iterator(), new Function<Entry<Key,Value>,Iterator<DiscoveredThing>>() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ public class TupleToRange implements Function<Tuple2<String,IndexInfo>,Iterator<
protected ShardQueryConfiguration config;

/**
* TupleToRange constructor
*
* @param tableName
* the table name
* @param currentNode
* the jexl node
* @param config
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

public class IvaratorCacheDirConfig implements Serializable {
private static final Logger log = Logger.getLogger(IvaratorCacheDir.class);
private static final long serialVersionUID = 0l;

public static final int DEFAULT_PRIORITY = Integer.MAX_VALUE;
public static final long DEFAULT_MIN_AVAILABLE_STORAGE_MiB = 0L;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ public static String formattedQueryString(String query) throws ParseException {
* a query node
* @param maxChildNodes
* maximum number of child nodes
* @param maxTermsToPrint
* maximum number of terms to print
* @return formatted string
* @throws ParseException
* for parsing issues
Expand Down
Loading

0 comments on commit 361b1ef

Please sign in to comment.