Class AuthenticatedPage
- java.lang.Object
-
- org.apache.wicket.Component
-
- org.apache.wicket.MarkupContainer
-
- org.apache.wicket.Page
-
- org.apache.wicket.markup.html.WebPage
-
- com.inductiveautomation.ignition.gateway.web.pages.BasePage
-
- com.inductiveautomation.ignition.gateway.web.pages.AuthenticatedPage
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable<org.apache.wicket.Component>
,org.apache.wicket.event.IEventSink
,org.apache.wicket.event.IEventSource
,org.apache.wicket.IConverterLocator
,org.apache.wicket.IRedirectListener
,org.apache.wicket.IRequestListener
,org.apache.wicket.markup.html.IHeaderContributor
,org.apache.wicket.page.IManageablePage
,org.apache.wicket.request.component.IRequestableComponent
,org.apache.wicket.request.component.IRequestablePage
,org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>
,org.apache.wicket.util.io.IClusterable
public abstract class AuthenticatedPage extends BasePage
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.web.pages.BasePage
BasePage.Category
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.gateway.web.pages.BasePage
IGNITION_LIB
-
-
Constructor Summary
Constructors Constructor Description AuthenticatedPage()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getRequiredRoles()
protected abstract SFieldMeta
getSystemPropertiesRoleField()
Return the meta field in the system properties record that holds the roles needed to log into this page.protected abstract boolean
isAuthenticationRequired()
Determines the strictness of this page.protected boolean
isAuthorized(AuthenticatedUser user)
static boolean
isAuthorized(AuthenticatedUser user, java.lang.String roleStr, boolean authRequired)
protected LoggerEx
log()
protected void
onBeforeRender()
-
Methods inherited from class com.inductiveautomation.ignition.gateway.web.pages.BasePage
getHeaderLogoCssClass, getNavLocation, renderHead, setLocale
-
Methods inherited from class org.apache.wicket.markup.html.WebPage
configureResponse, dirty, getMarkupType, homePageLink, onAfterRender, onRender, renderXmlDecl, setHeaders
-
Methods inherited from class org.apache.wicket.Page
componentChanged, componentRendered, detachModels, dirty, endComponentRender, getAutoIndex, getId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, internalPrepareForRender, isBookmarkable, isErrorPage, isPageStateless, onDetach, onRedirect, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, startComponentRender, toString, wasCreatedBookmarkable, wasRendered
-
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, visitChildren, visitChildren, visitChildren, visitChildren
-
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
isAuthorized
public static boolean isAuthorized(AuthenticatedUser user, java.lang.String roleStr, boolean authRequired)
-
log
protected LoggerEx log()
-
isAuthorized
protected final boolean isAuthorized(AuthenticatedUser user)
-
isAuthenticationRequired
protected abstract boolean isAuthenticationRequired()
Determines the strictness of this page. If true is returned, users will not be authorized if the setup is invalid (no roles defined, etc.) If false is returned, users will be authorized by default.
-
getRequiredRoles
protected java.lang.String getRequiredRoles()
-
getSystemPropertiesRoleField
protected abstract SFieldMeta getSystemPropertiesRoleField()
Return the meta field in the system properties record that holds the roles needed to log into this page. If null is returned, authentication will be based on the value of authentication required.
-
onBeforeRender
protected void onBeforeRender()
- Overrides:
onBeforeRender
in classBasePage
-
-