A B C E F G I L M O P R S T U

A

addParameter(String, String, String) - Static method in class org.sakaiproject.portal.util.URLUtils

adjustCssSkinFolder(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Captures the (yes) overly complex rules for the skin folder naming convention

B

BAD_PATH_URL_CHARS - Static variable in class org.sakaiproject.portal.util.URLUtils

The sanitize the req.getPathInfo() information.

BufferedServletResponse - Class in org.sakaiproject.portal.util

ServletResponse instance used to buffer content.

BufferedServletResponse(HttpServletResponse) - Constructor for class org.sakaiproject.portal.util.BufferedServletResponse

Sole Constructor.

ByteArrayServletResponse - Class in org.sakaiproject.portal.util

ServletResponse instance used to buffer content.

ByteArrayServletResponse(HttpServletResponse) - Constructor for class org.sakaiproject.portal.util.ByteArrayServletResponse

Sole Constructor.

C

computeSha1(String) - Static method in class org.sakaiproject.portal.util.ErrorReporter

createActionURL() - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl

createRenderURL() - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl

createResourceURL() - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl

CSSUtils - Class in org.sakaiproject.portal.util

CSSUtils() - Constructor for class org.sakaiproject.portal.util.CSSUtils

E

encodeUrl(String) - Static method in class org.sakaiproject.portal.util.URLUtils

The same behaviour as Web.escapeUrl, only without the "funky encoding" of the characters ?

ErrorReporter - Class in org.sakaiproject.portal.util

ErrorReporter helps with end-user formatted error reporting, user feedback collection, logging and emailing for uncaught throwable based errors.

ErrorReporter() - Constructor for class org.sakaiproject.portal.util.ErrorReporter

F

flushBuffer() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

forwardResponse() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

Forward the request up the chain.

G

getCause(Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Compute the cause of a throwable, checking for the special ServletException case, and the points-to-self case.

getCDNPath() - Method in class org.sakaiproject.portal.util.PortalBean

Returns the CDN Path or empty string (i.e. never null)

getCDNPath() - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns the CDN Path or empty string (i.e. never null)

getCDNQuery() - Method in class org.sakaiproject.portal.util.PortalBean

Returns the CDN query string or empty string (i.e. never null)

getCDNQuery() - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns the CDN query string or empty string (i.e. never null)

getContentType() - Method in class org.sakaiproject.portal.util.BufferedServletResponse

getContentType() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

getCssHead(String, boolean) - Static method in class org.sakaiproject.portal.util.CSSUtils

getCssPortalSkin(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the portal.css suitable for putting in an href= field.

getCssPortalSkinCDN(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the portal.css suitable for putting in an href= field resolved for CDN

getCssPrintSkin(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the print.css suitable for putting in an href= field for media="print".

getCssPrintSkinCDN(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the print.css suitable for putting in an href= field for media="print"

getCssPropertiesSkin(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the properties.css suitable for putting in an href= field.

getCssPropertiesSkinCDN(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the properties.css suitable for putting in an href= field

getCssToolBase() - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the tool_base.css suitable for putting in an href= field.

getCssToolBaseCDN() - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the tool_base.css suitable for putting in an href= fieldresolved for CDN

getCssToolBaseLink(String, boolean) - Static method in class org.sakaiproject.portal.util.CSSUtils

Gets the full CSS link for the tool skin (including print version)

getCssToolSkin(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the tool.css suitable for putting in an href= field.

getCssToolSkinCDN(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Returns a URL for the tool.css suitable for putting in an href= field.

getCssToolSkinLink(String, boolean) - Static method in class org.sakaiproject.portal.util.CSSUtils

getInternalBuffer() - Method in class org.sakaiproject.portal.util.BufferedServletResponse

Retrieve the buffer.

getInternalBuffer() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

Retrieve the buffer.

getLatestJQuery() - Method in class org.sakaiproject.portal.util.PortalBean

Returns the text to intelligently include the latest version of jQuery

getLatestJQueryPath() - Static method in class org.sakaiproject.portal.util.PortalUtils

getLibraryPath() - Method in class org.sakaiproject.portal.util.PortalBean

Returns an absolute URL for "/library" servlet with CDN path as necessary

getLibraryPath() - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns an absolute URL for "/library" servlet with CDN path as necessary

getLocaleString(Locale) - Static method in class org.sakaiproject.portal.util.PortalUtils

getOneTrace(Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Format a one-level stack trace, just showing the place where the exception occurred (the first entry in the stack trace).

getOutputStream() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

getPageForTool(Site, String) - Static method in class org.sakaiproject.portal.util.ToolUtils

Look through the pages in a site and find the page that corresponds to a tool.

getPageUrl(Site, SitePage) - Static method in class org.sakaiproject.portal.util.ToolUtils

Captures the rules for getting the URL of a page suitable for a GET request (call only from the tool)

getPageUrl(HttpServletRequest, Site, SitePage) - Static method in class org.sakaiproject.portal.util.ToolUtils

Captures the rules for getting the URL of a page suitable for a GET request

getPageUrl(HttpServletRequest, Site, SitePage, String) - Static method in class org.sakaiproject.portal.util.ToolUtils

Captures the rules for getting the URL of a page suitable for a GET request

getPageUrl(HttpServletRequest, Site, SitePage, String, boolean, String, String) - Static method in class org.sakaiproject.portal.util.ToolUtils

Captures the rules for getting the URL of a page suitable for a GET request

getPageUrlForTool(HttpServletRequest, Site, ToolConfiguration) - Static method in class org.sakaiproject.portal.util.ToolUtils

Look through the pages in a site and get the page URL for a tool.

getPortalSkinLink(String) - Static method in class org.sakaiproject.portal.util.CSSUtils

Gets the full CSS link for the portal skin

getPortalTermOrder(Set<String>) - Static method in class org.sakaiproject.portal.util.PortalUtils

getRedirect() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

getRequestFromThreadLocal() - Static method in class org.sakaiproject.portal.util.ToolUtils

Get the servlet request from thread local - call only after RequestFilter has run

getRequestParameter(String) - Static method in class org.sakaiproject.portal.util.ToolUtils

Retriece a request parameter from ThreadLocal (only works after RequestFilter runs)

getSafePathInfo(HttpServletRequest) - Static method in class org.sakaiproject.portal.util.URLUtils

getScriptPath() - Method in class org.sakaiproject.portal.util.PortalBean

Returns an absolute for "/library/js" servlet with CDN path as necessary

getScriptPath() - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns an absolute for "/library/js" servlet with CDN path as necessary

getSkinFromSite(Site) - Static method in class org.sakaiproject.portal.util.CSSUtils

Convenience method to retrieve the skin folder from a site

getStackTrace(Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Format the full stack trace.

getToolBaseUrl() - Static method in class org.sakaiproject.portal.util.ToolUtils

Get the base URL for tools not including the ToolId (only works in tools)

getToolBaseUrl(HttpServletRequest) - Static method in class org.sakaiproject.portal.util.ToolUtils

Get the base URL for tools not including the ToolId

getToolBorderlessBaseUrl() - Static method in class org.sakaiproject.portal.util.ToolUtils

Get the base URL for tools with no "border" - (i.e. within an iframe)

getToolPopupUrl(ToolConfiguration) - Static method in class org.sakaiproject.portal.util.ToolUtils

Captures the rules for the various tools and when they want a popup

getWebjarsPath() - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns an absolute for "/library/webjars" with CDN path as necessary

getWriter() - Method in class org.sakaiproject.portal.util.BufferedServletResponse

getWriter() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

I

includeLatestJQuery(String) - Static method in class org.sakaiproject.portal.util.PortalUtils

Returns the text to intelligently include the latest version of jQuery

isCommitted() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

isInlineRequest(HttpServletRequest) - Static method in class org.sakaiproject.portal.util.ToolUtils

Determine if this is an inline request.

isPortletPlacement(Placement) - Static method in class org.sakaiproject.portal.util.ToolUtils

Determine if a particular placement is a JSR-168 portlet placement

L

logAndMail(String, String, String, String, String, String, String, String) - Method in class org.sakaiproject.portal.util.ErrorReporter

Logger and email the error report details.

logAndMail(String, String, String, String, String, String, String, String, String, String) - Method in class org.sakaiproject.portal.util.ErrorReporter

M

MOMENTJS_VERSION - Static variable in class org.sakaiproject.portal.util.PortalUtils

External libraries versions

MyToolURL() - Constructor for class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

O

org.sakaiproject.portal.util - package org.sakaiproject.portal.util

P

parameters - Variable in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

path - Variable in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

PORTAL_INLINE_EXPERIMENTAL - Static variable in class org.sakaiproject.portal.util.ToolUtils

PORTAL_INLINE_EXPERIMENTAL_DEFAULT - Static variable in class org.sakaiproject.portal.util.ToolUtils

PortalBean - Class in org.sakaiproject.portal.util

PortalBean() - Constructor for class org.sakaiproject.portal.util.PortalBean

PortalUtils - Class in org.sakaiproject.portal.util

PortalUtils() - Constructor for class org.sakaiproject.portal.util.PortalUtils

postResponse(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.portal.util.ErrorReporter

Accept the user feedback post.

R

report(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Handle the inital report of an error, from an uncaught throwable, with a user display.

report(HttpServletRequest, HttpServletResponse, Throwable, boolean) - Method in class org.sakaiproject.portal.util.ErrorReporter

reportFragment(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Handle the inital report of an error, from an uncaught throwable, with a user display - but returning a string that contins a fragment.

reset() - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

S

sendRedirect(String) - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

setCaller(String) - Method in class org.sakaiproject.portal.util.PortalBean

setContentLength(int) - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

setContentLengthLong(long) - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

setContentType(String) - Method in class org.sakaiproject.portal.util.ByteArrayServletResponse

setParameter(String, String) - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

setParameter(String, String[]) - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

setParameters(Map) - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

setPath(String) - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

T

thanksResponse(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.portal.util.ErrorReporter

Accept the user feedback post.

throwableDisplay(Throwable) - Method in class org.sakaiproject.portal.util.ErrorReporter

Format a throwable for display: list the various throwables drilling down the cause, and full stacktrack for the final cause.

ToolURLManagerImpl - Class in org.sakaiproject.portal.util

This is a default implementation of the ToolURLManager and it comes with a default implementation of ToolURL for all three URL types (render, action and resource).

ToolURLManagerImpl(HttpServletResponse) - Constructor for class org.sakaiproject.portal.util.ToolURLManagerImpl

Constructor for ToolURLComponent

ToolURLManagerImpl.MyToolURL - Class in org.sakaiproject.portal.util

This is a simple implemention of ToolURL that does the most obvious encoding of URLs.

ToolUtils - Class in org.sakaiproject.portal.util

A set of utilities provided by the portal for use by tools.

ToolUtils() - Constructor for class org.sakaiproject.portal.util.ToolUtils

toString() - Method in class org.sakaiproject.portal.util.ToolURLManagerImpl.MyToolURL

U

URLUtils - Class in org.sakaiproject.portal.util

URLUtils() - Constructor for class org.sakaiproject.portal.util.URLUtils

A B C E F G I L M O P R S T U