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 java.lang.Object

Fields filtering feature validator/processor.

Author:

Dmitry Kornilov

Since:

EclipseLink 2.6.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXCL_FIELDS_PARAM_NAME
static java.lang.String	FIELDS_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
FieldsFilteringValidator(javax.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 Detail

FIELDS_PARAM_NAME

public static final java.lang.String FIELDS_PARAM_NAME

See Also:

Constant Field Values

EXCL_FIELDS_PARAM_NAME

public static final java.lang.String EXCL_FIELDS_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

FieldsFilteringValidator

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

Creates the validator.

Parameters:

uri - request URI.

Method Detail

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