Package ru.vyarus.guicey.gsp.app.rest.mapping

Class ViewRestLookup

  • public class ViewRestLookup
extends java.lang.Object
    View rest endpoints are mapped with a prefix: so gsp application call /something could be remapped to [rest]/[prefix]/something. Special prefixes could be mapped to some urls: e.g. /sub/url -> prefix2 and so when /sub/url/something will be called in gsp application it would redirect to [rest]/[prefix2]/something.
    Since:
    02.12.2019

    • Constructor Summary

      Constructors 
      Constructor Description
      ViewRestLookup​(java.util.Map<java.lang.String,​java.lang.String> prefixes)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String buildRestPath​(java.lang.String subContext, java.lang.String path)  
      java.util.Map<java.lang.String,​java.lang.String> getPrefixes()  
      java.lang.String getPrimaryMapping()  
      java.lang.String lookupRestPrefix​(java.lang.String context)  
      java.lang.String lookupSubContext​(java.lang.String path)
      Lookup target rest context (rest prefix may be registered to sub url).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ViewRestLookup

        public ViewRestLookup​(java.util.Map<java.lang.String,​java.lang.String> prefixes)

    • Method Detail

      • getPrimaryMapping

        public java.lang.String getPrimaryMapping()
        Returns:
        main mapping prefix

      • getPrefixes

        public java.util.Map<java.lang.String,​java.lang.String> getPrefixes()
        Returns:
        configured view rest prefixes

      • lookupSubContext

        public java.lang.String lookupSubContext​(java.lang.String path)
        Lookup target rest context (rest prefix may be registered to sub url). Will select rest prefix context either by sub-url mapping (if url starts with registered sub url) or using root (main) prefix.

        Knowing sub context is important for templates lookup because in case of detected sub context, rest would be "redirected" under this context, but assets must be resolved with a full path (including this context).

        Parameters:
        path - gsp application called url (relative to application mapping root)
        Returns:
        target sub context or empty for root context

      • lookupRestPrefix

        public java.lang.String lookupRestPrefix​(java.lang.String context)
        Parameters:
        context - context (resolved with lookupSubContext(String))
        Returns:
        target rest prefix for provided context

      • buildRestPath

        public java.lang.String buildRestPath​(java.lang.String subContext,
                                      java.lang.String path)
        Parameters:
        subContext - context resolved with lookupSubContext(String)
        path - path to resolve
        Returns:
        target rest prefix for provided context