org.springframework.extensions.surf.support

Class ServletLinkBuilder

java.lang.Object

org.springframework.extensions.surf.support.BaseFactoryBean

org.springframework.extensions.surf.support.AbstractLinkBuilder

org.springframework.extensions.surf.support.RequestParameterLinkBuilder

org.springframework.extensions.surf.support.ServletLinkBuilder

All Implemented Interfaces:

LinkBuilder

public class ServletLinkBuilder
extends RequestParameterLinkBuilder

The Servlet implementation of LinkBuilder.

This extends the default builder to provide better page URIs for enhanced search engine optimization.

For references to a page:

• /<pageId>
• /<pageId>?f=<formatId>

For references to a page type:

• /type/<pageTypeId>
• /type/<pageTypeId>?f=<formatId>

For refrences to an object:

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

Author:

muzquiano, David Draper

Field Summary

Fields

Modifier and Type	Field and Description
protected String	objectUri
protected String	pageTypeUri
protected String	pageUri

Constructor Summary

Constructors

Modifier	Constructor and Description
	ServletLinkBuilder(WebFrameworkConfigElement webFrameworkConfigElement, ModelObjectService modelObjectService, ResourceService resourceService) This is the preferred constructor to use when instantiating a PortletLinkBuilder because it allows the services to be set directly.
protected	ServletLinkBuilder(WebFrameworkServiceRegistry serviceRegistry) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
String	object(RequestContext context, String resourceId, 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.
void	setObjectUri(String objectUri) Sets the object uri.
void	setPageTypeUri(String pageTypeUri) Sets the page type uri.
void	setPageUri(String pageUri) Sets the page 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

Field Detail

pageUri

protected String pageUri

pageTypeUri

protected String pageTypeUri

objectUri

protected String objectUri

Constructor Detail

ServletLinkBuilder

protected ServletLinkBuilder(WebFrameworkServiceRegistry serviceRegistry)

Deprecated.

Parameters:

serviceRegistry - WebFrameworkServiceRegistry

ServletLinkBuilder

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

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

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

Method Detail

setPageUri

public void setPageUri(String pageUri)

Sets the page uri.

Parameters:

pageUri - the new page uri

setPageTypeUri

public void setPageTypeUri(String pageTypeUri)

Sets the page type uri.

Parameters:

pageTypeUri - the new page type uri

setObjectUri

public void setObjectUri(String objectUri)

Sets the object uri.

Parameters:

objectUri - the new object uri

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

Overrides:

page in class RequestParameterLinkBuilder

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

Overrides:

pageType in class RequestParameterLinkBuilder

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 resourceId,
            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

Overrides:

object in class RequestParameterLinkBuilder

Parameters:

context - The Request Context instance

resourceId - 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

Overrides:

resource in class RequestParameterLinkBuilder

Parameters:

context - RequestContext

uri - String

Returns:

the