Package org.apache.juneau.petstore.console.users

Class UsersRest

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.server.servlet.RestServlet

org.apache.juneau.rest.server.servlet.BasicRestServlet

org.apache.juneau.petstore.console.PetstoreConsolePage

org.apache.juneau.petstore.console.users.UsersRest

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig

public class UsersRest
extends PetstoreConsolePage

The Users page and its endpoints. The password is write-only: every read goes through UsersRest.UserView, which has no password, so it never leaves the server; an update with no password keeps the stored one.

Example:

// The wire shape of a create (JSON5): the password is accepted but never echoed. { username:'newbie', firstName:'New', lastName:'Bie', password:'s3cret' }

<@card type="datatables" id="users"> { dataMode:'server', dataUrl:'/console/users/query', columns:[{key:'username', label:'Username'}, ...] } </@card>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UsersRest.UserView	A user as the console shows it: everything but the password.

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestServlet

RestServlet.Builder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>, RestServlet.DefaultBuilder<R extends RestServlet>

Field Summary

Fields inherited from class org.apache.juneau.petstore.console.PetstoreConsolePage

PAGE_HEADER, TEMPLATES

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
UsersRest()

Method Summary

Modifier and Type	Method	Description
ActionResult	create(RestRequest req, JsonMap body)	Creates a user.
ActionResult	delete(RestRequest req, String username)	Deletes a user.
ModalDef	form(String username)	The add/edit dialog form.
UsersRest.UserView	get(String username)
View	page(RestRequest req)	The Users page.
DataTablesResults<UsersRest.UserView>	query(DataTablesRequest req)	Server-mode DataTables query over all users, as password-free views.
ActionResult	update(RestRequest req, String username, JsonMap body)	Updates a user.

Methods inherited from class org.apache.juneau.petstore.console.PetstoreConsolePage

builder, freemarker, store, twin

Methods inherited from class org.apache.juneau.rest.server.servlet.RestServlet

builder, createAuthenticator, destroy, doLog, getContext, getPath, getPaths, getRequest, getResponse, getRestBuilder, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, isSensitiveHeader, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

UsersRest

public UsersRest()

Method Details

page

public View page(RestRequest req)

The Users page.

Parameters:

req - The request; ?builder renders the builder twin.

Returns:

The page.

form

public ModalDef form(@Query("username")
 String username)

The add/edit dialog form. The password field is write-only: it is never pre-filled.

Parameters:

username - The user to edit, or null to add.

Returns:

The modal.

Throws:

NotFound - If username names no user.

query

public DataTablesResults<UsersRest.UserView> query(@Content
 DataTablesRequest req)

Server-mode DataTables query over all users, as password-free views.

Parameters:

req - The DataTables request.

Returns:

One page of users, or a 200 error envelope for a malformed search expression.

get

public UsersRest.UserView get(@Path("username")
 String username)

Parameters:

username - The username.

Returns:

The user, without the password.

Throws:

NotFound - If it does not exist.

create

public ActionResult create(RestRequest req,
 @Content
 JsonMap body)

Creates a user.

Parameters:

req - The request (write gate, audit actor).

body - {username, firstName, lastName, password}, either plain or as the dialog envelope {fields:{...}}.

Returns:

The result toast, carrying the user without the password.

Throws:

BadRequest - On a blank username.

Conflict - If the username is taken.

update

public ActionResult update(RestRequest req,
 @Path("username")
 String username,
 @Content
 JsonMap body)

Updates a user. A field left out of the body, and a null or blank password, keep their stored values.

Parameters:

req - The request.

username - The username.

body - The new state, either plain or as the dialog envelope {fields:{...}}.

Returns:

The result toast, carrying the user without the password.

Throws:

NotFound - If the user does not exist.

delete

public ActionResult delete(RestRequest req,
 @Path("username")
 String username)

Deletes a user.

Parameters:

req - The request.

username - The username.

Returns:

The result toast.

Throws:

NotFound - If the user does not exist.