Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X 

A

AbstractPortlet - Class in org.jgrapes.portal.base
Provides a base class for implementing portlet components.
AbstractPortlet(Channel, boolean) - Constructor for class org.jgrapes.portal.base.AbstractPortlet
Creates a new component that listens for new events on the given channel.
AbstractPortlet(Channel, HandlerDefinition.ChannelReplacements, boolean) - Constructor for class org.jgrapes.portal.base.AbstractPortlet
Like AbstractPortlet.AbstractPortlet(Channel, boolean), but supports the specification of channel replacements.
AbstractPortlet.PortletBaseModel - Class in org.jgrapes.portal.base
Defines the portlet model following the JavaBean conventions.
AbstractPortlet.RenderPortletFromReader - Class in org.jgrapes.portal.base
Send to the portal page for adding or updating a complete portlet representation.
addCss(URI) - Method in class org.jgrapes.portal.base.events.AddPageResources
Add the URI of a CSS resource that is to be added to the header section of the portal page.
addCss(RenderSupport, URI) - Method in class org.jgrapes.portal.base.events.AddPortletType
Add the URI of a CSS resource that is to be added to the header section of the portal page.
addOption(String, Object) - Method in class org.jgrapes.portal.base.events.DisplayNotification
Adds an option to the event.
AddPageResources - Class in org.jgrapes.portal.base.events
Adds <link ...
AddPageResources() - Constructor for class org.jgrapes.portal.base.events.AddPageResources
 
AddPageResources.ScriptResource - Class in org.jgrapes.portal.base.events
Represents a script resource that is to be loaded or evaluated by the browser.
AddPortletRequest - Class in org.jgrapes.portal.base.events
Sent to the portal (server) if a new portlet instance of a given type should be added to the portal page.
AddPortletRequest(RenderSupport, String, Portlet.RenderMode) - Constructor for class org.jgrapes.portal.base.events.AddPortletRequest
Creates a new event.
AddPortletRequest(RenderSupport, String, Portlet.RenderMode, Map<?, ?>) - Constructor for class org.jgrapes.portal.base.events.AddPortletRequest
Creates a new event.
AddPortletType - Class in org.jgrapes.portal.base.events
Adds a portlet type with its global resources (JavaScript and/or CSS) to the portal page.
AddPortletType(String) - Constructor for class org.jgrapes.portal.base.events.AddPortletType
Create a new event for the given portlet type.
addPreference(Object, Object) - Method in class org.jgrapes.portal.base.events.UpdatePortletModel
Convenience method for adding properties one-by-one.
addProperty(Object, Object) - Method in class org.jgrapes.portal.base.events.AddPortletRequest
Convenience method for adding properties one-by-one.
addScript(AddPageResources.ScriptResource) - Method in class org.jgrapes.portal.base.events.AddPortletType
Add a script resource to be requested by the browser.
addScriptResource(AddPageResources.ScriptResource) - Method in class org.jgrapes.portal.base.events.AddPageResources
Add the URI of a JavaScript resource that is to be added to the header section of the portal page.
addSupportedMode(Portlet.RenderMode) - Method in class org.jgrapes.portal.base.events.RenderPortlet
Add the given render mode to the supported render modes.
afterOnClosed(Closed, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Invoked by AbstractPortlet.onClosed(Closed, PortalSession) after the portal session has been removed from the set of tracked sessions.
asSet(Portlet.RenderMode...) - Static method in enum org.jgrapes.portal.base.Portlet.RenderMode
Utility method that creates a Set of render modes from anumerated values.

B

Bootstrap4Weblet - Class in org.jgrapes.portal.bootstrap4
Provides resources using Request/Response events.
Bootstrap4Weblet(Channel, Channel, URI) - Constructor for class org.jgrapes.portal.bootstrap4.Bootstrap4Weblet
Instantiates a new Bootstrap 3 UI weblet.
browserSession() - Method in class org.jgrapes.portal.base.PortalSession
 
byPortal(Portal) - Static method in class org.jgrapes.portal.base.PortalSession
Return all sessions that belong to the given portal as a new unmodifiable set.

C

ChartJsProvider - Class in org.jgrapes.portal.providers.chartjs
Provider for the Chart.js library.
ChartJsProvider(Channel) - Constructor for class org.jgrapes.portal.providers.chartjs.ChartJsProvider
Creates a new component with its channel set to the given channel.
ChartJsProviderFactory - Class in org.jgrapes.portal.providers.chartjs
A factory for creating ChartJsProviders.
ChartJsProviderFactory() - Constructor for class org.jgrapes.portal.providers.chartjs.ChartJsProviderFactory
 
close() - Method in class org.jgrapes.portal.base.WebSocketInputReader
Forward the close to the JSON decoder.
compareTo(JQueryUiWeblet.ThemeInfo) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet.ThemeInfo
 
componentType() - Method in class org.jgrapes.portal.providers.chartjs.ChartJsProviderFactory
 
componentType() - Method in class org.jgrapes.portal.providers.datatables.DatatablesProviderFactory
 
componentType() - Method in class org.jgrapes.portal.providers.fontawesome.FontAwesomeProviderFactory
 
componentType() - Method in class org.jgrapes.portal.providers.markdownit.MarkdownItProviderFactory
 
componentType() - Method in class org.jgrapes.portal.providers.vuejs.VueJsProviderFactory
 
componentType() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortletFactory
 
componentType() - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortletFactory
 
content() - Method in class org.jgrapes.portal.base.AbstractPortlet.RenderPortletFromReader
 
content() - Method in class org.jgrapes.portal.base.events.DisplayNotification
Returns the content.
content() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Provides the HTML that displays the portlet on the page.
content() - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet.RenderPortletFromTemplate
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portal.providers.chartjs.ChartJsProviderFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portal.providers.datatables.DatatablesProviderFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portal.providers.fontawesome.FontAwesomeProviderFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portal.providers.markdownit.MarkdownItProviderFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portal.providers.vuejs.VueJsProviderFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortletFactory
 
create(Channel, Map<Object, Object>) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortletFactory
 
createPortalBaseModel() - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Creates the portal base model.
createPortalBaseModel() - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
 
cssSource() - Method in class org.jgrapes.portal.base.events.AddPageResources
 
cssUris() - Method in class org.jgrapes.portal.base.events.AddPageResources
Return all CSS URIs.
cssUris() - Method in class org.jgrapes.portal.base.events.AddPortletType
Return all CSS URIs.

D

DatatablesProvider - Class in org.jgrapes.portal.providers.datatables
Provider for the Datatables library.
DatatablesProvider(Channel, Map<Object, Object>) - Constructor for class org.jgrapes.portal.providers.datatables.DatatablesProvider
Creates a new component with its channel set to the given channel.
DatatablesProviderFactory - Class in org.jgrapes.portal.providers.datatables
A factory for creating DatatablesProviders.
DatatablesProviderFactory() - Constructor for class org.jgrapes.portal.providers.datatables.DatatablesProviderFactory
 
DELETABLE - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Boolean property that controls if the preview is deletable.
DeletePortlet - Class in org.jgrapes.portal.base.events
A notification (as defined by the JSON RPC specification) to be sent to the portlet view (the browser).
DeletePortlet(String) - Constructor for class org.jgrapes.portal.base.events.DeletePortlet
Creates a new event.
DeletePortletRequest - Class in org.jgrapes.portal.base.events
A request to delete a portlet instance.
DeletePortletRequest(RenderSupport, String) - Constructor for class org.jgrapes.portal.base.events.DeletePortletRequest
Creates a new event.
discard() - Method in class org.jgrapes.portal.base.PortalSession
Discards this session.
displayName() - Method in class org.jgrapes.portal.base.events.AddPortletType
Return the display name.
DisplayNotification - Class in org.jgrapes.portal.base.events
Causes a notification to be display on the top of the portal page.
DisplayNotification(String, Map<String, Object>) - Constructor for class org.jgrapes.portal.base.events.DisplayNotification
Creates a new event.
DisplayNotification(String) - Constructor for class org.jgrapes.portal.base.events.DisplayNotification
Creates a new event without any options.
doAddPortlet(AddPortletRequest, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
doAddPortlet(AddPortletRequest, PortalSession) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Adds the portlet to the portal.
doAddPortlet(AddPortletRequest, PortalSession) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 
doDeletePortlet(DeletePortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portal.base.AbstractPortlet
doDeletePortlet(DeletePortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
 
doDeletePortlet(DeletePortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 
doGetResource(PortletResourceRequest, IOSubchannel) - Method in class org.jgrapes.portal.base.AbstractPortlet
The default implementation searches for a file with the requested resource URI in the portlet’s class path and sets its URL as result if found.
doGetResource(PortletResourceRequest, IOSubchannel) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Checks if the path of the requested resource ends with *.ftl.
doNotifyPortletModel(NotifyPortletModel, PortalSession, Serializable) - Method in class org.jgrapes.portal.base.AbstractPortlet
doNotifyPortletModel(NotifyPortletModel, PortalSession, Serializable) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
 
doNotifyPortletModel(NotifyPortletModel, PortalSession, Serializable) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 
doRenderPortlet(RenderPortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portal.base.AbstractPortlet
doRenderPortlet(RenderPortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
 
doRenderPortlet(RenderPortletRequest, PortalSession, String, Serializable) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 

E

EDITABLE_BY - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Property of type Set<Principal> for restricting who can edit the content.
equals(Object) - Method in class org.jgrapes.portal.base.AbstractPortlet.PortletBaseModel
Two objects are equal if they have equal portlet ids.
expandPortalModel(Map<String, Object>, Request.In.Get, UUID) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Expand the given portal model with data from the event (portal session id, locale information).
expiresAt() - Method in class org.jgrapes.portal.base.PortalSession
Returns the time when this session will expire.

F

fmModel(RenderPortletRequestBase<?>, PortalSession, AbstractPortlet.PortletBaseModel) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
fmPortletModel(RenderPortletRequestBase<?>, IOSubchannel, AbstractPortlet.PortletBaseModel) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Build a freemarker model for the current request.
fmSessionModel(Session) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Build a freemarker model holding the information associated with the session.
fmTypeModel(RenderSupport) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Creates the request independent part of the freemarker model.
FontAwesomeProvider - Class in org.jgrapes.portal.providers.fontawesome
Provider for the Font Awesome.
FontAwesomeProvider(Channel) - Constructor for class org.jgrapes.portal.providers.fontawesome.FontAwesomeProvider
Creates a new component with its channel set to the given channel.
FontAwesomeProviderFactory - Class in org.jgrapes.portal.providers.fontawesome
A factory for creating FontAwesomeProviders.
FontAwesomeProviderFactory() - Constructor for class org.jgrapes.portal.providers.fontawesome.FontAwesomeProviderFactory
 
freeMarkerConfig - Variable in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Initialized with a base FreeMarker configuration.
freemarkerConfig() - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Create the base freemarker configuration.
FreeMarkerPortalWeblet - Class in org.jgrapes.portal.base.freemarker
 
FreeMarkerPortalWeblet(Channel, Channel, URI) - Constructor for class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Instantiates a new free marker portal weblet.
FreeMarkerPortalWeblet.LanguageInfo - Class in org.jgrapes.portal.base.freemarker
Holds the information about the selected language.
FreeMarkerPortlet - Class in org.jgrapes.portal.base.freemarker
 
FreeMarkerPortlet(Channel, boolean) - Constructor for class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Creates a new component that listens for new events on the given channel.
FreeMarkerPortlet(Channel, HandlerDefinition.ChannelReplacements, boolean) - Constructor for class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet
Like FreeMarkerPortlet.FreeMarkerPortlet(Channel, boolean), but supports the specification of channel replacements.
FreeMarkerPortlet.RenderPortletFromTemplate - Class in org.jgrapes.portal.base.freemarker
Specifies how to render portlet content using a template.

G

generatePortletId() - Method in class org.jgrapes.portal.base.AbstractPortlet
Generates a new unique portlet id.
generatePortletId() - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 
get() - Method in class org.jgrapes.portal.base.StylingInfo
Returns the styling information.
getChannel() - Method in class org.jgrapes.portal.base.Portal.PortalMXBean.PortalSessionInfo
 
getComponentPath() - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
getComponentPath() - Method in interface org.jgrapes.portal.base.Portal.PortalMXBean
 
getEditableBy() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
getExpiresAt() - Method in class org.jgrapes.portal.base.Portal.PortalMXBean.PortalSessionInfo
 
getFallbackLocale(String, Locale) - Method in class org.jgrapes.portal.base.PortalResourceBundleControl
Returns null (no fallback).
getFormats(String) - Method in class org.jgrapes.portal.base.PortalResourceBundleControl
 
getKeys() - Method in class org.jgrapes.portal.base.PortalResourceBundle
 
getLabel() - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet.LanguageInfo
Gets the label.
getLocale() - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet.LanguageInfo
Gets the locale.
getName() - Method in interface org.jgrapes.portal.base.UserPrincipal
 
getPortals() - Method in interface org.jgrapes.portal.base.Portal.PortalSummaryMXBean
 
getPortalSessions() - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
getPortalSessions() - Method in interface org.jgrapes.portal.base.Portal.PortalMXBean
 
getPortletId() - Method in class org.jgrapes.portal.base.AbstractPortlet.PortletBaseModel
Returns the portlet id.
getPrefix() - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
getPrefix() - Method in interface org.jgrapes.portal.base.Portal.PortalMXBean
 
getPreviewContent() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
getRealm() - Method in interface org.jgrapes.portal.base.UserPrincipal
Returns the authentication realm.
getResource(String) - Method in class org.jgrapes.portal.jqueryui.ThemeProvider
Find the requested resource.
getScriptId() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Gets the script id (defaults to no id).
getScriptType() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Gets the script type (defaults to no type).
getTitle() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
getViewContent() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 

H

handleGetObject(String) - Method in class org.jgrapes.portal.base.PortalResourceBundle
 
hasBeenRendered() - Method in class org.jgrapes.portal.base.events.RenderPortletRequest
Checks if the portlet has been rendered (i.e. the event has been handled).
hashCode() - Method in class org.jgrapes.portal.base.AbstractPortlet.PortletBaseModel
 
httpChannel() - Method in class org.jgrapes.portal.base.events.ResourceRequest
 
httpRequest() - Method in class org.jgrapes.portal.base.events.ResourceRequest
Returns the “raw” request as provided by the HTTP decoder.

I

id() - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet.ThemeInfo
Returns the id.
ifModifiedSince() - Method in class org.jgrapes.portal.base.events.ResourceRequest
If not null, this value may be used to decide if the resource must be refreshed.
ifPresent(Object, BiConsumer<Object, Object>) - Method in class org.jgrapes.portal.base.events.AddPortletRequest
Convenience method that performs the given action if a property with the given key exists.
ifPresent(Object, BiConsumer<Object, Object>) - Method in class org.jgrapes.portal.base.events.UpdatePortletModel
Convenience method that performs the given action if a property with the given key exists.
isConnected() - Method in class org.jgrapes.portal.base.PortalSession
Checks if a network connection with the browser exists.
isDeletable() - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
isForeground() - Method in class org.jgrapes.portal.base.events.AddPortletRequest
 
isForeground() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Indicates if portelt is to be put in foreground.
isForeground() - Method in class org.jgrapes.portal.base.events.RenderPortletRequest
 
isForeground() - Method in class org.jgrapes.portal.base.events.RenderPortletRequestBase
Indicates if portlet is to be put in foreground.
isInstantiable() - Method in class org.jgrapes.portal.base.events.AddPortletType
Return if the portelt is instantiable.
isoEncode(String) - Static method in class org.jgrapes.portal.base.PortalUtils
Returns URLEncoder.encode(value, "ISO-8859-1").
isStale() - Method in class org.jgrapes.portal.base.PortalSession
Checks if the portal session has become stale (inactive).
isUseMinifiedResources() - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
isUseMinifiedResources() - Method in interface org.jgrapes.portal.base.Portal.PortalMXBean
 

J

JQueryUiWeblet - Class in org.jgrapes.portal.jqueryui
Provides resources using Request/Response events.
JQueryUiWeblet(Channel, Channel, URI) - Constructor for class org.jgrapes.portal.jqueryui.JQueryUiWeblet
Instantiates a new jQuery UI weblet.
JQueryUiWeblet.ThemeInfo - Class in org.jgrapes.portal.jqueryui
Holds the information about a theme.
JsonInput - Class in org.jgrapes.portal.base.events
A JSON notification from the portal view (browser) to the portal.
JsonInput(JsonRpc) - Constructor for class org.jgrapes.portal.base.events.JsonInput
Create a new request from the given data.

K

KVStoreBasedPortalPolicy - Class in org.jgrapes.portal.base
A component that restores the portal layout, using key/value events for persisting the data between sessions.
KVStoreBasedPortalPolicy() - Constructor for class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Creates a new component with its channel set to itself.
KVStoreBasedPortalPolicy(Channel) - Constructor for class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Creates a new component with its channel set to the given channel.

L

LanguageInfo(Locale) - Constructor for class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet.LanguageInfo
Instantiates a new language info.
LastPortalLayout - Class in org.jgrapes.portal.base.events
Sent by the server to the browser in response to PortalPrepared (see this event’s description for details).
LastPortalLayout(List<String>, List<String>, JsonObject) - Constructor for class org.jgrapes.portal.base.events.LastPortalLayout
 
loadScriptSource(Reader) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Loads the script source to evaluate.
locale() - Method in class org.jgrapes.portal.base.events.SetLocale
Returns the locale to set.
locale() - Method in class org.jgrapes.portal.base.PortalSession
Return the portal session’s locale.

M

MarkdownDisplayModel(String) - Constructor for class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
Creates a new model with the given type and id.
MarkdownDisplayPortlet - Class in org.jgrapes.portlets.markdowndisplay
A portlet used to display information to the user.
MarkdownDisplayPortlet(Channel) - Constructor for class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Creates a new component with its channel set to the given channel.
MarkdownDisplayPortlet.MarkdownDisplayModel - Class in org.jgrapes.portlets.markdowndisplay
The portlet’s model.
MarkdownDisplayPortletFactory - Class in org.jgrapes.portlets.markdowndisplay
A factory for creating MarkdownDisplayPortlets.
MarkdownDisplayPortletFactory() - Constructor for class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortletFactory
 
MarkdownItProvider - Class in org.jgrapes.portal.providers.markdownit
A provider for the Markdownit library.
MarkdownItProvider(Channel) - Constructor for class org.jgrapes.portal.providers.markdownit.MarkdownItProvider
Creates a new component with its channel set to the given channel.
MarkdownItProviderFactory - Class in org.jgrapes.portal.providers.markdownit
A factory for creating MarkdownItProviders.
MarkdownItProviderFactory() - Constructor for class org.jgrapes.portal.providers.markdownit.MarkdownItProviderFactory
 
mergeQuery(URI, Map<String, String>) - Static method in class org.jgrapes.portal.base.PortalUtils
Merge query parameters into an existing URI.
method() - Method in class org.jgrapes.portal.base.events.NotifyPortletModel
Returns the method.
method() - Method in class org.jgrapes.portal.base.events.NotifyPortletView
Returns the method to be executed.

N

name() - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet.ThemeInfo
Returns the name.
newBundle(String, Locale, String, ClassLoader, boolean) - Method in class org.jgrapes.portal.base.PortalResourceBundleControl
Creates a new resource bundle using the classes passed to the constructor and the base name.
NotifyPortletModel - Class in org.jgrapes.portal.base.events
A decoded notification (as defined by the JSON RPC specification) that invokes a method on a portlet model.
NotifyPortletModel(RenderSupport, String, String, JsonArray) - Constructor for class org.jgrapes.portal.base.events.NotifyPortletModel
Creates a new event.
NotifyPortletView - Class in org.jgrapes.portal.base.events
A notification (as defined by the JSON RPC specification) to be sent to the portlet view (the browser).
NotifyPortletView(String, String, String, Object...) - Constructor for class org.jgrapes.portal.base.events.NotifyPortletView
Creates a new event.

O

onAddPortletRequest(AddPortletRequest, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Checks if the request applies to this component.
onClosed(Closed, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Removes the PortalSession from the set of tracked sessions.
onClosed(Closed, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Handles the closed event from the web socket.
onDeletePortletRequest(DeletePortletRequest, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Checks if the request applies to this component.
onGet(Request.In.Get, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Handle the GET requests for the various resources.
onGetRedirect(Request.In.Get, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Redirects GET requests without trailing slash.
onInput(Input<CharBuffer>, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Handles network input (JSON data).
onJsonInput(JsonInput, PortalSession) - Method in class org.jgrapes.portal.base.Portal
Handle JSON input.
onJsonInput(JsonInput, PortalSession) - Method in class org.jgrapes.portal.base.PortalLocalBackedKVStore
Evaluate “retrievedLocalData” response.
onJsonInput(JsonInput, PortalSession) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
Handle JSON input.
onKeyValueStoreData(KeyValueStoreData, PortalSession) - Method in class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Handle returned data.
onKeyValueStoreData(KeyValueStoreData, PortalSession) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Restore portlet information, if contained in the event.
onKeyValueStoreQuery(KeyValueStoreQuery, PortalSession) - Method in class org.jgrapes.portal.base.PortalLocalBackedKVStore
Handle data query..
onKeyValueStoreUpdate(KeyValueStoreUpdate, PortalSession) - Method in class org.jgrapes.portal.base.PortalLocalBackedKVStore
Handle data update events.
onNotifyPortletModel(NotifyPortletModel, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Checks if the request applies to this component by calling AbstractPortlet.stateFromSession(Session, String, Class).
onPortalCommand(PortalCommand, PortalSession) - Method in class org.jgrapes.portal.base.PortalWeblet
Sends a command to the portal.
onPortalConfigured(PortalConfigured, PortalSession) - Method in class org.jgrapes.portal.base.Portal
Handle network configured condition.
onPortalLayoutChanged(PortalLayoutChanged, PortalSession) - Method in class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Handle changed layout.
onPortalPrepared(PortalPrepared, PortalSession) - Method in class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Handle portal page loaded.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.base.KVStoreBasedPortalPolicy
Intercept the PortalReady event.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.base.PortalLocalBackedKVStore
Intercept PortalReady event to first get data.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.base.PortalWeblet
Handles the PortalReady event.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.providers.chartjs.ChartJsProvider
On PortalReady, fire the appropriate AddPageResources.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.providers.datatables.DatatablesProvider
On PortalReady, fire the appropriate AddPageResources.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.providers.fontawesome.FontAwesomeProvider
On PortalReady, fire the appropriate AddPageResources.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.providers.markdownit.MarkdownItProvider
On PortalReady, fire the appropriate AddPageResources.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portal.providers.vuejs.VueJsProvider
On PortalReady, fire the appropriate AddPageResources.
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
onPortalReady(PortalReady, PortalSession) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
onRenderPortlet(RenderPortletRequest, PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Checks if the request applies to this component by calling AbstractPortlet.stateFromSession(Session, String, Class).
onRenderPortlet(RenderPortletRequest, PortalSession) - Method in class org.jgrapes.portal.base.Portal
Fallback handler that sends a DeletePortlet event if the RenderPortletRequest event has not been handled successfully.
onResourceRequest(PortletResourceRequest, IOSubchannel) - Method in class org.jgrapes.portal.base.AbstractPortlet
A default handler for resource requests.
onResourceRequest(PageResourceRequest, IOSubchannel) - Method in class org.jgrapes.portal.base.PageResourceProvider
A default handler for resource requests.
onResourceRequestCompleted(ResourceRequestCompleted, PortalWeblet.PortalResourceChannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Handles the ResourceRequestCompleted event.
onSetLocale(SetLocale, PortalSession) - Method in class org.jgrapes.portal.base.PortalWeblet
Handles a change of Locale.
onSetTheme(SetTheme, PortalSession) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
Handles a change of theme.
onStop(Stop) - Method in class org.jgrapes.portal.base.Portal
Discard all portal sessions on stop.
onUpdate(SysInfoPortlet.Update, PortalSession) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
Handle the periodic update event by sending NotifyPortletView events.
onUpdatePortletModel(UpdatePortletModel, PortalSession) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Stores the modified properties using a KeyValueStoreUpdate event and updates the view with a NotifyPortletView.
onUpgraded(Upgraded, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Called when the connection has been upgraded.
options() - Method in class org.jgrapes.portal.base.events.DisplayNotification
Return the options.
org.jgrapes.portal.base - package org.jgrapes.portal.base
Provides the components for building a portal based on the core, io and http packages.
org.jgrapes.portal.base.events - package org.jgrapes.portal.base.events
The events used by the portal related components.
org.jgrapes.portal.base.freemarker - package org.jgrapes.portal.base.freemarker
Classes for implementing a freemarker based portlet.
org.jgrapes.portal.bootstrap4 - package org.jgrapes.portal.bootstrap4
Provides a portal weblet that implements the portal page using the Bootstrap 4 framework.
org.jgrapes.portal.jqueryui - package org.jgrapes.portal.jqueryui
Provides a portal weblet that implements the portal page using the JQuery UI framework.
org.jgrapes.portal.jqueryui.events - package org.jgrapes.portal.jqueryui.events
The events used by the jQuery UI portal.
org.jgrapes.portal.jqueryui.themes.base - package org.jgrapes.portal.jqueryui.themes.base
The base theme for the portal.
org.jgrapes.portal.providers.chartjs - package org.jgrapes.portal.providers.chartjs
Provides a component for adding the Chart.js library to a portal.
org.jgrapes.portal.providers.datatables - package org.jgrapes.portal.providers.datatables
Provides a component for adding the datatables library to a portal.
org.jgrapes.portal.providers.fontawesome - package org.jgrapes.portal.providers.fontawesome
Provides a component for adding the Fontawesome free web font to a portal.
org.jgrapes.portal.providers.markdownit - package org.jgrapes.portal.providers.markdownit
Provides a component for adding the markdownit library to a portal.
org.jgrapes.portal.providers.vuejs - package org.jgrapes.portal.providers.vuejs
Provides a component for adding the vue.js library to a portal.
org.jgrapes.portlets.markdowndisplay - package org.jgrapes.portlets.markdowndisplay
A portlet component for displaying markdown text in a portal.
org.jgrapes.portlets.sysinfo - package org.jgrapes.portlets.sysinfo
A portlet component for displaying system information in a portal.

P

pageResource(URI) - Method in interface org.jgrapes.portal.base.RenderSupport
Create a reference to a resource provided by a page resource provider.
pageResource(String) - Method in interface org.jgrapes.portal.base.RenderSupport
Convenience method that converts the path to an URI before calling RenderSupport.pageResource(URI).
PageResourceProvider - Class in org.jgrapes.portal.base
Base class for implementing components that add resources to the <HEAD> section of the portal page.
PageResourceProvider(Channel) - Constructor for class org.jgrapes.portal.base.PageResourceProvider
Creates a new component.
PageResourceProviderFactory - Interface in org.jgrapes.portal.base
A factory interface for PageResourceProvider components.
PageResourceRequest - Class in org.jgrapes.portal.base.events
An event that signals the request of a resource that is to be added to the <HEAD> section of the page.
PageResourceRequest(URI, Instant, HttpRequest, IOSubchannel, Session, RenderSupport) - Constructor for class org.jgrapes.portal.base.events.PageResourceRequest
Creates a new request.
params() - Method in class org.jgrapes.portal.base.events.NotifyPortletModel
Returns the parameters.
params() - Method in class org.jgrapes.portal.base.events.NotifyPortletView
Returns the parameters.
Portal - Class in org.jgrapes.portal.base
Provides the portlet related part of the portal.
portal() - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
portal() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the automatically generated Portal component.
Portal.PortalInfo - Class in org.jgrapes.portal.base
 
Portal.PortalMXBean - Interface in org.jgrapes.portal.base
The MBeans view of a portal.
Portal.PortalMXBean.PortalSessionInfo - Class in org.jgrapes.portal.base
 
Portal.PortalSummaryMXBean - Interface in org.jgrapes.portal.base
An MBean interface for getting information about all portals.
portalBaseResource(URI) - Method in interface org.jgrapes.portal.base.RenderSupport
Returns the portal library URI.
portalBaseResource(String) - Method in interface org.jgrapes.portal.base.RenderSupport
Convenience method that converts the path to an URI before calling RenderSupport.portalBaseResource(URI).
PortalChannel() - Constructor for class org.jgrapes.portal.base.PortalWeblet.PortalChannel
 
PortalCommand - Class in org.jgrapes.portal.base.events
Events derived from this class are transformed to JSON messages that are sent to the portal session.
PortalCommand() - Constructor for class org.jgrapes.portal.base.events.PortalCommand
 
PortalConfigured - Class in org.jgrapes.portal.base.events
This event is the completed event for the PortalPrepared event.
PortalConfigured(PortalPrepared, Channel...) - Constructor for class org.jgrapes.portal.base.events.PortalConfigured
Instantiates a new event.
portalHierarchy() - Method in class org.jgrapes.portal.base.PortalWeblet
Return the list of classes that form the current portal weblet implementation.
PortalInfo(Portal) - Constructor for class org.jgrapes.portal.base.Portal.PortalInfo
 
PortalLayoutChanged - Class in org.jgrapes.portal.base.events
Notifies the server about a change of the portal layout.
PortalLayoutChanged(List<String>, List<String>, JsonObject) - Constructor for class org.jgrapes.portal.base.events.PortalLayoutChanged
 
PortalLocalBackedKVStore - Class in org.jgrapes.portal.base
The Class PortalLocalBackedKVStore.
PortalLocalBackedKVStore(Channel, String) - Constructor for class org.jgrapes.portal.base.PortalLocalBackedKVStore
Create a new key/value store that uses the browser’s local storage for persisting the values.
PortalPrepared - Class in org.jgrapes.portal.base.events
This event is the completion event for the PortalReady event.
PortalPrepared(PortalReady, Channel...) - Constructor for class org.jgrapes.portal.base.events.PortalPrepared
Instantiates a new event.
PortalReady - Class in org.jgrapes.portal.base.events
Signals the successful loading of the portal structure in the browser.
PortalReady(RenderSupport) - Constructor for class org.jgrapes.portal.base.events.PortalReady
Creates a new event.
portalResource(URI) - Method in interface org.jgrapes.portal.base.RenderSupport
Create a reference to a resource provided by the portal.
portalResource(String) - Method in interface org.jgrapes.portal.base.RenderSupport
Convenience method that converts the path to an URI before calling RenderSupport.portalResource(URI).
PortalResourceBundle - Class in org.jgrapes.portal.base
PortalResourceBundle(Properties) - Constructor for class org.jgrapes.portal.base.PortalResourceBundle
Instantiates a new portal resource bundle.
portalResourceBundle(Locale) - Method in class org.jgrapes.portal.base.PortalWeblet
Return the portal resources for a given locale.
PortalResourceBundleControl - Class in org.jgrapes.portal.base
A ResourceBundle.Control that implements a special lookup algorithm.
PortalResourceBundleControl(List<Class<?>>) - Constructor for class org.jgrapes.portal.base.PortalResourceBundleControl
Instantiates a new portal resource bundle control.
PortalResourceChannel(Manager, IOSubchannel, EventPipeline) - Constructor for class org.jgrapes.portal.base.PortalWeblet.PortalResourceChannel
Instantiates a new portal resource channel.
PortalSession - Class in org.jgrapes.portal.base
The server side representation of a window in the browser that displays a portal page (a portal session).
portalSessionInactivityTimeout() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the portal session inactivity timeout.
PortalSessionInfo(PortalSession) - Constructor for class org.jgrapes.portal.base.Portal.PortalMXBean.PortalSessionInfo
 
portalSessionNetworkTimeout() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the portal session network timeout.
portalSessionRefreshInterval() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the portal session refresh interval.
PortalUtils - Class in org.jgrapes.portal.base
 
PortalWeblet - Class in org.jgrapes.portal.base
Provides resources using Request/Response events.
PortalWeblet(Channel, Channel, URI) - Constructor for class org.jgrapes.portal.base.PortalWeblet
Instantiates a new portal weblet.
PortalWeblet.PortalChannel - Class in org.jgrapes.portal.base
The class used in handler annotations to represent the portal channel.
PortalWeblet.PortalResourceChannel - Class in org.jgrapes.portal.base
The channel used to send PageResourceRequests and PortletResourceRequests to the portlets (via the portal).
Portlet - Interface in org.jgrapes.portal.base
This interface provides portlet related constants.
Portlet.RenderMode - Enum in org.jgrapes.portal.base
The render modes.
PORTLET_ID - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Property for forcing a portlet id (used for singleton instaces).
PortletBaseModel(String) - Constructor for class org.jgrapes.portal.base.AbstractPortlet.PortletBaseModel
Creates a new model with the given type and id.
portletClass() - Method in class org.jgrapes.portal.base.events.PortletResourceRequest
 
portletClass() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Returns the portlet class as specified on creation.
PortletComponentFactory - Interface in org.jgrapes.portal.base
A factory interface for portlet components.
portletId - Variable in class org.jgrapes.portal.base.AbstractPortlet.PortletBaseModel
 
portletId() - Method in class org.jgrapes.portal.base.events.DeletePortlet
Returns the portlet id.
portletId() - Method in class org.jgrapes.portal.base.events.DeletePortletRequest
Returns the portlet id.
portletId() - Method in class org.jgrapes.portal.base.events.NotifyPortletModel
Returns the portlet id.
portletId() - Method in class org.jgrapes.portal.base.events.NotifyPortletView
Returns the portlet id.
portletId() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Returns the portlet id as specified on creation.
portletId() - Method in class org.jgrapes.portal.base.events.RenderPortletRequest
Returns the portlet id.
portletId() - Method in class org.jgrapes.portal.base.events.UpdatePortletModel
Returns the portlet id.
portletIds(PortalSession) - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns the set of portlet ids associated with the portal session as an unmodifiable Set.
portletIdsByPortalSession() - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns the tracked models and channels as unmodifiable map.
portletResource(String, URI) - Method in interface org.jgrapes.portal.base.RenderSupport
Create a reference to a resource provided by a portlet of the given type.
portletResource(String, String) - Method in interface org.jgrapes.portal.base.RenderSupport
Convenience method that converts the path to an URI before calling RenderSupport.portletResource(String, URI).
PortletResourceRequest - Class in org.jgrapes.portal.base.events
An event that signals the request of a resource by the portal (browser).
PortletResourceRequest(String, URI, Instant, HttpRequest, IOSubchannel, Session, RenderSupport) - Constructor for class org.jgrapes.portal.base.events.PortletResourceRequest
Creates a new request.
portletType() - Method in class org.jgrapes.portal.base.events.AddPortletRequest
Returns the portlet type
portletType() - Method in class org.jgrapes.portal.base.events.AddPortletType
Return the portlet type.
portletType() - Method in class org.jgrapes.portal.base.events.NotifyPortletView
Returns the portlet class.
prefix() - Method in class org.jgrapes.portal.base.PortalWeblet
 
prependClassTemplateLoader(ClassLoader, String) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Prepend a class template loader to the list of loaders derived from the class hierarchy.
prependClassTemplateLoader(Class<?>) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
Convenience version of FreeMarkerPortalWeblet.prependClassTemplateLoader(ClassLoader, String) that derives the path from the class’s package name.
prependPortalResourceProvider(Class<?>) - Method in class org.jgrapes.portal.base.PortalWeblet
Prepends the given class to the list of classes searched by PortalWeblet.providePortalResource(Request.In.Get, String, IOSubchannel).
prependResourceBundleProvider(Class<?>) - Method in class org.jgrapes.portal.base.PortalWeblet
Prepends a class to the list of classes used to lookup portal resources.
PREVIEW_SOURCE - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Property for setting the preview source.
previewLayout() - Method in class org.jgrapes.portal.base.events.LastPortalLayout
 
previewLayout() - Method in class org.jgrapes.portal.base.events.PortalLayoutChanged
 
process() - Method in class org.jgrapes.portal.base.ResourceByGenerator
 
process() - Method in class org.jgrapes.portal.base.ResourceByInputStream
 
process() - Method in class org.jgrapes.portal.base.ResourceByUrl
 
process() - Method in class org.jgrapes.portal.base.ResourceNotModified
Send header only, because the resource does not have to be sent.
process() - Method in class org.jgrapes.portal.base.ResourceProvided
Does nothing, because the resource has already been sent.
process() - Method in class org.jgrapes.portal.base.ResourceResult
Specifies hoe the provided resource is processed.
properties() - Method in class org.jgrapes.portal.base.events.AddPortletRequest
Returns the properties.
properties() - Method in class org.jgrapes.portal.base.events.UpdatePortletModel
Returns the properties.
providePortalResource(Request.In.Get, String, IOSubchannel) - Method in class org.jgrapes.portal.base.PortalWeblet
Provide a portal resource.
providePortalResource(Request.In.Get, String, IOSubchannel) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
 
Provider - Class in org.jgrapes.portal.jqueryui.themes.base
 
Provider() - Constructor for class org.jgrapes.portal.jqueryui.themes.base.Provider
 
provides() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Returns the list of JavaScript features that this script resource provides.
putInSession(Session, String, T) - Method in class org.jgrapes.portal.base.AbstractPortlet
Puts the given portlet state in the session using the AbstractPortlet.type() and the given portlet id as keys.
putInSession(Session, T) - Method in class org.jgrapes.portal.base.AbstractPortlet
Puts the given portlet instance state in the browser session associated with the channel, using
AbstractPortlet.type() and the portlet id from the model.

Q

queryAsMap(URI) - Static method in class org.jgrapes.portal.base.PortalUtils
Returns the query part of a URI as map.

R

refresh() - Method in class org.jgrapes.portal.base.PortalSession
Resets the PortalSession’s timeout.
removeState(Session, String) - Method in class org.jgrapes.portal.base.AbstractPortlet
Removes the portlet state of the portlet with the given id from the session.
renderMode() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Returns the render mode.
renderMode() - Method in class org.jgrapes.portal.base.events.RenderPortletRequestBase
Returns the render mode.
renderPortal(Request.In.Get, IOSubchannel, UUID) - Method in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
 
renderPortal(Request.In.Get, IOSubchannel, UUID) - Method in class org.jgrapes.portal.base.PortalWeblet
Render the portal page.
renderPortal(Request.In.Get, IOSubchannel, UUID) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
 
RenderPortlet - Class in org.jgrapes.portal.base.events
A base class for portal commands Sent to the portal page for adding or updating a complete portlet representation.
RenderPortlet(Class<?>, String) - Constructor for class org.jgrapes.portal.base.events.RenderPortlet
Creates a new event.
RenderPortletFromReader(RenderPortletRequestBase<?>, Class<?>, String, Reader) - Constructor for class org.jgrapes.portal.base.AbstractPortlet.RenderPortletFromReader
Creates a new event.
RenderPortletFromTemplate(RenderPortletRequestBase<?>, Class<?>, String, Template, Object) - Constructor for class org.jgrapes.portal.base.freemarker.FreeMarkerPortlet.RenderPortletFromTemplate
Instantiates a new event.
RenderPortletRequest - Class in org.jgrapes.portal.base.events
Sent to the portal (server) if an existing portlet instance should be updated.
RenderPortletRequest(RenderSupport, String, Portlet.RenderMode, boolean) - Constructor for class org.jgrapes.portal.base.events.RenderPortletRequest
Creates a new request.
RenderPortletRequestBase<T> - Class in org.jgrapes.portal.base.events
The base class for events that result in a portlet being rendered.
RenderPortletRequestBase(RenderSupport, Portlet.RenderMode) - Constructor for class org.jgrapes.portal.base.events.RenderPortletRequestBase
Creates a new event.
renderSupport() - Method in class org.jgrapes.portal.base.events.DeletePortletRequest
Returns the render support.
renderSupport() - Method in class org.jgrapes.portal.base.events.NotifyPortletModel
Returns the render support.
renderSupport() - Method in class org.jgrapes.portal.base.events.PortalReady
Returns the render support.
renderSupport() - Method in class org.jgrapes.portal.base.events.RenderPortletRequestBase
Returns the render support.
renderSupport() - Method in class org.jgrapes.portal.base.events.ResourceRequest
Returns the render support.
renderSupport() - Method in class org.jgrapes.portal.base.PortalWeblet
Provides the render support.
RenderSupport - Interface in org.jgrapes.portal.base
Provides support for creating URIs in the portal scope that are forwarded to components listening on the portal channel.
request() - Method in class org.jgrapes.portal.base.events.JsonInput
 
request() - Method in class org.jgrapes.portal.base.ResourceResult
 
requires() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Returns the list of JavaScript features that this script resource requires.
resourceBundle(Locale) - Method in class org.jgrapes.portal.base.AbstractPortlet
Provides a resource bundle for localization.
resourceBundle(Locale) - Method in class org.jgrapes.portal.base.PageResourceProvider
Provides a resource bundle for localization.
resourceBundle(Locale) - Method in class org.jgrapes.portal.providers.datatables.DatatablesProvider
Provides a resource bundle for localization.
ResourceByGenerator - Class in org.jgrapes.portal.base
Returns a Runnable that writes to an OutputStream as result.
ResourceByGenerator(ResourceRequest, ResourceByGenerator.Generator, MediaType, Instant, int) - Constructor for class org.jgrapes.portal.base.ResourceByGenerator
Instantiates a result that is provided by an OutputStream.
ResourceByGenerator.Generator - Interface in org.jgrapes.portal.base
The interface that must be implemented by the content provider.
ResourceByInputStream - Class in org.jgrapes.portal.base
Returns an OutputStream as result.
ResourceByInputStream(ResourceRequest, InputStream, MediaType, Instant, int) - Constructor for class org.jgrapes.portal.base.ResourceByInputStream
Instantiates a result that is provided by an OutputStream.
ResourceByUrl - Class in org.jgrapes.portal.base
Returns a URL as result.
ResourceByUrl(ResourceRequest, URL) - Constructor for class org.jgrapes.portal.base.ResourceByUrl
Instantiates a new result represented by a URL.
ResourceNotFoundException - Exception in org.jgrapes.portal.base
Thrown if a resource cannot be found.
ResourceNotFoundException() - Constructor for exception org.jgrapes.portal.base.ResourceNotFoundException
 
ResourceNotFoundException(String) - Constructor for exception org.jgrapes.portal.base.ResourceNotFoundException
 
ResourceNotFoundException(Throwable) - Constructor for exception org.jgrapes.portal.base.ResourceNotFoundException
 
ResourceNotFoundException(String, Throwable) - Constructor for exception org.jgrapes.portal.base.ResourceNotFoundException
 
ResourceNotFoundException(String, Throwable, boolean, boolean) - Constructor for exception org.jgrapes.portal.base.ResourceNotFoundException
 
ResourceNotModified - Class in org.jgrapes.portal.base
Indicates that a resource provider found the resource to be unmodified.
ResourceNotModified(ResourceRequest, Instant, int) - Constructor for class org.jgrapes.portal.base.ResourceNotModified
Creates a new instance.
ResourceProvided - Class in org.jgrapes.portal.base
Indicates that a resource provider has fully processed the resource request a provided a response.
ResourceProvided(ResourceRequest) - Constructor for class org.jgrapes.portal.base.ResourceProvided
Creates a new instance.
ResourceRequest - Class in org.jgrapes.portal.base.events
An event that signals the request for a resource by the browser.
ResourceRequest(URI, Instant, HttpRequest, IOSubchannel, Session, RenderSupport) - Constructor for class org.jgrapes.portal.base.events.ResourceRequest
Creates a new request, including the associated ResourceRequestCompleted event.
ResourceRequestCompleted - Class in org.jgrapes.portal.base.events
Indicates that a ResourceRequest event has been completed.
ResourceRequestCompleted(ResourceRequest, Channel...) - Constructor for class org.jgrapes.portal.base.events.ResourceRequestCompleted
Instantiates a new event.
ResourceResult - Class in org.jgrapes.portal.base
The base class for all results from processing a resource request.
ResourceResult(ResourceRequest) - Constructor for class org.jgrapes.portal.base.ResourceResult
Instantiates a new resource result.
resourceUri() - Method in class org.jgrapes.portal.base.events.ResourceRequest
 
run() - Method in class org.jgrapes.portal.base.WebSocketInputReader
 
runtime() - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet.SysInfoModel
Return the Runtime.

S

ScriptResource() - Constructor for class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
 
scriptResources() - Method in class org.jgrapes.portal.base.events.AddPageResources
Return all script URIs
scriptResources() - Method in class org.jgrapes.portal.base.events.AddPortletType
Return all script resources.
scriptSource() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
 
scriptUri() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
 
session() - Method in class org.jgrapes.portal.base.events.ResourceRequest
Returns the (browser) session.
setCssSource(String) - Method in class org.jgrapes.portal.base.events.AddPageResources
 
setDeletable(boolean) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
setDisplayName(String) - Method in class org.jgrapes.portal.base.events.AddPortletType
Sets the display name.
setEditableBy(Set<Principal>) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
setFallbackResourceSupplier(BiFunction<ThemeProvider, String, URL>) - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
Sets a function for obtaining a fallback resource bundle for a given theme provider and locale.
setForeground(boolean) - Method in class org.jgrapes.portal.base.events.AddPortletRequest
Determines if the portlet will be put in the foreground.
setForeground(boolean) - Method in class org.jgrapes.portal.base.events.RenderPortlet
Id set, the tab with the portlet is put in the foreground when the portlet is rendered.
setInstantiable() - Method in class org.jgrapes.portal.base.events.AddPortletType
Mark the portlet type as instantiable.
SetLocale - Class in org.jgrapes.portal.base.events
Signals that the locale for the portal has changed.
SetLocale(Locale) - Constructor for class org.jgrapes.portal.base.events.SetLocale
Creates a new event.
setParameters(Object...) - Method in class org.jgrapes.portal.base.events.SimplePortalCommand
Sets the parameters.
setPeriodicRefresh(Duration, Supplier<Event<?>>) - Method in class org.jgrapes.portal.base.AbstractPortlet
If set to a value different from null causes an event from the given supplier to be fired on all tracked portal sessions periodically.
setPortalSessionInactivityTimeout(long) - Method in class org.jgrapes.portal.base.PortalWeblet
Sets the portal session inactivity timeout.
setPortalSessionNetworkTimeout(long) - Method in class org.jgrapes.portal.base.PortalWeblet
Sets the portal session network timeout.
setPortalSessionRefreshInterval(long) - Method in class org.jgrapes.portal.base.PortalWeblet
Sets the portal session refresh interval.
setPreviewContent(String) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
setProvides(String...) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the list of JavaScript features that this script resource provides.
setRenderMode(Portlet.RenderMode) - Method in class org.jgrapes.portal.base.events.RenderPortlet
Set the render mode.
setRequires(String...) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the list of JavaScript features that this script resource requires.
setScriptId(String) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the script id.
setScriptSource(String) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the script source to evaluate.
setScriptType(String) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the script type.
setScriptUri(URI) - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Sets the scriptUri to to be loaded, clears the scriptSource attribute.
setSession(Session) - Method in class org.jgrapes.portal.base.PortalSession
Sets or updates associated browser session.
setSupportedModes(Set<Portlet.RenderMode>) - Method in class org.jgrapes.portal.base.events.RenderPortlet
Set the supported render modes.
SetTheme - Class in org.jgrapes.portal.jqueryui.events
Signals that the theme for the portal has changed.
SetTheme(String) - Constructor for class org.jgrapes.portal.jqueryui.events.SetTheme
Creates a new event.
setTimeout(long) - Method in class org.jgrapes.portal.base.PortalSession
Changes the timeout for this PortalSession to the given value.
setTitle(String) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
setUpstreamChannel(IOSubchannel) - Method in class org.jgrapes.portal.base.PortalSession
Sets or updates the upstream channel.
setUseMinifiedResources(boolean) - Method in class org.jgrapes.portal.base.Portal.PortalInfo
 
setUseMinifiedResources(boolean) - Method in interface org.jgrapes.portal.base.Portal.PortalMXBean
 
setUseMinifiedResources(boolean) - Method in class org.jgrapes.portal.base.PortalWeblet
Determines if resources should be minified.
setViewContent(String) - Method in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet.MarkdownDisplayModel
 
SimplePortalCommand - Class in org.jgrapes.portal.base.events
A PortalCommand created directly from the JSON RPC method name and parameters.
SimplePortalCommand(String, Object...) - Constructor for class org.jgrapes.portal.base.events.SimplePortalCommand
Instantiates a new portal command.
SimplePortalCommand(String) - Constructor for class org.jgrapes.portal.base.events.SimplePortalCommand
Instantiates a new portal session command.
stateFromSession(Session, String, Class<T>) - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns the portlet state of this portlet’s type with the given id from the session.
stateFromSession(Session, String, Class<T>) - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet
 
statesFromSession(IOSubchannel, Class<T>) - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns all portlet states of this portlet’s type from the session.
styling() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the name of the styling library or toolkit used by the portal.
styling() - Method in class org.jgrapes.portal.bootstrap4.Bootstrap4Weblet
 
styling() - Method in class org.jgrapes.portal.jqueryui.JQueryUiWeblet
 
StylingInfo - Class in org.jgrapes.portal.base
Evaluates and provides the styling info to a portal component.
StylingInfo(ComponentType, Map<Object, Object>) - Constructor for class org.jgrapes.portal.base.StylingInfo
Instantiates a new styling info.
supportedLocales() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns the supported locales.
supportedRenderModes() - Method in class org.jgrapes.portal.base.events.RenderPortlet
Returns the supported modes.
SysInfoModel(String) - Constructor for class org.jgrapes.portlets.sysinfo.SysInfoPortlet.SysInfoModel
Creates a new model with the given type and id.
SysInfoPortlet - Class in org.jgrapes.portlets.sysinfo
 
SysInfoPortlet(Channel) - Constructor for class org.jgrapes.portlets.sysinfo.SysInfoPortlet
Creates a new component with its channel set to the given channel.
SysInfoPortlet.SysInfoModel - Class in org.jgrapes.portlets.sysinfo
The portlet’s model.
SysInfoPortlet.Update - Class in org.jgrapes.portlets.sysinfo
The periodically generated update event.
SysInfoPortletFactory - Class in org.jgrapes.portlets.sysinfo
A factory for creating SysInfoPortlets.
SysInfoPortletFactory() - Constructor for class org.jgrapes.portlets.sysinfo.SysInfoPortletFactory
 
systemProperties() - Method in class org.jgrapes.portlets.sysinfo.SysInfoPortlet.SysInfoModel
Return the system properties.

T

tabsLayout() - Method in class org.jgrapes.portal.base.events.LastPortalLayout
 
tabsLayout() - Method in class org.jgrapes.portal.base.events.PortalLayoutChanged
 
theme() - Method in class org.jgrapes.portal.jqueryui.events.SetTheme
Returns the theme to set.
themeId() - Method in class org.jgrapes.portal.jqueryui.ThemeProvider
Return the id of the theme.
themeId() - Method in class org.jgrapes.portal.jqueryui.themes.base.Provider
 
ThemeInfo(String, String) - Constructor for class org.jgrapes.portal.jqueryui.JQueryUiWeblet.ThemeInfo
Instantiates a new theme info.
themeName() - Method in class org.jgrapes.portal.jqueryui.ThemeProvider
Return the name of the theme.
ThemeProvider - Class in org.jgrapes.portal.jqueryui
Represents a theme provider.
ThemeProvider() - Constructor for class org.jgrapes.portal.jqueryui.ThemeProvider
 
TITLE - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Property for setting a title.
toJson(Writer) - Method in class org.jgrapes.portal.base.events.AddPageResources
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.AddPortletType
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.DeletePortlet
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.DisplayNotification
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.LastPortalLayout
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.NotifyPortletView
 
toJson(Writer) - Method in class org.jgrapes.portal.base.events.PortalCommand
Writes the event as JSON notification to the given writer.
toJson(Writer, String, Object...) - Method in class org.jgrapes.portal.base.events.PortalCommand
Creates a JSON notification from the given data.
toJson(Writer) - Method in class org.jgrapes.portal.base.events.RenderPortlet
Writes the JSON notification to the given writer.
toJson(Writer) - Method in class org.jgrapes.portal.base.events.SimplePortalCommand
 
toJsonValue() - Method in class org.jgrapes.portal.base.events.AddPageResources.ScriptResource
Provides the JSON representation of the information.
toString() - Method in class org.jgrapes.portal.base.events.JsonInput
 
toString() - Method in class org.jgrapes.portal.base.events.SimplePortalCommand
 
toString() - Method in class org.jgrapes.portal.base.PortalSession
 
trackedSessions() - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns the tracked sessions.
trackPortlet(PortalSession, String) - Method in class org.jgrapes.portal.base.AbstractPortlet
Track the given portlet from the given session if tracking is enabled.
type() - Method in class org.jgrapes.portal.base.AbstractPortlet
Returns the portlet type.

U

Update() - Constructor for class org.jgrapes.portlets.sysinfo.SysInfoPortlet.Update
 
UpdatePortletModel - Class in org.jgrapes.portal.base.events
Sent to a portlet to update some of its properties.
UpdatePortletModel(String, Map<?, ?>) - Constructor for class org.jgrapes.portal.base.events.UpdatePortletModel
Creates a new event.
UpdatePortletModel(String) - Constructor for class org.jgrapes.portal.base.events.UpdatePortletModel
Creates a new event.
updateSupportedLocales() - Method in class org.jgrapes.portal.base.PortalWeblet
Update the supported locales.
upstreamChannel() - Method in class org.jgrapes.portal.base.PortalSession
 
uriFromPath(String) - Static method in class org.jgrapes.portal.base.PortalUtils
Create a URI from a path.
useMinifiedResources() - Method in class org.jgrapes.portal.base.PortalWeblet
Returns whether resources are minified.
useMinifiedResources() - Method in interface org.jgrapes.portal.base.RenderSupport
Indicates if minified resources should be used.
userFromSession(Session) - Static method in class org.jgrapes.portal.base.PortalUtils
Convenience method for retrieving the user from a Subject associated with the session.
UserPrincipal - Interface in org.jgrapes.portal.base
A principal representing an identity established by a client.
UTF_8 - Static variable in class org.jgrapes.portal.base.freemarker.FreeMarkerPortalWeblet
 

V

valueOf(String) - Static method in enum org.jgrapes.portal.base.Portlet.RenderMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jgrapes.portal.base.Portlet.RenderMode
Returns an array containing the constants of this enum type, in the order they are declared.
VIEW_SOURCE - Static variable in class org.jgrapes.portlets.markdowndisplay.MarkdownDisplayPortlet
Property for setting the view source.
VueJsProvider - Class in org.jgrapes.portal.providers.vuejs
Provider for the Vue.js library.
VueJsProvider(Channel) - Constructor for class org.jgrapes.portal.providers.vuejs.VueJsProvider
Creates a new component with its channel set to the given channel.
VueJsProviderFactory - Class in org.jgrapes.portal.providers.vuejs
A factory for creating VueJsProviders.
VueJsProviderFactory() - Constructor for class org.jgrapes.portal.providers.vuejs.VueJsProviderFactory
 

W

WebSocketInputReader - Class in org.jgrapes.portal.base
Assembles Input events until a complete JSON message has been collected and then fires the message as JsonInput event.
WebSocketInputReader(EventPipeline, PortalSession) - Constructor for class org.jgrapes.portal.base.WebSocketInputReader
Instantiates a new web socket input reader.
write(OutputStream) - Method in interface org.jgrapes.portal.base.ResourceByGenerator.Generator
Write the generated output to the given stream.
write(CharBuffer) - Method in class org.jgrapes.portal.base.WebSocketInputReader
Forward the data to the JSON decoder.

X

xtraInfo() - Method in class org.jgrapes.portal.base.events.LastPortalLayout
 
xtraInfo() - Method in class org.jgrapes.portal.base.events.PortalLayoutChanged
The extra information.
A B C D E F G H I J K L M N O P Q R S T U V W X