Skip navigation links

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

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

public class UrlLogic

extends SiteRequestLogic<UrlRequest>

Logic for the UrlCommand

Field Summary

static java.lang.String

DEFAULT_PAGE_NAME default name of a page

Constructor Summary

UrlLogic(ClientApplication clientApplication)

Method Summary

static java.lang.String	createUrlWithPattern(java.lang.String url, java.lang.String urlPattern) Create the URL with the specified pattern
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getContentLink(UrlRequest urlRequest) Create a link to a content item
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getDCPageLink(UrlRequest urlRequest) Create a link to a specific page of a dynamic conversion
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getDCResourceLink(UrlRequest urlRequest) Create a link to a DC resource
protected NamedPageNode	getNamedPageNodeByID(UrlRequest urlRequest, java.lang.String id)
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getNodeLink(UrlRequest urlRequest) Create a node link
protected oracle.stellent.wcm.server.request.url.UrlLogic.PageTemplateMapping	getPageTemplateForDataFile(UrlRequest urlRequest, SectionNode section, ContentID contentID) Determine which page template to use to display the given content ID
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getRenditionLink(UrlRequest urlRequest) Create a link to a rendition
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	getRenditionLink(UrlRequest urlRequest, java.lang.String dDocName, java.lang.String renditionName) Create a link to a rendition
protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder	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	validateSiteRequest(UrlRequest request) Verify the request parameters

Methods inherited from class oracle.stellent.wcm.server.request.SiteRequestLogic

checkSecurity, checkSecurity, getClientApplication, getProject, getProject, getSection, getSection, 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(ClientApplication clientApplication)

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

validateSiteRequest

public void validateSiteRequest(UrlRequest request)
                         throws SiteRequestException

Description copied from class: SiteRequestLogic

Verify the request parameters

Overrides:

validateSiteRequest in class SiteRequestLogic<UrlRequest>

Parameters:

request - the request

Throws:

SiteRequestException - if the parameters are not valid

getUrl

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

Retrieve the URL for the values in this request

Parameters:

urlRequest - the url request

Returns:

the generated url

Throws:

SiteRequestException

getDCPageLink

protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder 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 oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder 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 oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder 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 oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder 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 oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder 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 oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder getContentLink(UrlRequest urlRequest)
                                                                            throws SiteRequestException

Create a link to a content item

Parameters:

urlRequest - the url command

Returns:

a link to a node

Throws:

SiteRequestException

getNodeLink

protected oracle.stellent.wcm.server.request.url.UrlLogic.UrlHolder getNodeLink(UrlRequest urlRequest)
                                                                         throws SiteRequestException

Create a node link

Parameters:

urlRequest - the url command

Returns:

a link to a node

Throws:

SiteRequestException

getNamedPageNodeByID

protected NamedPageNode getNamedPageNodeByID(UrlRequest urlRequest,
                                             java.lang.String id)
                                      throws SiteRequestException

Throws:

SiteRequestException

getSectionByID

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

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:

SiteRequestException

getPageTemplateForDataFile

protected oracle.stellent.wcm.server.request.url.UrlLogic.PageTemplateMapping getPageTemplateForDataFile(UrlRequest urlRequest,
                                                                                                         SectionNode section,
                                                                                                         ContentID contentID)
                                                                                                  throws SiteRequestException

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:

SiteRequestException - if the page template cannot be determined

Skip navigation links