io.limberest.service.http

Class RestService<T>

java.lang.Object

io.limberest.service.http.RestService<T>

All Implemented Interfaces:

Service<T>

Direct Known Subclasses:

JsonNodeService, JsonRestService

public abstract class RestService<T>
extends java.lang.Object
implements Service<T>

Constructor Summary

Constructors

Constructor and Description
RestService()

Method Summary

Modifier and Type	Method and Description
boolean	authorize(Request<T> request) Determine whether access to this service is authorized for the authenticated user, if any.
Response<T>	delete(Request<T> request) Delete an existing entity or relationship.
Response<T>	get(Request<T> request) Retrieve an existing entity or relationship.
abstract T	getBody(java.lang.String text)
java.util.List<java.lang.String>	getRolesAllowedAccess(Request<T> request) If the request user belongs to any of these roles, access is granted.
abstract java.lang.String	getText(T body, int prettyIndent)
void	initialize(Request<T> request, java.security.Principal principal, java.util.function.Predicate<java.lang.String> roleChecker) Mechanism for setting up request for authorization
boolean	isAuthenticationRequired(Request<T> request) Return true if authentication is required.
Response<T>	patch(Request<T> request) Patch an existing entity with delta values.
Response<T>	post(Request<T> request) Create a new entity or relationship.
Response<T>	put(Request<T> request) Update an existing entity with different values.
Response<T>	service(Request<T> request) Service a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestService

public RestService()

Method Detail

getBody

public abstract T getBody(java.lang.String text)
                   throws ServiceException

Throws:

ServiceException

getText

public abstract java.lang.String getText(T body,
                                         int prettyIndent)
                                  throws ServiceException

Parameters:

body -

prettyIndent - zero means no pretty print

Returns:

response text

Throws:

ServiceException

initialize

public void initialize(Request<T> request,
                       java.security.Principal principal,
                       java.util.function.Predicate<java.lang.String> roleChecker)
                throws ServiceException

Description copied from interface: Service

Mechanism for setting up request for authorization

Specified by:

initialize in interface Service<T>

Throws:

ServiceException

isAuthenticationRequired

public boolean isAuthenticationRequired(Request<T> request)
                                 throws ServiceException

Return true if authentication is required. Note: Containers may indicate authenticated if authentication not set up.

Specified by:

isAuthenticationRequired in interface Service<T>

Returns:

true if authentication is required

Throws:

ServiceException

authorize

public boolean authorize(Request<T> request)
                  throws ServiceException

Description copied from interface: Service

Determine whether access to this service is authorized for the authenticated user, if any.

Specified by:

authorize in interface Service<T>

Returns:

true if authorized

Throws:

ServiceException

getRolesAllowedAccess

public java.util.List<java.lang.String> getRolesAllowedAccess(Request<T> request)
                                                       throws ServiceException

If the request user belongs to any of these roles, access is granted.

Returns:

set of roles, or null if anyone's allowed NOTE: isAuthenticationRequired(Request) must return true for this to work with Java container authentication.

Throws:

ServiceException

service

public Response<T> service(Request<T> request)
                    throws ServiceException

Description copied from interface: Service

Service a request.

Specified by:

service in interface Service<T>

Returns:

response text

Throws:

ServiceException

get

@GET
public Response<T> get(Request<T> request)
                      throws ServiceException

Retrieve an existing entity or relationship.

Throws:

ServiceException

post

@POST
public Response<T> post(Request<T> request)
                        throws ServiceException

Create a new entity or relationship.

Throws:

ServiceException

put

@PUT
public Response<T> put(Request<T> request)
                      throws ServiceException

Update an existing entity with different values.

Throws:

ServiceException

patch

@PUT
public Response<T> patch(Request<T> request)
                        throws ServiceException

Patch an existing entity with delta values.

Throws:

ServiceException

delete

@DELETE
public Response<T> delete(Request<T> request)
                            throws ServiceException

Delete an existing entity or relationship. Content is supported but not recommended.

Throws:

ServiceException