Package com.evolveum.midpoint.schema.util

Class ObjectQueryUtil

java.lang.Object

com.evolveum.midpoint.schema.util.ObjectQueryUtil

public class ObjectQueryUtil
extends Object

Constructor Summary

Constructors

Constructor	Description
ObjectQueryUtil()

Method Summary

Modifier and Type	Method	Description
static ObjectQuery	addConjunctions(ObjectQuery query, ObjectFilter... newConjunctionMembers)
static ObjectQuery	addConjunctions(ObjectQuery query, Collection<ObjectFilter> newConjunctionMembers)	Returns non-null value if newConjunctionMembers is not empty.
static void	assertNotRaw(ObjectFilter filter, String message)
static void	assertPropertyOnly(ObjectFilter filter, String message)
static ObjectPaging	convertToObjectPaging(PagingType pagingType)
static ObjectQuery	createNameQuery(PolyString name)
static <O extends ObjectType> ObjectQuery	createNameQuery(PrismObject<O> object)
static ObjectQuery	createNameQuery(ObjectType object)
static ObjectQuery	createNameQuery(PolyStringType name)
static <T extends ObjectType> ObjectQuery	createNameQuery(Class<T> clazz, String name)
static ObjectQuery	createNameQuery(String name)
static ObjectQuery	createNormNameQuery(PolyString name)
static ObjectFilter	createObjectClassFilter(QName objectClass)
static @NotNull ObjectFilter	createObjectTypesFilter(@NotNull String resourceOid, @NotNull Collection<ShadowRelationParticipantType> targetParticipantTypes, boolean executableOnResource, Object errorCtx)	Creates a filter that matches target objects for given reference or association definition.
static <O extends ObjectType> ObjectQuery	createOidQuery(PrismObject<O> object)
static ObjectQuery	createOidQuery(String oid)
static ObjectQuery	createOrigNameQuery(PolyString name)
static ObjectQuery	createOrigNameQuery(String name)
static @NotNull ObjectQuery	createQuery(@Nullable ObjectFilter filter)
static List<PrismReferenceValue>	createReferences(String oid, RelationKindType kind, RelationRegistry relationRegistry)
static List<PrismReferenceValue>	createReferences(Collection<String> oids, RelationKindType kind, RelationRegistry relationRegistry)
static ObjectQuery	createResourceAndKind(String resourceOid, ShadowKindType kind)
static @NotNull ObjectQuery	createResourceAndKindIntent(String resourceOid, ShadowKindType kind, String intent)
static ObjectFilter	createResourceAndKindIntentFilter(String resourceOid, ShadowKindType kind, String intent)
static ObjectFilter	createResourceAndObjectClassFilter(String resourceOid, QName objectClass)
static ObjectFilter	createResourceAndObjectClassFilter(String resourceOid, QName objectClass, PrismContext ignored)	Deprecated.
static S_FilterExit	createResourceAndObjectClassFilterPrefix(String resourceOid, QName objectClass)
static @NotNull ObjectQuery	createResourceAndObjectClassQuery(String resourceOid, QName objectClass)
static @NotNull ObjectQuery	createResourceAndObjectClassQuery(String resourceOid, QName objectClass, PrismContext ignored)	Deprecated.
static ObjectFilter	createResourceFilter(String resourceOid)
static ObjectQuery	createResourceQuery(String resourceOid)
static ObjectQuery	createRootOrgQuery(PrismContext prismContext)
static String	dump(QueryType query, @NotNull PrismContext prismContext)
static @NotNull ObjectQuery	emptyIfNull(ObjectQuery objectQuery)
static ObjectFilter	filterAnd(ObjectFilter origFilter, ObjectFilter additionalFilter)	Merges the two provided arguments into one AND filter in the most efficient way.
static ObjectFilter	filterAndImmutable(@Nullable ObjectFilter origFilter, @Nullable ObjectFilter additionalFilter)	Merges the two provided arguments into one AND filter in an immutable way.
static ObjectFilter	filterOr(ObjectFilter origFilter, ObjectFilter additionalFilter)	Merges the two provided arguments into one OR filter in the most efficient way.
static ObjectFilter	filterOrImmutable(ObjectFilter origFilter, ObjectFilter additionalFilter)	Merges the two provided arguments into one OR filter in an immutable way.
static @NotNull ResourceOperationCoordinates	getOperationCoordinates(ObjectFilter filter)
static @NotNull ResourceOperationCoordinates	getOperationCoordinates(ObjectQuery query)
static String	getResourceOidFromFilter(ObjectFilter filter)
static ResourceShadowCoordinates	getShadowCoordinates(ObjectFilter filter, PrismContext ignored)	Deprecated.
static ResourceShadowCoordinates	getShadowCoordinates(ObjectQuery query)
static boolean	hasAllDefinitions(ObjectFilter filter)
static boolean	hasAllDefinitions(ObjectQuery query)
static boolean	hasFilter(ObjectQuery query)
static boolean	isAll(ObjectFilter filter)
static boolean	isNone(ObjectFilter filter)
static boolean	isNoneQuery(ObjectQuery query)	Returns true if query is not null and its filter is NoneFilter.
static @NotNull ObjectQuery	openItemsQuery()
static @NotNull ObjectQuery	replaceFilter(ObjectQuery original, ObjectFilter newFilter)
static ObjectFilter	simplify(ObjectFilter filter)	Returns ALL, NONE only at the top level (never inside the filter), never returns UNDEFINED.
static ObjectQuery	simplifyQuery(ObjectQuery query)	Returns cloned query with simplified filter - ALL, NONE only at the top level, never UNDEFINED.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectQueryUtil

public ObjectQueryUtil()

Method Details

createNameQuery

public static ObjectQuery createNameQuery(String name)
                                   throws SchemaException

Throws:

SchemaException

createOrigNameQuery

public static ObjectQuery createOrigNameQuery(String name)

createNameQuery

public static ObjectQuery createNameQuery(PolyStringType name)
                                   throws SchemaException

Throws:

SchemaException

createNameQuery

public static ObjectQuery createNameQuery(PolyString name)
                                   throws SchemaException

Throws:

SchemaException

createOidQuery

public static <O extends ObjectType> ObjectQuery createOidQuery(PrismObject<O> object)
                                                         throws SchemaException

Throws:

SchemaException

createOidQuery

public static ObjectQuery createOidQuery(String oid)

createOrigNameQuery

public static ObjectQuery createOrigNameQuery(PolyString name)

createNormNameQuery

public static ObjectQuery createNormNameQuery(PolyString name)

createNameQuery

public static ObjectQuery createNameQuery(ObjectType object)
                                   throws SchemaException

Throws:

SchemaException

createNameQuery

public static <O extends ObjectType> ObjectQuery createNameQuery(PrismObject<O> object)
                                                          throws SchemaException

Throws:

SchemaException

createResourceAndObjectClassQuery

@Deprecated
@NotNull
public static @NotNull ObjectQuery createResourceAndObjectClassQuery(String resourceOid,
 QName objectClass,
 PrismContext ignored)

Deprecated.

createResourceAndObjectClassQuery

@NotNull
public static @NotNull ObjectQuery createResourceAndObjectClassQuery(String resourceOid,
 QName objectClass)

createResourceAndObjectClassFilter

@Deprecated
public static ObjectFilter createResourceAndObjectClassFilter(String resourceOid,
 QName objectClass,
 PrismContext ignored)

Deprecated.

createResourceAndObjectClassFilter

public static ObjectFilter createResourceAndObjectClassFilter(String resourceOid,
 QName objectClass)

createResourceAndObjectClassFilterPrefix

public static S_FilterExit createResourceAndObjectClassFilterPrefix(String resourceOid,
 QName objectClass)

createResourceAndKindIntent

@NotNull
public static @NotNull ObjectQuery createResourceAndKindIntent(String resourceOid,
 ShadowKindType kind,
 String intent)

createResourceAndKind

public static ObjectQuery createResourceAndKind(String resourceOid,
 ShadowKindType kind)

createResourceAndKindIntentFilter

public static ObjectFilter createResourceAndKindIntentFilter(String resourceOid,
 ShadowKindType kind,
 String intent)

createResourceQuery

public static ObjectQuery createResourceQuery(String resourceOid)

createResourceFilter

public static ObjectFilter createResourceFilter(String resourceOid)

createObjectClassFilter

public static ObjectFilter createObjectClassFilter(QName objectClass)

createNameQuery

public static <T extends ObjectType> ObjectQuery createNameQuery(Class<T> clazz,
 String name)
                                                          throws SchemaException

Throws:

SchemaException

createRootOrgQuery

public static ObjectQuery createRootOrgQuery(PrismContext prismContext)

hasAllDefinitions

public static boolean hasAllDefinitions(ObjectQuery query)

hasAllDefinitions

public static boolean hasAllDefinitions(ObjectFilter filter)

assertPropertyOnly

public static void assertPropertyOnly(ObjectFilter filter,
 String message)

assertNotRaw

public static void assertNotRaw(ObjectFilter filter,
 String message)

dump

public static String dump(QueryType query,
 @NotNull
 @NotNull PrismContext prismContext)
                   throws SchemaException

Throws:

SchemaException

filterAnd

public static ObjectFilter filterAnd(ObjectFilter origFilter,
 ObjectFilter additionalFilter)

Merges the two provided arguments into one AND filter in the most efficient way. *Please note: If provided `origFilter` is AndFilter it will be modified!* TODO consider moving to QueryFactory

filterAndImmutable

public static ObjectFilter filterAndImmutable(@Nullable
 @Nullable ObjectFilter origFilter,
 @Nullable
 @Nullable ObjectFilter additionalFilter)

Merges the two provided arguments into one AND filter in an immutable way. If provided `origFilter` is AndFilter, it will be cloned first, then modified. Although input objects are not changed, there is no guarantee that new object is always returned. For many simple and/or corner cases one of the parameters may be returned, so it may not be safe to mutate the returned value. TODO consider moving to QueryFactory

filterOr

public static ObjectFilter filterOr(ObjectFilter origFilter,
 ObjectFilter additionalFilter)

Merges the two provided arguments into one OR filter in the most efficient way. *Please note: If provided `origFilter` is OrFilter it will be modified!* TODO consider moving to QueryFactory

filterOrImmutable

public static ObjectFilter filterOrImmutable(ObjectFilter origFilter,
 ObjectFilter additionalFilter)

Merges the two provided arguments into one OR filter in an immutable way. If provided `origFilter` is OrFilter, it will be cloned first, then modified. Although input objects are not changed, there is no guarantee that new object is always returned. For many simple and/or corner cases one of the parameters may be returned, so it may not be safe to mutate the returned value. TODO consider moving to QueryFactory

isAll

public static boolean isAll(ObjectFilter filter)

isNone

public static boolean isNone(ObjectFilter filter)

simplify

public static ObjectFilter simplify(ObjectFilter filter)

Returns ALL, NONE only at the top level (never inside the filter), never returns UNDEFINED. This always returns cloned filter which can be freely modify later.

simplifyQuery

public static ObjectQuery simplifyQuery(ObjectQuery query)

Returns cloned query with simplified filter - ALL, NONE only at the top level, never UNDEFINED.

isNoneQuery

public static boolean isNoneQuery(ObjectQuery query)

Returns true if query is not null and its filter is NoneFilter.

getResourceOidFromFilter

public static String getResourceOidFromFilter(ObjectFilter filter)
                                       throws SchemaException

Throws:

SchemaException

getShadowCoordinates

@Deprecated
public static ResourceShadowCoordinates getShadowCoordinates(ObjectFilter filter,
 PrismContext ignored)
                                                      throws SchemaException

Deprecated.

Throws:

SchemaException

getOperationCoordinates

@NotNull
public static @NotNull ResourceOperationCoordinates getOperationCoordinates(ObjectQuery query)
                                                                     throws SchemaException

Throws:

SchemaException

getShadowCoordinates

public static ResourceShadowCoordinates getShadowCoordinates(ObjectQuery query)
                                                      throws SchemaException

Throws:

SchemaException

getOperationCoordinates

@NotNull
public static @NotNull ResourceOperationCoordinates getOperationCoordinates(ObjectFilter filter)
                                                                     throws SchemaException

Throws:

SchemaException

createReferences

public static List<PrismReferenceValue> createReferences(String oid,
 RelationKindType kind,
 RelationRegistry relationRegistry)

createReferences

public static List<PrismReferenceValue> createReferences(Collection<String> oids,
 RelationKindType kind,
 RelationRegistry relationRegistry)

addConjunctions

public static ObjectQuery addConjunctions(ObjectQuery query,
 ObjectFilter... newConjunctionMembers)

addConjunctions

public static ObjectQuery addConjunctions(ObjectQuery query,
 Collection<ObjectFilter> newConjunctionMembers)

Returns non-null value if newConjunctionMembers is not empty.

hasFilter

public static boolean hasFilter(ObjectQuery query)

replaceFilter

@NotNull
public static @NotNull ObjectQuery replaceFilter(ObjectQuery original,
 ObjectFilter newFilter)

convertToObjectPaging

public static ObjectPaging convertToObjectPaging(PagingType pagingType)

openItemsQuery

@NotNull
public static @NotNull ObjectQuery openItemsQuery()

createQuery

@NotNull
public static @NotNull ObjectQuery createQuery(@Nullable
 @Nullable ObjectFilter filter)

emptyIfNull

@NotNull
public static @NotNull ObjectQuery emptyIfNull(ObjectQuery objectQuery)

createObjectTypesFilter

@NotNull
public static @NotNull ObjectFilter createObjectTypesFilter(@NotNull
 @NotNull String resourceOid,
 @NotNull
 @NotNull Collection<ShadowRelationParticipantType> targetParticipantTypes,
 boolean executableOnResource,
 Object errorCtx)

Creates a filter that matches target objects for given reference or association definition. For internal use by reference and association definitions.

See Also:

• ShadowReferenceAttributeDefinition.createTargetObjectsFilter(boolean)
• ShadowAssociationDefinition.createTargetObjectsFilter(boolean)