org.springframework.extensions.surf.support

Class RequestParameterLinkBuilder

java.lang.Object

org.springframework.extensions.surf.support.BaseFactoryBean

org.springframework.extensions.surf.support.AbstractLinkBuilder

org.springframework.extensions.surf.support.RequestParameterLinkBuilder

All Implemented Interfaces:

LinkBuilder

Direct Known Subclasses:

ServletLinkBuilder

public class RequestParameterLinkBuilder
extends AbstractLinkBuilder

A link builder which supports linking to dispatch state via request parameters.

This provides a very simple, request-parameter driven way of creating URLs. URLs are created according to the following design:

For references to a page:

• ?p=<pageId>
• ?p=<pageId>&f=<formatId>

For references to a page type:

• ?pt=<pageTypeId>
• ?pt=<pageTypeId>&f=<formatId>

For references to an object:

• ?o=<objectId>
• ?o=<objectId>&f=<formatId>

Author:

muzquiano, David Draper

Constructor Summary

Constructors

Modifier	Constructor and Description
	RequestParameterLinkBuilder(WebFrameworkConfigElement webFrameworkConfigElement, ModelObjectService modelObjectService, ResourceService resourceService) This is the preferred constructor to use when instantiating a RequestParameterLinkBuilder because it allows the services to be set directly.
protected	RequestParameterLinkBuilder(WebFrameworkServiceRegistry serviceRegistry) Deprecated. Because it relies on the supplied WebFrameworkServiceRegistry to obtain the required services.

Method Summary

Methods

Modifier and Type	Method and Description
String	object(RequestContext context, String objectId, String formatId, Map<String,String> params) Constructs a link to a given object.
String	page(RequestContext context, String pageId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page for a given format.
String	pageType(RequestContext context, String pageTypeId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page type for a given format.
String	resource(RequestContext context, String uri) Constructs a link to a resources at a given relative uri.

Methods inherited from class org.springframework.extensions.surf.support.AbstractLinkBuilder

object, object, page, page, page, pageType, pageType, pageType

Methods inherited from class org.springframework.extensions.surf.support.BaseFactoryBean

getObjectService, getResourceService, getServiceRegistry, getWebFrameworkConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParameterLinkBuilder

protected RequestParameterLinkBuilder(WebFrameworkServiceRegistry serviceRegistry)

Deprecated. Because it relies on the supplied WebFrameworkServiceRegistry to obtain the required services.

Parameters:

serviceRegistry - WebFrameworkServiceRegistry

RequestParameterLinkBuilder

public RequestParameterLinkBuilder(WebFrameworkConfigElement webFrameworkConfigElement,
                           ModelObjectService modelObjectService,
                           ResourceService resourceService)

This is the preferred constructor to use when instantiating a RequestParameterLinkBuilder because it allows the services to be set directly.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

Method Detail

page

public String page(RequestContext context,
          String pageId,
          String formatId,
          String objectId,
          Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given page for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

page in interface LinkBuilder

Specified by:

page in class AbstractLinkBuilder

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

pageType

public String pageType(RequestContext context,
              String pageTypeId,
              String formatId,
              String objectId,
              Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given page type for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

pageType in interface LinkBuilder

Specified by:

pageType in class AbstractLinkBuilder

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

object

public String object(RequestContext context,
            String objectId,
            String formatId,
            Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given object. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

object in interface LinkBuilder

Specified by:

object in class AbstractLinkBuilder

Parameters:

context - The Request Context instance

objectId - The id of the object

formatId - The id of the format to render

params - A map of name/value pairs to be appended to the URL

resource

public String resource(RequestContext context,
              String uri)

Description copied from interface: LinkBuilder

Constructs a link to a resources at a given relative uri.

Specified by:

resource in interface LinkBuilder

Specified by:

resource in class AbstractLinkBuilder

Parameters:

context - RequestContext

uri - String

Returns:

the