Package com.axelor.rpc

Class Resource<T extends Model>

java.lang.Object

com.axelor.rpc.Resource<T>

public class Resource<T extends Model>
extends Object

This class defines CRUD like interface.

Constructor Summary

Constructors

Constructor	Description
Resource(TypeLiteral<T> typeLiteral, jakarta.inject.Provider<JpaSecurity> security, Event<PreRequest> preRequest, Event<PostRequest> postRequest)

Method Summary

Modifier and Type	Method	Description
ActionResponse	action(ActionRequest request)
Response	copy(long id)
Response	export(Request request, Charset charset)
Response	export(Request request, Charset charset, Locale locale, char separator)
Response	fetch(long id, Request request)
Response	fields()
protected String[]	filterPermitted(Object bean, String... names)	Filters given field names so that only base fields and readable related fields remains.
protected void	filterPermitted(Consumer<String> permitted, Consumer<String> notPermitted, Object bean, String... names)
Class<?>	getModel()	Returns the resource class.
Response	getRecordName(Request request)	Get the name of the record.
boolean	isPermitted(JpaSecurity.AccessType accessType, Long id)
static Response	models(Request request)
Response	perms()
Response	perms(Long id)
Response	perms(String perm, Long... ids)
Response	read(long id)
Response	remove(long id, Request request)
Response	remove(Request request)
protected void	removeNotPermitted(Map<String,Object> map, String... names)	Removes not permitted fields in specified map.
static Map<String,Object>	removePasswordFields(Map<String,Object> data, Class<?> modelClass)	Removes password field values from the given record map, including dotted field names and nested record maps of relational fields.
Response	save(Request request)
Response	search(Request request)
static Map<String,Object>	toMap(Object bean, String... names)
static Map<String,Object>	toMapCompact(Object bean)
Response	updateMass(Request request)
Response	verify(Request request)

Methods inherited from class java.lang.Object

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

Constructor Details

Resource

@Inject
public Resource(TypeLiteral<T> typeLiteral,
 jakarta.inject.Provider<JpaSecurity> security,
 Event<PreRequest> preRequest,
 Event<PostRequest> postRequest)

Method Details

getModel

public Class<?> getModel()

Returns the resource class.

fields

public Response fields()

models

public static Response models(Request request)

perms

public Response perms()

perms

public Response perms(Long id)

perms

public Response perms(String perm,
 Long... ids)

search

public Response search(Request request)

export

public Response export(Request request,
 Charset charset)

export

public Response export(Request request,
 Charset charset,
 Locale locale,
 char separator)

read

public Response read(long id)

fetch

public Response fetch(long id,
 Request request)

verify

public Response verify(Request request)

save

public Response save(Request request)

updateMass

public Response updateMass(Request request)

remove

public Response remove(long id,
 Request request)

remove

public Response remove(Request request)

copy

public Response copy(long id)

action

public ActionResponse action(ActionRequest request)

getRecordName

public Response getRecordName(Request request)

Get the name of the record. This method should be used to get the value of name field if it's a function field.

Parameters:

request - the request containing the current values of the record

Returns:

response with the updated values with record name

isPermitted

public boolean isPermitted(JpaSecurity.AccessType accessType,
 Long id)

removePasswordFields

public static Map<String,Object> removePasswordFields(Map<String,Object> data,
 Class<?> modelClass)

Removes password field values from the given record map, including dotted field names and nested record maps of relational fields.

The given map is not modified, a cleaned copy is returned.

Parameters:

data - the record map to clean up

modelClass - the model class of the record

Returns:

a copy of the given map with password fields removed

removeNotPermitted

protected void removeNotPermitted(Map<String,Object> map,
 String... names)

Removes not permitted fields in specified map.

Parameters:

map - data

names - field names

filterPermitted

protected String[] filterPermitted(Object bean,
 String... names)

Filters given field names so that only base fields and readable related fields remains.

Parameters:

bean - object

names - field names

Returns:

readable field names

filterPermitted

protected void filterPermitted(Consumer<String> permitted,
 Consumer<String> notPermitted,
 Object bean,
 String... names)

toMap

public static Map<String,Object> toMap(Object bean,
 String... names)

toMapCompact

public static Map<String,Object> toMapCompact(Object bean)