org.seedstack.crud.rest

Annotation Type RestCrud

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,ANNOTATION_TYPE})
public @interface RestCrud

This annotation can be applied on REST representations (DTO) also annotated with DtoOf to generate a CRUD resource on the specified path.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	create Defines if the generated resource should allow creation.
boolean	delete Defines if the generated resource should allow deletion.
boolean	read Defines if the generated resource should allow reading.
boolean	update Defines if the generated resource should allow updating.
String	value The path the CRUD resource should be exposed on.

Element Detail

create

public abstract boolean create

Defines if the generated resource should allow creation.

Returns:

true if creation is allowed, false otherwise.

Default:

true

delete

public abstract boolean delete

Defines if the generated resource should allow deletion.

Returns:

true if deletion is allowed, false otherwise.

Default:

true

read

public abstract boolean read

Defines if the generated resource should allow reading.

Returns:

true if reading is allowed, false otherwise.

Default:

true

update

public abstract boolean update

Defines if the generated resource should allow updating.

Returns:

true if updating is allowed, false otherwise.

Default:

true

value

public abstract String value

The path the CRUD resource should be exposed on.

Returns:

the resource path.

Default:

""