Package org.eclipse.persistence.jpa.rs.features.fieldsfiltering

Class FieldsFilteringValidator

java.lang.Object

org.eclipse.persistence.jpa.rs.features.fieldsfiltering.FieldsFilteringValidator

public final class FieldsFilteringValidator
extends Object

Fields filtering feature validator/processor.

Author:

Dmitry Kornilov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCL_FIELDS_PARAM_NAME
static final String	FIELDS_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
FieldsFilteringValidator(jakarta.ws.rs.core.UriInfo uri)	Creates the validator.

Method Summary

Modifier and Type	Method	Description
FieldsFilter	getFilter()	FieldsFilter object containing a list of fields to filter.
boolean	isFeatureApplicable()	Checks if request is valid.

Methods inherited from class java.lang.Object

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

Field Details

FIELDS_PARAM_NAME

public static final String FIELDS_PARAM_NAME

See Also:

• Constant Field Values

EXCL_FIELDS_PARAM_NAME

public static final String EXCL_FIELDS_PARAM_NAME

See Also:

• Constant Field Values

Constructor Details

FieldsFilteringValidator

public FieldsFilteringValidator(jakarta.ws.rs.core.UriInfo uri)

Creates the validator.

Parameters:

uri - request URI.

Method Details

isFeatureApplicable

public boolean isFeatureApplicable()
                            throws JPARSException

Checks if request is valid.

Returns:

true if request is valid and feature is supported, false if request is valid but feature is not supported.

Throws:

JPARSException - in case of any validation errors.

getFilter

public FieldsFilter getFilter()

FieldsFilter object containing a list of fields to filter.

Returns:

FieldsFilter