org.apache.juneau.rest

Class ClientVersionMatcher

java.lang.Object

org.apache.juneau.rest.RestMatcher

org.apache.juneau.rest.ClientVersionMatcher

public class ClientVersionMatcher
extends RestMatcher

Specialized matcher for matching client versions.

• Overview > juneau-rest-server > Client Versioning

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientVersionMatcher(String clientVersionHeader, MethodInfo mi) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	matches(RestRequest req) Returns true if the specified request matches this matcher.
boolean	mustMatch() Returns true if this matcher is required to match in order for the method to be invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientVersionMatcher

protected ClientVersionMatcher(String clientVersionHeader,
                               MethodInfo mi)

Constructor.

Parameters:

clientVersionHeader - The HTTP request header name containing the client version. If null or an empty string, uses "X-Client-Version"

mi - The version string that the client version must match.

Method Detail

matches

public boolean matches(RestRequest req)

Description copied from class: RestMatcher

Returns true if the specified request matches this matcher.

Specified by:

matches in class RestMatcher

Parameters:

req - The servlet request.

Returns:

true if the specified request matches this matcher.

mustMatch

public boolean mustMatch()

Description copied from class: RestMatcher

Returns true if this matcher is required to match in order for the method to be invoked.

If false, then only one of the matchers must match.

Overrides:

mustMatch in class RestMatcher

Returns:

true if this matcher is required to match in order for the method to be invoked.