org.cthul.resolve

Class UriMappingResolver

java.lang.Object

org.cthul.resolve.ResourceResolverBase

org.cthul.resolve.UriMappingResolver

All Implemented Interfaces:

ResourceResolver

Direct Known Subclasses:

ClassLoaderResourceResolver, ClassResourceResolver, FileResolver

public abstract class UriMappingResolver
extends ResourceResolverBase

Uses regular expressions to convert a requested URI into an internal format. Subclasses are responsible for finding a result for the mapped string.

See Also:

ClassResourceResolver, FileResolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UriMappingResolver.Resolver

Constructor Summary

Constructors

Constructor and Description
UriMappingResolver()
UriMappingResolver(Map<String,String> schemas)
UriMappingResolver(String... schemas)

Method Summary

Modifier and Type	Method and Description
UriMappingResolver	addDomain(String domain) Adds a domain for which paths will be looked up.
UriMappingResolver	addDomain(String domain, String replacement) Adds a domain for relative lookup.
UriMappingResolver	addDomainPattern(Pattern pattern, String replacement)
UriMappingResolver	addDomainPattern(String domain, String replacement)
UriMappingResolver	addDomainPatterns(String... values)
UriMappingResolver	addDomains(String... values) Calls addDomain(java.lang.String, java.lang.String) with pairs from the argument array.
UriMappingResolver	addResource(String uri, String resource) Adds a single resource that can be looked-up by its uri.
UriMappingResolver	addResources(Map<String,String> resources) Adds all resources so that they can be looked up by the uris.
UriMappingResolver	addResources(String... resources) Calls addResource(java.lang.String, java.lang.String) with pairs taken from the argument array.
UriMappingResolver	addSchema(String uri, String schemas) Alias for addResource(java.lang.String, java.lang.String)
UriMappingResolver	addSchemas(Map<String,String> schemas) Alias for addResources(java.util.Map)
UriMappingResolver	addSchemas(String... schemas) Alias for addResources(java.lang.String[])
protected abstract RResponse	get(RRequest request, String uri) Returns a resource for the requested uri, or null if it could not be found.
protected String	getMappingString() string representation for debugging purposes
UriMappingResolver	lookupAll() Adds a rule to look-up all uris as they are.
protected String	mapDomain(Map.Entry<Pattern,String> domain, String uri)
protected String	mapUri(String uri)
protected Iterator<Map.Entry<Pattern,String>>	patternIterator()
protected String	quote(String pattern)
RResponse	resolve(RRequest request)
protected RResponse	resolve(RRequest request, String uri)
protected Iterator<String>	resolver(String uri)
String	toString()
protected String	uri(RRequest request)
UriMappingResolver	useSimpleQuoting() Make this use Pattern.quote(java.lang.String) instead of RegEx.quote(java.lang.String) for creating patterns from domains.

Methods inherited from class org.cthul.resolve.ResourceResolverBase

immutable, join

Methods inherited from class java.lang.Object

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

Constructor Detail

UriMappingResolver

public UriMappingResolver(String... schemas)

UriMappingResolver

public UriMappingResolver(Map<String,String> schemas)

UriMappingResolver

public UriMappingResolver()

Method Detail

useSimpleQuoting

public UriMappingResolver useSimpleQuoting()

Make this use Pattern.quote(java.lang.String) instead of RegEx.quote(java.lang.String) for creating patterns from domains.

Returns:

this

quote

protected String quote(String pattern)

addSchema

public UriMappingResolver addSchema(String uri,
                                    String schemas)

Alias for addResource(java.lang.String, java.lang.String)

Parameters:

uri -

schemas -

Returns:

this

addSchemas

public UriMappingResolver addSchemas(String... schemas)

Alias for addResources(java.lang.String[])

Parameters:

schemas -

Returns:

this

addSchemas

public UriMappingResolver addSchemas(Map<String,String> schemas)

Alias for addResources(java.util.Map)

Parameters:

schemas -

Returns:

addResource

public UriMappingResolver addResource(String uri,
                                      String resource)

Adds a single resource that can be looked-up by its uri.

Parameters:

uri -

resource -

Returns:

this

addResources

public UriMappingResolver addResources(String... resources)

Calls addResource(java.lang.String, java.lang.String) with pairs taken from the argument array.

Parameters:

resources - array of uri-resource pairs

Returns:

this

Throws:

IllegalArgumentException - if length of resources is not even

addResources

public UriMappingResolver addResources(Map<String,String> resources)

Adds all resources so that they can be looked up by the uris.

Parameters:

resources - uri-resource map

Returns:

this

addDomain

public UriMappingResolver addDomain(String domain,
                                    String replacement)

Adds a domain for relative lookup. All uris starting with domain will be replaced with replacement. In the replacement string "$1", will be replaced with path of the request uri. Path separators ('/') between the domain and the path will be removed.

Parameters:

domain -

replacement -

Returns:

this

addDomain

public UriMappingResolver addDomain(String domain)

Adds a domain for which paths will be looked up. Equivalent to addDomain(domain, "$1").

Parameters:

domain -

Returns:

this

addDomains

public UriMappingResolver addDomains(String... values)

Calls addDomain(java.lang.String, java.lang.String) with pairs from the argument array.

Parameters:

values -

Returns:

this

Throws:

IllegalArgumentException - if length of resources is not even

lookupAll

public UriMappingResolver lookupAll()

Adds a rule to look-up all uris as they are. Equivalent to addDomain("", "$1").

Returns:

this

addDomainPattern

public UriMappingResolver addDomainPattern(String domain,
                                           String replacement)

addDomainPattern

public UriMappingResolver addDomainPattern(Pattern pattern,
                                           String replacement)

addDomainPatterns

public UriMappingResolver addDomainPatterns(String... values)

resolver

protected Iterator<String> resolver(String uri)

mapUri

protected String mapUri(String uri)

patternIterator

protected Iterator<Map.Entry<Pattern,String>> patternIterator()

mapDomain

protected String mapDomain(Map.Entry<Pattern,String> domain,
                           String uri)

resolve

public RResponse resolve(RRequest request)

Returns:

result representing the resource, or null if none was found.

uri

protected String uri(RRequest request)

resolve

protected RResponse resolve(RRequest request,
                            String uri)

get

protected abstract RResponse get(RRequest request,
                                 String uri)
                          throws Exception

Returns a resource for the requested uri, or null if it could not be found.

Parameters:

request -

uri -

Returns:

result or null

Throws:

Exception

getMappingString

protected String getMappingString()

string representation for debugging purposes

toString

public String toString()

Overrides:

toString in class Object