com.fatwire.gst.foundation.url
Class WraPageReference

java.lang.Object
  COM.FutureTense.Export.Reference
      com.openmarket.xcelerate.publish.PageRef
          com.fatwire.gst.foundation.url.WraPageReference

All Implemented Interfaces:

com.fatwire.cs.core.uri.Definition, COM.FutureTense.Interfaces.IReference, com.openmarket.xcelerate.interfaces.IPageRef

Direct Known Subclasses:

VanityPageReference

public class WraPageReference
extends com.openmarket.xcelerate.publish.PageRef

This is the WebReferenceable assets PageRef class. This overrides the default PageRef, so we can manipulate the arguments that go into the assembler while we have database access.

It will alter the input args map by adding the derived parameters

• virtual-webroot
• url-path
• pagename

to the map before calling super.setParameters(args, ics).

This modification is ONLY done when

1. the satellite context is Satellite
2. the app type is Content Server
3. the environment name is set
4. the asset is found
5. the asset has a path set
6. a virtual webroot can be found for the path set and environment name
1. PageRef extends Reference implements IPageRef
2. Reference implements IReference
3. interface IPageRef extends IReference
4. interface IReference extends Definition

Since:

Jun 17, 2010

Author:

Dolf Dijkstra, Tony Field

See Also:

Reference, IReference, Definition

Nested Class Summary

Nested classes/interfaces inherited from interface com.fatwire.cs.core.uri.Definition

com.fatwire.cs.core.uri.Definition.AppType, com.fatwire.cs.core.uri.Definition.ContainerType, com.fatwire.cs.core.uri.Definition.SatelliteContext

Field Summary

static String

GST_DISPATCHER

Fields inherited from class com.openmarket.xcelerate.publish.PageRef

addSession, asset, assetId, assetType, FILE, HTML, isobsolete, maxFileNameLength, mPackedArgs, mPreferredDirName, mPreferredFileName, needsExport, NEEDSEXPORT, oldTemplate, OLDTEMPLATE, PACKALLARGS_PROPNAME, pagename, parentId, rootFolderLength, simpleDir, simpleDirStr, simpleName, simpleNameStr, targetId, wrappagename, WRAPPERPAGE

Fields inherited from class COM.FutureTense.Export.Reference

mBits, mDiskName, mError, mKey, mServletName, mSessionEncode

Fields inherited from interface com.openmarket.xcelerate.interfaces.IPageRef

CACHE_PREFIX

Fields inherited from interface COM.FutureTense.Interfaces.IReference

FAILED, NOT_PROCESSED, PROCESSED, PROCESSING

Fields inherited from interface com.fatwire.cs.core.uri.Definition

LOG_NAME

Constructor Summary

WraPageReference()


Method Summary

protected boolean	requireWraForVanityUrls() Method specifying whether or not vanity URLs are allowed for assets that are just Vanity assets or that have to be full WRA assets.
void	setParameters(Map args, COM.FutureTense.Interfaces.ICS ics)

Methods inherited from class com.openmarket.xcelerate.publish.PageRef

checkPageApproved, getAssetId, getBits, getDiskName, getDiskNameForNoAssetType, getDiskNameForOldTemplate, getDiskNameStandard, getKey, getPagename, getReducedLengthDiskName, init, init, init, isObsolete, log, needsExport, recordPublishKey, sessionEncode, toString

Methods inherited from class COM.FutureTense.Export.Reference

canProcess, createReference, getAppType, getAuthority, getContainerType, getError, getFragment, getKey, getParameter, getParameterNames, getParameters, getParameters, getRawParameters, getSatelliteContext, getScheme, getStatus, isNotProcessed, isProcessing, populate, processed, processingFailed, setAppType, setAuthority, setContainerType, setDiskName, setFailed, setFragment, setProcessed, setProcessing, setSatelliteContext, setScheme, stringFromArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface COM.FutureTense.Interfaces.IReference

canProcess, getError, getStatus, isNotProcessed, isProcessing, populate, processed, processingFailed, setAppType, setAuthority, setContainerType, setDiskName, setFailed, setFragment, setProcessed, setProcessing, setSatelliteContext, setScheme

Methods inherited from interface com.fatwire.cs.core.uri.Definition

getAppType, getAuthority, getContainerType, getFragment, getParameter, getParameterNames, getParameters, getSatelliteContext, getScheme

Field Detail

GST_DISPATCHER

public static final String GST_DISPATCHER

See Also:

Constant Field Values

Constructor Detail

WraPageReference

public WraPageReference()

Method Detail

setParameters

public void setParameters(Map args,
                          COM.FutureTense.Interfaces.ICS ics)
                   throws COM.FutureTense.Export.ReferenceException

Specified by:

setParameters in interface COM.FutureTense.Interfaces.IReference

Overrides:

setParameters in class com.openmarket.xcelerate.publish.PageRef

Throws:

COM.FutureTense.Export.ReferenceException

requireWraForVanityUrls

protected boolean requireWraForVanityUrls()

Method specifying whether or not vanity URLs are allowed for assets that are just Vanity assets or that have to be full WRA assets. This is provided for backward compatibility. Previously, only WRA assets could have vanity URLs, but the requirement has been loosened substantially.

Returns:

true for backward-compatibility - meaning that only WRA assets can have vanity URLs. False if vanity URLs can be assigned to non-WRAs.