Skip navigation links

oracle.stellent.wcm.server.request.logic.url
Class UrlLogic

java.lang.Object
oracle.stellent.wcm.server.request.logic.RequestLogic<UrlRequest>
oracle.stellent.wcm.server.request.logic.url.UrlLogic

public class UrlLogic

extends RequestLogic<UrlRequest>

Logic for the UrlCommand

Nested Class Summary

protected static class	UrlLogic.PageTemplateMapping
static class	UrlLogic.Url Represents a URL string and a context root

Field Summary

static java.lang.String

DEFAULT_PAGE_NAME default name of a page

Constructor Summary

UrlLogic(ServerContext serverContext)

Method Summary

static java.lang.String	createUrlWithPattern(java.lang.String url, java.lang.String urlPattern) Create the URL with the specified pattern
protected UrlLogic.Url	getContentLink(UrlRequest urlRequest) Create a link to a content item
protected UrlLogic.Url	getDCPageLink(UrlRequest urlRequest) Create a link to a specific page of a dynamic conversion
protected UrlLogic.Url	getDCResourceLink(UrlRequest urlRequest) Create a link to a DC resource
protected UrlLogic.Url	getNodeLink(UrlRequest urlRequest) Create a node link
protected UrlLogic.PageTemplateMapping	getPageTemplateForDataFile(UrlRequest urlRequest, SectionNode section, ContentID contentID) Determine which page template to use to display the given content ID
protected UrlLogic.Url	getRenditionLink(UrlRequest urlRequest) Create a link to a rendition
protected UrlLogic.Url	getRenditionLink(UrlRequest urlRequest, java.lang.String dDocName, java.lang.String renditionName) Create a link to a rendition
protected UrlLogic.Url	getResourceLink(UrlRequest urlRequest) Create a link to a resource
protected SectionNode	getSectionByID(UrlRequest urlRequest, java.lang.String id) Lookup the section, determine if the section is a number or a path
java.lang.String	getUrl(UrlRequest urlRequest) Retrieve the URL for the values in this request
void	validateRequest(UrlRequest request) Verify the request parameters

Methods inherited from class oracle.stellent.wcm.server.request.logic.RequestLogic

checkSecurity, checkSecurity, getProject, getProject, getSection, getSection, getServerContext, getStructure, isSectionAvailable, setRequestSiteID

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_NAME

public static final java.lang.String DEFAULT_PAGE_NAME

default name of a page

See Also:

Constant Field Values

Constructor Detail

UrlLogic

public UrlLogic(ServerContext serverContext)

Method Detail

createUrlWithPattern

public static java.lang.String createUrlWithPattern(java.lang.String url,
                                                    java.lang.String urlPattern)

Create the URL with the specified pattern

Parameters:

url - the url

urlPattern - the pattern

Returns:

the url that matches the given pattern

validateRequest

public void validateRequest(UrlRequest request)
                     throws RequestException

Description copied from class: RequestLogic

Verify the request parameters

Overrides:

validateRequest in class RequestLogic<UrlRequest>

Parameters:

request - the request

Throws:

RequestException - if the parameters are not valid

getUrl

public java.lang.String getUrl(UrlRequest urlRequest)
                        throws RequestException

Retrieve the URL for the values in this request

Parameters:

urlRequest - the url request

Returns:

the generated url

Throws:

RequestException

getDCPageLink

protected UrlLogic.Url getDCPageLink(UrlRequest urlRequest)

Create a link to a specific page of a dynamic conversion

Parameters:

urlRequest - the url command

Returns:

a link to the page

getResourceLink

protected UrlLogic.Url getResourceLink(UrlRequest urlRequest)
                                throws oracle.stellent.ridc.IdcClientException

Create a link to a resource

Parameters:

urlRequest - the url command

Returns:

a link to a resource

Throws:

oracle.stellent.ridc.IdcClientException

getDCResourceLink

protected UrlLogic.Url getDCResourceLink(UrlRequest urlRequest)
                                  throws oracle.stellent.ridc.IdcClientException

Create a link to a DC resource

Parameters:

urlRequest - the url command

Returns:

a link to a resource

Throws:

oracle.stellent.ridc.IdcClientException

getRenditionLink

protected UrlLogic.Url getRenditionLink(UrlRequest urlRequest)
                                 throws oracle.stellent.ridc.IdcClientException

Create a link to a rendition

Parameters:

urlRequest - the url command

Returns:

a link to a rendition

Throws:

oracle.stellent.ridc.IdcClientException

getRenditionLink

protected UrlLogic.Url getRenditionLink(UrlRequest urlRequest,
                                        java.lang.String dDocName,
                                        java.lang.String renditionName)
                                 throws oracle.stellent.ridc.IdcClientException

Create a link to a rendition

Parameters:

urlRequest - the url command

dDocName - the content ID

renditionName - the rendition name

Returns:

a link to a rendition

Throws:

oracle.stellent.ridc.IdcClientException

getContentLink

protected UrlLogic.Url getContentLink(UrlRequest urlRequest)
                               throws RequestException

Create a link to a content item

Parameters:

urlRequest - the url command

Returns:

a link to a node

Throws:

RequestException

getNodeLink

protected UrlLogic.Url getNodeLink(UrlRequest urlRequest)
                            throws RequestException

Create a node link

Parameters:

urlRequest - the url command

Returns:

a link to a node

Throws:

RequestException

getSectionByID

protected SectionNode getSectionByID(UrlRequest urlRequest,
                                     java.lang.String id)
                              throws RequestException

Lookup the section, determine if the section is a number or a path

Parameters:

urlRequest - the url command

id - the section ID or path

Returns:

the section or null if not found

Throws:

RequestException

getPageTemplateForDataFile

protected UrlLogic.PageTemplateMapping getPageTemplateForDataFile(UrlRequest urlRequest,
                                                                  SectionNode section,
                                                                  ContentID contentID)
                                                           throws RequestException

Determine which page template to use to display the given content ID

Parameters:

urlRequest - the url request

section - the section to query

contentID - the content ID of the data file to display

Returns:

the page template mapping object

Throws:

RequestException - if the page template cannot be determined

Skip navigation links