org.identityconnectors.ldap.search

Class LdapFilterTranslator

java.lang.Object

org.identityconnectors.framework.common.objects.filter.AbstractFilterTranslator<LdapFilter>

org.identityconnectors.ldap.search.LdapFilterTranslator

All Implemented Interfaces:

FilterTranslator<LdapFilter>

public class LdapFilterTranslator
extends AbstractFilterTranslator<LdapFilter>

Constructor Summary

Constructors

Constructor and Description
LdapFilterTranslator(LdapSchemaMapping mapping, ObjectClass objectClass)

Method Summary

Modifier and Type	Method and Description
LdapFilter	createAndExpression(LdapFilter leftExpression, LdapFilter rightExpression) Should be overridden by subclasses to create an AND expression if the native resource supports AND.
LdapFilter	createContainsAllValuesExpression(ContainsAllValuesFilter filter, boolean not) Should be overridden by subclasses to create a CONTAINS-ALL-VALUES expression if the native resource supports a contains all values.
LdapFilter	createContainsExpression(ContainsFilter filter, boolean not) Should be overridden by subclasses to create a CONTAINS expression if the native resource supports CONTAINS.
LdapFilter	createEndsWithExpression(EndsWithFilter filter, boolean not) Should be overridden by subclasses to create a ENDS-WITH expression if the native resource supports ENDS-WITH.
LdapFilter	createEqualsExpression(EqualsFilter filter, boolean not) Should be overridden by subclasses to create a EQUALS expression if the native resource supports EQUALS.
LdapFilter	createGreaterThanExpression(GreaterThanFilter filter, boolean not) Should be overridden by subclasses to create a GREATER-THAN expression if the native resource supports GREATER-THAN.
LdapFilter	createGreaterThanOrEqualExpression(GreaterThanOrEqualFilter filter, boolean not) Should be overridden by subclasses to create a GREATER-THAN-EQUAL expression if the native resource supports GREATER-THAN-EQUAL.
LdapFilter	createLessThanExpression(LessThanFilter filter, boolean not) Should be overridden by subclasses to create a LESS-THAN expression if the native resource supports LESS-THAN.
LdapFilter	createLessThanOrEqualExpression(LessThanOrEqualFilter filter, boolean not) Should be overridden by subclasses to create a LESS-THAN-EQUAL expression if the native resource supports LESS-THAN-EQUAL.
LdapFilter	createOrExpression(LdapFilter leftExpression, LdapFilter rightExpression) Should be overridden by subclasses to create an OR expression if the native resource supports OR.
LdapFilter	createStartsWithExpression(StartsWithFilter filter, boolean not) Should be overridden by subclasses to create a STARTS-WITH expression if the native resource supports STARTS-WITH.

Methods inherited from class org.identityconnectors.framework.common.objects.filter.AbstractFilterTranslator

translate

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapFilterTranslator

public LdapFilterTranslator(LdapSchemaMapping mapping,
                            ObjectClass objectClass)

Method Detail

createAndExpression

public LdapFilter createAndExpression(LdapFilter leftExpression,
                                      LdapFilter rightExpression)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create an AND expression if the native resource supports AND.

Overrides:

createAndExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

leftExpression - The left expression. Will never be null.

rightExpression - The right expression. Will never be null.

Returns:

The AND expression. A return value of null means a native AND query cannot be created for the given expressions. In this case, the resulting query will consist of the leftExpression only.

createOrExpression

public LdapFilter createOrExpression(LdapFilter leftExpression,
                                     LdapFilter rightExpression)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create an OR expression if the native resource supports OR.

Overrides:

createOrExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

leftExpression - The left expression. Will never be null.

rightExpression - The right expression. Will never be null.

Returns:

The OR expression. A return value of null means a native OR query cannot be created for the given expressions. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return multiple queries, each of which must be run and results combined.

createContainsExpression

public LdapFilter createContainsExpression(ContainsFilter filter,
                                           boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a CONTAINS expression if the native resource supports CONTAINS.

Overrides:

createContainsExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT CONTAINS

Returns:

The CONTAINS expression. A return value of null means a native CONTAINS query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createEndsWithExpression

public LdapFilter createEndsWithExpression(EndsWithFilter filter,
                                           boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a ENDS-WITH expression if the native resource supports ENDS-WITH.

Overrides:

createEndsWithExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT ENDS-WITH

Returns:

The ENDS-WITH expression. A return value of null means a native ENDS-WITH query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createEqualsExpression

public LdapFilter createEqualsExpression(EqualsFilter filter,
                                         boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a EQUALS expression if the native resource supports EQUALS.

Overrides:

createEqualsExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT EQUALS

Returns:

The EQUALS expression. A return value of null means a native EQUALS query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createGreaterThanExpression

public LdapFilter createGreaterThanExpression(GreaterThanFilter filter,
                                              boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a GREATER-THAN expression if the native resource supports GREATER-THAN.

Overrides:

createGreaterThanExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT GREATER-THAN

Returns:

The GREATER-THAN expression. A return value of null means a native GREATER-THAN query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createGreaterThanOrEqualExpression

public LdapFilter createGreaterThanOrEqualExpression(GreaterThanOrEqualFilter filter,
                                                     boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a GREATER-THAN-EQUAL expression if the native resource supports GREATER-THAN-EQUAL.

Overrides:

createGreaterThanOrEqualExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT GREATER-THAN-EQUAL

Returns:

The GREATER-THAN-EQUAL expression. A return value of null means a native GREATER-THAN-EQUAL query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createLessThanExpression

public LdapFilter createLessThanExpression(LessThanFilter filter,
                                           boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a LESS-THAN expression if the native resource supports LESS-THAN.

Overrides:

createLessThanExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT LESS-THAN

Returns:

The LESS-THAN expression. A return value of null means a native LESS-THAN query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createLessThanOrEqualExpression

public LdapFilter createLessThanOrEqualExpression(LessThanOrEqualFilter filter,
                                                  boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a LESS-THAN-EQUAL expression if the native resource supports LESS-THAN-EQUAL.

Overrides:

createLessThanOrEqualExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT LESS-THAN-EQUAL

Returns:

The LESS-THAN-EQUAL expression. A return value of null means a native LESS-THAN-EQUAL query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createStartsWithExpression

public LdapFilter createStartsWithExpression(StartsWithFilter filter,
                                             boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a STARTS-WITH expression if the native resource supports STARTS-WITH.

Overrides:

createStartsWithExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains filter. Will never be null.

not - True if this should be a NOT STARTS-WITH

Returns:

The STARTS-WITH expression. A return value of null means a native STARTS-WITH query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.

createContainsAllValuesExpression

public LdapFilter createContainsAllValuesExpression(ContainsAllValuesFilter filter,
                                                    boolean not)

Description copied from class: AbstractFilterTranslator

Should be overridden by subclasses to create a CONTAINS-ALL-VALUES expression if the native resource supports a contains all values.

Overrides:

createContainsAllValuesExpression in class AbstractFilterTranslator<LdapFilter>

Parameters:

filter - The contains all filter. Will never be null.

not - True if this should be a NOT CONTAINS-ALL-VALUES.

Returns:

The CONTAINS-ALL-VALUES expression. A return value of null means a native CONTAINS-ALL-VALUES query cannot be created for the given filter. In this case, AbstractFilterTranslator.translate(org.identityconnectors.framework.common.objects.filter.Filter) may return an empty query set, meaning fetch everything. The filter will be re-applied in memory to the resulting object stream. This does not scale well, so if possible, you should implement this method.