Deprecation warning: Multiple validators will not be supported in
Repose 9. In Repose 9, only a single validator will be allowed in config.
The validator.cfg.xml will contain a list of validator elements.
A validator element will specify the WADL to be used in order to
validate a request for a user of a given role/group.
Deprecation warning: Multiple validators will not be supported
in Repose 9 making this attribute moot. This attribute will not be available in Repose 9.
When set to true, filter will match validators to header 'x-roles' and all matches are
validated until one of them is valid. If a default validator is configured, it will be
the first validator to be checked. In the event that all matches are invalid, the response
returned will be that of the last matched validator. If set to false, or not set at all, the
filter will use the first validator which matches the 'x-roles' header.
Deprecation warning: Embedding a WADL inside of a validator
element will no longer be supported in Repose 9. The WADL will need to be in its own
file and referenced in this config.
Creates a new validator.
Deprecation warning: Starting in Repose 9, roles will need to
be specified inside of the WADL. This attribute will not be available in Repose 9.
List of roles that are applied on single validator. Triggers off of 'x-roles' header.
If set to true, this validator will record, via JMX, the number of times each state in the
generated state machine (the mechanism underlying api validation) is accessed. These values may
be used to determine api usage and coverage.
Deprecation warning: Multiple validators will not be supported
in Repose 9 making this attribute moot. This attribute will not be available in Repose 9.
Set to use this validator if no 'x-roles' header is passed.
If the api-validator config 'multi-match' is set to true then the default validator
will be the first validator to process the incoming request. If multi-match is set to
false and if no validator is matched to the users' roles, then the filter will use
the default validator.
Location of wadl to associate with configured validator. This attribute is optional.
If not specified, then the wadl needs to be embedded within the validator element.
Can be located within the file system or pointed to a remote file.
Can use absolute or relative path.
Note: This will be a required attribute in Repose 9.
dot output file for this validator
DOT is a plain text graph description language.
It is a simple way of describing graphs that both humans and computer programs can use.
XPath version used in the WADL.
Can be 1 or 2.
If 1 is set the Xalan implementation will be used, if 2 then Saxon will be used
Note that XPath 2 with schema awareness requires a Saxon license.
Check that the request body is well-formed XML or JSON that conforms to
the XML or JSON syntax rules.
If set to true and the wadl references an XSD grammar, checks that the
incoming request body is validated against the XSD grammar.
Deprecated: This attribute is deprecated. Use check-grammars attribute instead.
If set to true and the wadl references an XSD or JSON grammar(s), then the
incoming request body will be validated against the grammar(s).
If set to true and the wadl request representation
contains an element the filter will check the root
element of a request
Plain parameter: Assertion about the content of the message.
If set to true and the WADL has a plain parameters defined the filter will
check the plain parameters.
Allow XSD grammar transform. Transform the XML after validation, to fill in things like default
values etc
If set to true allows the filter to perform a transform before xsd validation takes place.
The transformation rules can be defined in the WADL via the Rackspace WADL rax:preprocess
extension.
]]>
Analyzes the state machine generated from the WADL and makes sure that there aren't
any duplicate nodes in the machine.
If set to true checks the validity of the generated state machine (e.g. no dead-end
paths, there is a single start state, no none connected nodes, etc.)
This is an optimization where the well formed check and multiple XPath checks can be merged into
a single check.
If set to true and the WADL defines required headers then the filter will check
that those required headers are present.
Enables the use of the rax:ignoreXSD extension in WADL files to exclude some representations
from validation against the XSD. Default values is true if not specified
]]>
Sets the name for this validator item. The name is used as the MBean name
when connecting to Repose via JMX.
Enables the use of rax:roles in WADL files to determine resource access.
If true, rax:roles defined in the supplied WADL files will be used to determine resource access.
If false, rax:roles defined in WADL files are NOT used to determine resource access.
NOTE: If true, check-headers will also be enabled regardless of your setting.
The XSL engine to use. Possible choices are Xalan, XalanC, and Saxon
Note that Saxon is an XSL 2.0 engine, but most 1.0 XSLs should work fine.
Xalan - Standard Java XSL engine
XalanC - compiles XSL into byte code and is a very efficient 1.0 engine
SaxonHE - Implements v2.0 of the XSL language, but gives a license error when attempting a
transform.
SaxonEE - Implements v2.0 of the XSL language, and allows transforms.
The XSD engine to use for validation. Possible choices are Xerces and SaxonEE.
Note that the SaxonEE validator requires a license.
Mask rax-roles with 404 and 405 errors. By default rax-roles responds with a 403 if there
is a role mismatch, if this is set to true, then the response will be 404 if no methods are
accessible or 405 if some methods are available.
If present, the API Validator filter will not send a failing response when an invalid state
is reached.
Instead, a validator will add the data relating to the failure to a header and forward the
request to be handled by a different filter or service.
If not present, a validator will send a failing response when an invalid state is
reached.
The quality, a double between 0 and 1, assigned to the delegation header on delegation. This
value will be used to order delegation based on priority when multiple delegations are present.
Sets the delegation component name for this validator.