org.forgerock.openam.utils

Class CrestQuery

java.lang.Object

org.forgerock.openam.utils.CrestQuery

public class CrestQuery
extends Object

This class was created to handle queries made via CREST that can provide either a _queryID (String) or a _queryFilter (QueryFilter<JsonPointer>) to search for. Obviously the query filter cannot be converted into a string here because we support LDAP, SQL, etc. at a lower level and so we probably don't know at the time this object is created what the target is.

Constructor Summary

Constructors

Constructor and Description
CrestQuery(org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter) Constructs a new CrestQuery instance with the specified query filter.
CrestQuery(String queryIdPattern) Constructs a new CrestQuery instance with the specified query id.
CrestQuery(String queryId, org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter, List<org.forgerock.json.JsonPointer> fields) Constructs a new CrestQuery instance with the specified query filter.
CrestQuery(String queryId, org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter, List<org.forgerock.json.JsonPointer> fields, boolean escapeQueryId) Constructs a new CrestQuery instance with the specified query filter.

Method Summary

Modifier and Type	Method and Description
List<org.forgerock.json.JsonPointer>	getFields() Gets the list of CREST fields that should be returned in the query result.
org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer>	getQueryFilter() Gets the CREST query filter.
String	getQueryId() Gets the CREST query id.
boolean	hasQueryFilter() Determines if the CREST query is based on a query filter.
boolean	hasQueryId() Determines if the CREST query is based on a query id.
boolean	isEscapeQueryId() Determines if queryId for the CREST should be escaped
String	toString() This is mainly for debugging purposes so you can say "this is a rough idea of the CrestQuery object I've been handed".

Methods inherited from class java.lang.Object

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

Constructor Detail

CrestQuery

public CrestQuery(String queryIdPattern)

Constructs a new CrestQuery instance with the specified query id.

Parameters:

queryIdPattern - The query id.

CrestQuery

public CrestQuery(org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter)

Constructs a new CrestQuery instance with the specified query filter.

Parameters:

queryFilter - The query filter.

CrestQuery

public CrestQuery(String queryId,
                  org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter,
                  List<org.forgerock.json.JsonPointer> fields)

Constructs a new CrestQuery instance with the specified query filter.

Parameters:

queryId - The query ID.

queryFilter - The query filter.

fields - The fields to return in the query results.

CrestQuery

public CrestQuery(String queryId,
                  org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> queryFilter,
                  List<org.forgerock.json.JsonPointer> fields,
                  boolean escapeQueryId)

Constructs a new CrestQuery instance with the specified query filter.

Parameters:

queryId - The query ID.

queryFilter - The query filter.

fields - The fields to return in the query results.

escapeQueryId - escapes queryId to prevent LDAP injection

Method Detail

getQueryId

public String getQueryId()

Gets the CREST query id.

Returns:

the trimmed query id string.

getQueryFilter

public org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> getQueryFilter()

Gets the CREST query filter.

Returns:

the query filter

getFields

public List<org.forgerock.json.JsonPointer> getFields()

Gets the list of CREST fields that should be returned in the query result.

Returns:

The fields to return.

hasQueryId

public boolean hasQueryId()

Determines if the CREST query is based on a query id.

Returns:

true if the object contains a query id.

hasQueryFilter

public boolean hasQueryFilter()

Determines if the CREST query is based on a query filter.

Returns:

true if the object contains a query filter.

isEscapeQueryId

public boolean isEscapeQueryId()

Determines if queryId for the CREST should be escaped

Returns:

true queryId for the CREST should be escaped

toString

public String toString()

This is mainly for debugging purposes so you can say "this is a rough idea of the CrestQuery object I've been handed".

Overrides:

toString in class Object

Returns:

a pretty representation of this object