Method Detail

• public java.lang.String getContextPath()

  Obtains the context path from which this link generator is operating.

  Returns:

  The base context path

• public java.lang.String getDefaultNamespace(java.lang.String controller, java.lang.String pluginName)

  Resolves the effective namespace to use for a link/redirect that targets the given controller when the caller did not supply an explicit namespace attribute.

  Implementations infer the namespace from the registered controllers so that links generated from controller and action alone "just work" without a namespace attribute. The contract is:

  • If the target controller is the controller currently handling the request, the current request namespace is returned.
  • Otherwise, if exactly one controller has the given name, that controller's namespace is returned (which may be null when that single controller is non-namespaced).
  • Otherwise the name is defined by more than one controller in different namespaces - a discouraged design - so a sensible default is chosen: the non-namespaced controller if one exists, then a controller in the current request namespace; any remaining ambiguity yields null and must be disambiguated by specifying the namespace explicitly.

  Callers must only use this when no explicit namespace attribute was supplied; an explicit namespace (including an explicit blank one) must always take precedence so that namespace="" (or namespace: null) can be used to target a non-namespaced controller.

  When a pluginName is supplied the target lives in a plugin, so cross-controller inference from the application's own controllers is not performed.

  Parameters:

  controller - The logical name of the target controller

  pluginName - The name of the plugin providing the target controller, or null

  Returns:

  The resolved namespace, or null for the default namespace

• public java.lang.String getServerBaseURL()

  The base URL of the server used for creating absolute links.

  Returns:

  The base URL of the server

• public java.lang.String link(@java.lang.SuppressWarnings("rawtypes")
  java.util.Map params)

  Generates a link to a controller, action or URI for the given named parameters. Possible named parameters include:

  • resource - If linking to a REST resource, the name of the resource or resource path to link to. Either 'resource' or 'controller' should be specified, but not both
  • controller - The name of the controller to use in the link, if not specified the current controller will be linked
  • action - The name of the action to use in the link, if not specified the default action will be linked
  • uri - relative URI
  • url - A map containing the action,controller,id etc.
  • base - Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.
  • absolute - If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
  • contextPath - The context path to link to, defaults to the servlet context path
  • id - The id to use in the link
  • fragment - The link fragment (often called anchor tag) to use
  • params - A map containing URL query parameters
  • mapping - The named URL mapping to use to rewrite the link
  • event - Webflow _eventId parameter

  Parameters:

  params - The named parameters

  Returns:

  The generator link

• public java.lang.String link(@java.lang.SuppressWarnings("rawtypes")
  java.util.Map params, java.lang.String encoding)

  Generates a link to a controller, action or URI for the given named parameters. Possible named parameters include:

  • resource - If linking to a REST resource, the name of the resource or resource path to link to. Either 'resource' or 'controller' should be specified, but not both
  • controller - The name of the controller to use in the link, if not specified the current controller will be linked
  • action - The name of the action to use in the link, if not specified the default action will be linked
  • uri - relative URI
  • url - A map containing the action,controller,id etc.
  • base - Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.
  • absolute - If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
  • id - The id to use in the link
  • fragment - The link fragment (often called anchor tag) to use
  • params - A map containing URL query parameters
  • mapping - The named URL mapping to use to rewrite the link
  • event - Webflow _eventId parameter

  Parameters:

  params - The named parameters

  encoding - The character encoding to use

  Returns:

  The generator link

• @java.lang.SuppressWarnings("rawtypes")
  public java.lang.String resolveNamespace(java.lang.String controller, java.lang.String pluginName, java.util.Map attrs)

  Resolves the namespace to pass to reverse URL mapping when a caller may have supplied an explicit namespace attribute.

  An explicit namespace always wins, including an explicit null or blank value. Blank values are normalised to null because reverse mappings key non-namespaced controllers on null. Only when the attribute is absent is getDefaultNamespace(String, String) consulted.

  Parameters:

  controller - The logical name of the target controller

  pluginName - The name of the plugin providing the target controller, or null

  attrs - The attributes that may contain ATTRIBUTE_NAMESPACE

  Returns:

  The explicit or inferred namespace, or null for the default namespace

• public java.lang.String resource(@java.lang.SuppressWarnings("rawtypes")
  java.util.Map params)

  Generates a link to a static resource for the given named parameters. Possible named parameters include:

  • base - The base path of the URL, typically an absolute server path
  • contextPath - The context path to link to, defaults to the servlet context path
  • dir - The directory to link to
  • file - The file to link to (relative to the directory if specified)
  • plugin - The plugin that provides the resource
  • absolute - Whether the link should be absolute or not

  Parameters:

  params - The named parameters

  Returns:

  The link to the static resource