org.springframework.extensions.surf.uri

Class UriTemplateListIndex

java.lang.Object

org.springframework.extensions.surf.uri.UriTemplateListIndex

public class UriTemplateListIndex
extends Object

Index of application URI templates. Each template uses a simple form of the JAX-RS JSR-311 URI Template format - only basic variables are specified in the URI template for matching. Example config:

    
       /page/site/{site}/{page}
       /page/site/{site}
       /page/user/{userid}/{page}
       /page/user/{userid}
    
 

Author:

Kevin Roast

Constructor Summary

Constructors

Constructor and Description
UriTemplateListIndex(org.springframework.extensions.config.ConfigElement config) Instantiates a new UriTemplateList object using the configuration found in the ConfigElement provided.
UriTemplateListIndex(List<org.springframework.extensions.webscripts.UriTemplate> uriTemplates) Instantiates a new UriTemplateListIndex object using the list of UriTemplates provided.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	findMatch(String uri) Search the URI index to locale a match for the specified URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

UriTemplateListIndex

public UriTemplateListIndex(List<org.springframework.extensions.webscripts.UriTemplate> uriTemplates)

Instantiates a new UriTemplateListIndex object using the list of UriTemplates provided.

UriTemplateListIndex

public UriTemplateListIndex(org.springframework.extensions.config.ConfigElement config)

Instantiates a new UriTemplateList object using the configuration found in the ConfigElement provided. This means that in order to change the default templates it is also necessary to change both the Spring configuration for the resolver and provide a new resolver to cope with the template. The only place this is now used is in the PageViewResolver and as soon as it is no longer required it will be deleted.

Parameters:

config - ConfigElement pointing to the sections (see above)

Method Detail

findMatch

public Map<String,String> findMatch(String uri)

Search the URI index to locale a match for the specified URI. If found, return the args that represent the matched URI pattern tokens and the values as per the supplied URI value.

Parameters:

uri - URI to match against the URI Templates in the index

Returns:

Map of token args to values or null if no match was found.