URLRewriter Class

URL rewriter class.

Inheritance Hierarchy

System.Object
  CMS.URLRewritingEngine.URLRewriter

Namespace: CMS.URLRewritingEngine
Assembly: CMS.URLRewritingEngine (in CMS.URLRewritingEngine.dll) Version: 8.2.23

Syntax

public class URLRewriter

The URLRewriter type exposes the following members.

Constructors

	Name	Description
Public method	URLRewriter

Methods

	Name	Description
Protected method	CompleteRequestInternal	Completes request
Public method Static member	DefaultPageBehavior	Gets the default page behavior for given site
Public method Static member	GetEditingUrl	Gets the preview page URL
Public method Static member	GetGoogleSiteMapPath	Returns sitemap node alias path for specific site
Public method Static member	GetGoogleSiteMapURL	Returns sitemap URL for specific site
Public method Static member	GetHandledUrl	Returns the url handled by handler404 page.
Public method Static member	GetLiveUrl	Gets the live page URL
Protected method Static member	GetRelativePathFromUrl	Returns relative path from url. Example: http://www.domain.com/mypage.aspx => /mypage.aspx
Public method Static member	HandleRewriteRedirect	Handles the rewrite redirect of the request
Public method Static member	CheckLicense	Check if license for actual Url is valid.
Protected method	CheckLicenseInternal	Check if license for actual Url is valid.
Public method Static member	CheckPublishedState	Checks the published state of the document. If the document is not published and combine with default culture is enabled and default culture is published, default culture is returned. If no published version is found, the page info is set to null.
Public method Static member	PageNotFound	Returns the page not found error or redirects to the page not found page
Public method Static member	PageNotFoundForNonPublished	Returns true if the non published documents should return page not found result.
Public method Static member	PerformPlannedRedirect	Performs the redirect that was previously planned by URL rewriter
Public method Static member	ProcessABTest(String, ViewModeEnum, PageInfo)	Returns current page info with dependence on A/B test settings.
Public method Static member	ProcessABTest(String, ViewModeEnum, PageInfo, UrlRewritingAction, String, String)	Obsolete. Returns current page info with dependence on A/B test settings.
Public method Static member	ProcessPageTemplate	Obsolete. Processes the page template and returns file name to rewrite to, if returning file name is null, no rewriting should occur and was handled internally
Public method Static member	ProcessRewritingAction	Processes the given rewriting action.
Public method Static member	ProcessRewritingResult(URLRewritingParams)	Processes the result of URL rewriting and handlers appropriate actions
Public method Static member	ProcessRewritingResult(RequestStatusEnum, ExcludedSystemEnum, SiteNameOnDemand, ViewModeOnDemand, String)	Processes the result of URL rewriting and handlers appropriate actions
Protected method	RedirectInternal	Redirects the response using specified URL (302 HTTP status code).
Protected method	RedirectPermanentInternal	Redirects the response using specified URL using permanent redirection using 301.
Public method Static member	RedirectToMainUrl	Redirects the page to its main URL.
Public method Static member	RewritePath	Rewrites the path by using the given file path and query string.
Protected method	RewritePathInternal(String)	Rewrites the URL by using the given path
Protected method	RewritePathInternal(String, Boolean)	Rewrites the URL by using the given path
Protected method	RewritePathWithoutClearCachedUrlValuesInternal	Rewrites the URL by using the given path, path information and query string information, without clearing the cached values related to URL of the request
Public method Static member	RewriteUrl(RequestStatusEnum, String, ExcludedSystemEnum)	Rewrites the URL and performs all operations required after URL rewriting.
Protected method Static member	RewriteUrl(String, ExcludedSystemEnum, SiteNameOnDemand, ViewModeOnDemand)	Applies rewriting to actual URL.
Public method Static member	SendOutputFromCache	Attempts to send the output of the page from the cache.
Public method Static member	SetViewMode	Sets the viewmode if viewmode parameter present in current request parameters.
Protected method	TransferPageNotFoundInternal	Transfer page not found request
Public method Static member	UseDomainForCulture	Gets the value that indicates whether domain should be used for culture
Public method Static member	ValidateCulture	Validates the culture value.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	CacheItemPriority	Cache item priority.
Public field Static member	PREFIX_CMS_GETATTACHMENT	GetAttachment prefix for CMS pages (pages which require authentication).
Public field Static member	PREFIX_CMS_GETDOC	GetDoc prefix for CMS pages (pages which require authentication).
Public field Static member	PREFIX_CMS_GETFILE	GetFile prefix for CMS pages (pages which require authentication).
Public field Static member	PREFIX_GETATTACHMENT	GetAttachment prefix.
Public field Static member	PREFIX_GETFILE	GetFile prefix.

Properties

	Name	Description
Public property Static member	FixRewriteRedirect	If true, the URL rewriting process attempts to fix the redirect that some module did with wrong URL by another redirect with the original URL. Set true when using cookieless mode. Default is false.
Protected property Static member	ProviderObject	Provider object.
Public property Static member	RedirectLangParameterToPrefix	Gets the value that indicates whether URL with lang prefix should be redirected to the culture prefix if culture prefix is enabled for current site
Public property Static member	UseDomainRedirectForFiles	Indicates whether domain redirect should be used for file request (getattachment, getmediafile, getmetafile, etc)
Public property Static member	UseDomaiRedirectForFiles	Obsolete. Indicates whether domain redirect should be used for file request (getattachment, getmediafile, getmetafile, etc)