datasourcex-util/com.caplin.integration.datasourcex.util/AntPatternNamespace

AntPatternNamespace

class AntPatternNamespace @JvmOverloads constructor(pattern: String, val rawPathVariables: Set<String> = emptySet()) : Namespace(source)

An implementation of Namespace that matches subjects based on Ant style path patterns.

This supports the majority of the rules laid out in Spring's AntPathMatcher, but with the exception that regex path variables are not supported.

Simple path variables such as {client} are supported, and can be accessed via extractPathVariables.

Constructors

AntPatternNamespace

@JvmOverloads

constructor(pattern: String, rawPathVariables: Set<String> = emptySet())

Types

Companion

object Companion

ObjectMap

class ObjectMap(val fromPattern: String, val toPattern: String)

Represents a mapping between a from-pattern and a to-pattern, used for injecting user-specific information into subjects requested by Liberator.

Properties

isExact

val isExact: Boolean

Indicates whether this pattern only matches one exact path (i.e. no use of ?, *, ** or path variables).

pathVariables

val pathVariables: Set<String>

Provides a list of possible path variables.

pattern

val pattern: String

The Ant-style path pattern used by this namespace.

posixExtendedPattern

val posixExtendedPattern: String

Provides a POSIX Extended Regular Expression version of this pattern, suitable for use in Service.addIncludePattern and Service.addExcludePattern

rawPathVariables

val rawPathVariables: Set<String>

Path variable names whose values are returned unchanged by extractPathVariables instead of being URL-decoded. Intended for values injected by Liberator (such as usernames mapped from %u/%U) that are not URL-encoded. Empty by default.

Functions

copy

fun copy(rawPathVariables: Set<String> = this.rawPathVariables): AntPatternNamespace

Returns a copy of this namespace with rawPathVariables replaced.

extractPathParameters

fun extractPathParameters(path: String): List<String>

Splits the path portion of a subject into its URL-decoded segments, in order. Any trailing ?query is ignored.

extractPathVariables

fun extractPathVariables(path: String): LinkedHashMap<String, String>

Extracts path variables from a matching subject. Values are URL-decoded, except for any listed in rawPathVariables which are returned verbatim. Any trailing ?query is ignored, so a subject that carries query parameters yields the same path variables as the query-less subject.

extractQueryParameters

fun extractQueryParameters(path: String): SortedMap<String, String>

Extracts the query parameters from the optional trailing ?a=b&c=d portion of a subject.

getObjectMap

fun getObjectMap(mappings: Map<String, String>): AntPatternNamespace.ObjectMap

Creates from and to object-map patterns that can be used with Service.addObjectMap to inject user-specific information into subjects requested by Liberator.

match

open override fun match(path: String): Boolean

toString

open override fun toString(): String