org.glassfish.tyrus.websockets.uri

Class Match

java.lang.Object

org.glassfish.tyrus.websockets.uri.Match

public class Match
extends Object

Defines a match on an endpoint. The match is either exact, or is not exact. If the match is not exact, it means that some of the path segments on the endpoint are variables. In this case, the Match object carries the indices of the variable segments in the endpoint path, the names and the values.

Author:

dannycoward

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkForEquivalents(List<String> paths) Check for equivalent path.
static List<Match>	getAllMatches(String incoming, Set<WebSocketApplication> thingsWithPath) Return a list of all matches, in order of match preference, best match last.
static Match	getBestMatch(String incoming, Set<WebSocketApplication> thingsWithPath) Returns null, or a Match object
List<String>	getParameterNames() Get parameter names.
String	getParameterValue(String name) Get value of given parameter.
String	getPath() Get path.
List<Integer>	getVariableSegmentIndices() Get variable segment indices (indexes).
WebSocketApplication	getWebSocketApplication() Get WebSocketApplication.
static boolean	isEquivalent(String path1, String path2) Check for equivalent paths.
boolean	isExact() TODO.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getPath

public String getPath()

Get path.

Returns:

path.

getVariableSegmentIndices

public List<Integer> getVariableSegmentIndices()

Get variable segment indices (indexes).

Returns:

list of indices.

getParameterNames

public List<String> getParameterNames()

Get parameter names.

Returns:

list of parameter names.

getParameterValue

public String getParameterValue(String name)

Get value of given parameter.

Parameters:

name - parameter name.

Returns:

value of given parameter.

getWebSocketApplication

public WebSocketApplication getWebSocketApplication()

Get WebSocketApplication.

Returns:

web socket application of this Math.

toString

public String toString()

Overrides:

toString in class Object

isExact

public boolean isExact()

TODO.

Returns:

TODO.

getBestMatch

public static Match getBestMatch(String incoming,
                 Set<WebSocketApplication> thingsWithPath)

Returns null, or a Match object

Parameters:

incoming - TODO

thingsWithPath - TODO

Returns:

TODO

getAllMatches

public static List<Match> getAllMatches(String incoming,
                        Set<WebSocketApplication> thingsWithPath)

Return a list of all matches, in order of match preference, best match last.

Parameters:

incoming - TODO

thingsWithPath - TODO

Returns:

TODO

checkForEquivalents

public static boolean checkForEquivalents(List<String> paths)

Check for equivalent path.

Parameters:

paths - list of paths.

Returns:

true if at least one path in given list is equivalent with current one, false otherwise.

isEquivalent

public static boolean isEquivalent(String path1,
                   String path2)

Check for equivalent paths.

Parameters:

path1 - path to be checked.

path2 - path to be checked.

Returns:

true when provided path are equivalent, false otherwise.