Package org.restheart.mongodb.handlers.aggregation

Class AbstractAggregationOperation

java.lang.Object

org.restheart.mongodb.handlers.aggregation.AbstractAggregationOperation

Direct Known Subclasses:

AggregationPipeline, MapReduce

public abstract class AbstractAggregationOperation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractAggregationOperation.TYPE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGGREGATIONS_ELEMENT_NAME
static final String	TYPE_ELEMENT_NAME
static final String	URI_ELEMENT_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractAggregationOperation(org.bson.BsonDocument properties)

Method Summary

Modifier and Type	Method	Description
protected org.bson.BsonValue	bindAggregationVariables(org.bson.BsonValue obj, org.bson.BsonDocument aVars)
static void	checkAggregationVariables(org.bson.BsonValue aVars)	checks if the aggregation variable start with $ this is not allowed since the client would be able to modify the aggregation stages
static List<AbstractAggregationOperation>	getFromJson(org.bson.BsonDocument collProps)
AbstractAggregationOperation.TYPE	getType()
String	getUri()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AGGREGATIONS_ELEMENT_NAME

public static final String AGGREGATIONS_ELEMENT_NAME

See Also:

• Constant Field Values

URI_ELEMENT_NAME

public static final String URI_ELEMENT_NAME

See Also:

• Constant Field Values

TYPE_ELEMENT_NAME

public static final String TYPE_ELEMENT_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractAggregationOperation

public AbstractAggregationOperation(org.bson.BsonDocument properties)
                             throws InvalidMetadataException

Parameters:

properties -

Throws:

InvalidMetadataException

Method Details

getFromJson

public static List<AbstractAggregationOperation> getFromJson(org.bson.BsonDocument collProps)
                                                      throws InvalidMetadataException

Parameters:

collProps -

Returns:

Throws:

InvalidMetadataException

checkAggregationVariables

public static void checkAggregationVariables(org.bson.BsonValue aVars)
                                      throws SecurityException

checks if the aggregation variable start with $ this is not allowed since the client would be able to modify the aggregation stages

Parameters:

aVars - RequestContext.getAggregationVars()

Throws:

SecurityException

getType

public AbstractAggregationOperation.TYPE getType()

Returns:

the type

getUri

public String getUri()

Returns:

the uri

bindAggregationVariables

protected org.bson.BsonValue bindAggregationVariables(org.bson.BsonValue obj,
 org.bson.BsonDocument aVars)
                                               throws InvalidMetadataException,
QueryVariableNotBoundException

Parameters:

obj -

aVars - RequestContext.getAggregationVars()

Returns:

the json object where the variables {"_$var": "name" } or {"_$var": [ "name", "defaultValue" ] } are replaced with the values defined in the avars URL query parameter

Throws:

InvalidMetadataException

QueryVariableNotBoundException