Package org.jgrapes.webconlet.locallogin

Class LoginConlet

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<LoginConlet.AccountModel>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<LoginConlet.AccountModel>

org.jgrapes.webconlet.locallogin.LoginConlet

All Implemented Interfaces:

Iterable<org.jgrapes.core.ComponentType>, org.jgrapes.core.Channel, org.jgrapes.core.ComponentType, org.jgrapes.core.Eligible, org.jgrapes.core.Manager

public class LoginConlet
extends FreeMarkerConlet<LoginConlet.AccountModel>

As simple login conlet for password based logins.

The users are configured as property “users” of the conlet:

"...":
  "/LoginConlet":
    users:
      admin:
        # Full name is optional
        fullName: Administrator
        password: "$2b$05$NiBd74ZGdplLC63ePZf1f.UtjMKkbQ23cQoO2OKOFalDBHWAOy21."
      test:
        fullName: Test Account
        password: "$2b$05$hZaI/jToXf/d3BctZdT38Or7H7h6Pn2W3WiB49p5AyhDHFkkYCvo2"
        

Passwords are hashed using bcrypt.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoginConlet.AccountModel	Model with account info.

Nested classes/interfaces inherited from class org.jgrapes.webconsole.base.AbstractConlet

AbstractConlet.ConletTrackingInfo

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

org.jgrapes.core.Channel.Default

Field Summary

Fields inherited from class org.jgrapes.webconsole.base.AbstractConlet

TYPE_INSTANCE_SEPARATOR

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
LoginConlet(org.jgrapes.core.Channel componentChannel)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
protected Optional<LoginConlet.AccountModel>	createNewState(AddConletRequest event, ConsoleConnection session, String conletId)	As a model has already been created in doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, org.jgrapes.webconlet.locallogin.LoginConlet.AccountModel), the “new” model may already exist in the session.
protected Optional<LoginConlet.AccountModel>	createStateRepresentation(org.jgrapes.core.Event<?> event, ConsoleConnection channel, String conletId)	Creates an instance of the type that represents the conlet’s state, initialized with default values.
protected Set<Conlet.RenderMode>	doRenderConlet(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, LoginConlet.AccountModel model)	Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.
protected boolean	doSetLocale(SetLocale event, ConsoleConnection channel, String conletId)	Called by AbstractConlet.onSetLocale(SetLocale, ConsoleConnection) for each web console component in the console connection.
protected void	doUpdateConletState(NotifyConletModel event, ConsoleConnection connection, LoginConlet.AccountModel model)	Called by AbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection) to complete handling the notification.
protected String	generateInstanceId(AddConletRequest event, ConsoleConnection session)	Create the instance specific part of a conlet id.
void	onConfigUpdate(org.jgrapes.util.events.ConfigurationUpdate event)	The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).
void	onConsolePrepared(ConsolePrepared event, ConsoleConnection channel)	Handle web console page loaded.
void	onConsoleReady(ConsoleReady event, ConsoleConnection channel)	Register conlet.
void	onUserAuthenticated(UserAuthenticated event, org.jgrapes.core.Channel channel)	Invoked when a user has been authenticated.

Methods inherited from class org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet

doGetResource, fmConletModel, fmModel, fmModel, fmSessionModel, fmTypeModel, freemarkerConfig, processTemplate, processTemplate

Methods inherited from class org.jgrapes.webconsole.base.AbstractConlet

afterOnClosed, conletIds, conletIdsByConsoleConnection, conletViews, doConletDeleted, doRemoveConletType, l10nBundles, localizations, onAddConletRequest, onClosed, onConletDeleted, onConletResourceRequest, onDetached, onNotifyConletModel, onRenderConletRequest, onSetLocale, putInSession, readContent, readContent, recreateState, removeState, resourceBundle, setPeriodicRefresh, stateFromSession, statesFromSession, supportedLocales, trackConlet, trackedConnections, type, typeFromId

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

LoginConlet

public LoginConlet(org.jgrapes.core.Channel componentChannel)

Creates a new component with its channel set to the given channel.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

Method Details

generateInstanceId

protected String generateInstanceId(AddConletRequest event,
 ConsoleConnection session)

Description copied from class: AbstractConlet

Create the instance specific part of a conlet id.

The default implementation generates a UUID. Derived classes override this method if e.g. the instance specific part must include a key that associates the conlet’s state with some backing store.

Overrides:

generateInstanceId in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event that triggered the creation of a new conlet, which may contain required information (see AddConletRequest.properties())

session - the console connection; usually not required but provided as context

Returns:

the web console component id

onConsoleReady

@Handler
public void onConsoleReady(ConsoleReady event,
 ConsoleConnection channel)
                    throws freemarker.template.TemplateNotFoundException,
freemarker.template.MalformedTemplateNameException,
freemarker.core.ParseException,
IOException

Register conlet.

Parameters:

event - the event

channel - the channel

Throws:

freemarker.template.TemplateNotFoundException - the template not found exception

freemarker.template.MalformedTemplateNameException - the malformed template name exception

freemarker.core.ParseException - the parse exception

IOException - Signals that an I/O exception has occurred.

createNewState

protected Optional<LoginConlet.AccountModel> createNewState(AddConletRequest event,
 ConsoleConnection session,
 String conletId)
                                                     throws Exception

As a model has already been created in doUpdateConletState(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection, org.jgrapes.webconlet.locallogin.LoginConlet.AccountModel), the “new” model may already exist in the session.

Overrides:

createNewState in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event

session - the console connection

conletId - the conlet id

Returns:

the state representation or Optional.empty() if none is required

Throws:

Exception - if an exception occurs

createStateRepresentation

protected Optional<LoginConlet.AccountModel> createStateRepresentation(org.jgrapes.core.Event<?> event,
 ConsoleConnection channel,
 String conletId)
                                                                throws IOException

Description copied from class: AbstractConlet

Creates an instance of the type that represents the conlet’s state, initialized with default values.

The default implementation returns Optional.isEmpty(), thus indicating that no state information is needed or available.

This method should always be overridden if conlet instances have associated state.

Overrides:

createStateRepresentation in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event, which may contain required information (see AddConletRequest.properties())

channel - the console connection, sometimes required to send events to components that provide a backing store

conletId - the conlet id calculated as type() + TYPE_INSTANCE_SEPARATOR + generateInstanceId(...)

Returns:

the state representation or Optional.empty() if none is required

Throws:

IOException

onConfigUpdate

@Handler
public void onConfigUpdate(org.jgrapes.util.events.ConfigurationUpdate event)

The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).

The following properties are recognized:

users

See LoginConlet.

Parameters:

event - the event

onConsolePrepared

@Handler(priority=1000)
public void onConsolePrepared(ConsolePrepared event,
 ConsoleConnection channel)
                       throws freemarker.template.TemplateNotFoundException,
freemarker.template.MalformedTemplateNameException,
freemarker.core.ParseException,
IOException

Handle web console page loaded.

Parameters:

event - the event

channel - the channel

Throws:

IOException

freemarker.core.ParseException

freemarker.template.MalformedTemplateNameException

freemarker.template.TemplateNotFoundException

doRenderConlet

protected Set<Conlet.RenderMode> doRenderConlet(RenderConletRequestBase<?> event,
 ConsoleConnection channel,
 String conletId,
 LoginConlet.AccountModel model)
                                         throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.

The

Specified by:

doRenderConlet in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event

channel - the channel

conletId - the component id

model - the conlet’s state; may be null if the conlet doesn’t have associated state information

Returns:

the rendered modes

Throws:

Exception - the exception

doUpdateConletState

protected void doUpdateConletState(NotifyConletModel event,
 ConsoleConnection connection,
 LoginConlet.AccountModel model)
                            throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onNotifyConletModel(org.jgrapes.webconsole.base.events.NotifyConletModel, org.jgrapes.webconsole.base.ConsoleConnection) to complete handling the notification.

The default implementation does nothing.

Overrides:

doUpdateConletState in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event

connection - the channel

model - the conlet’s state; may be null if the conlet doesn’t have associated state information

Throws:

Exception

onUserAuthenticated

@Handler
public void onUserAuthenticated(UserAuthenticated event,
 org.jgrapes.core.Channel channel)

Invoked when a user has been authenticated.

Parameters:

event - the event

channel - the channel

doSetLocale

protected boolean doSetLocale(SetLocale event,
 ConsoleConnection channel,
 String conletId)
                       throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onSetLocale(SetLocale, ConsoleConnection) for each web console component in the console connection.

Derived classes must send events for updating the representation to match the new locale.

If the method returns false this indicates that the representation cannot be updated without reloading the web console page.

The default implementation fires a RenderConletRequest with tracked render modes (one of or both Conlet.RenderMode.Preview and Conlet.RenderMode.View), thus updating the known representations. (Assuming that “Edit” and “Help” modes are represented with modal dialogs and therefore locale changes aren’t possible while these are open.)

Overrides:

doSetLocale in class AbstractConlet<LoginConlet.AccountModel>

Parameters:

event - the event

channel - the channel

conletId - the web console component id

Returns:

true, if adaption to new locale without reload is possible

Throws:

Exception - the exception