Package org.openremote.model.security

Interface RealmResource

@Path("realm")
public interface RealmResource

Manage realms.

All operations can only be called by the superuser.

TODO Relax permissions to allow regular users to maintain their own realm

Method Summary

Modifier and Type	Method	Description
void	create(RequestParams requestParams, @Valid Realm realm)
void	delete(RequestParams requestParams, String realm)
Realm	get(RequestParams requestParams, String realm)	Regular users can call this, but only to obtain details about their currently authenticated and active realm.
Realm[]	getAccessible(RequestParams requestParams)	Will return realm and display names for accessible realms by authenticated user
Realm[]	getAll(RequestParams requestParams)
void	update(RequestParams requestParams, String realmName, @Valid Realm realm)

Method Details

getAll

@GET
@Produces("application/json")
Realm[] getAll(@BeanParam
 RequestParams requestParams)

getAccessible

@GET
@Path("accessible")
@Produces("application/json")
Realm[] getAccessible(@BeanParam
 RequestParams requestParams)

Will return realm and display names for accessible realms by authenticated user

get

@GET
@Path("{name}")
@Produces("application/json")
Realm get(@BeanParam
 RequestParams requestParams,
 @PathParam("name")
 String realm)

Regular users can call this, but only to obtain details about their currently authenticated and active realm.

update

@PUT
@Path("{name}")
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
void update(@BeanParam
 RequestParams requestParams,
 @PathParam("name")
 String realmName,
 @Valid
 @Valid Realm realm)

create

@POST
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:admin")
void create(@BeanParam
 RequestParams requestParams,
 @Valid
 @Valid Realm realm)

delete

@DELETE
@Path("{name}")
@Produces("application/json")
@RolesAllowed("write:admin")
void delete(@BeanParam
 RequestParams requestParams,
 @PathParam("name")
 String realm)