io.limberest.service

Interface Service<T>

All Known Implementing Classes:

JsonNodeService, JsonRestService, RestService

public interface Service<T>

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.
default void	initialize(Request<T> request, java.security.Principal principal, java.util.function.Predicate<java.lang.String> roleCheck) Mechanism for setting up request for authorization
boolean	isAuthenticationRequired(Request<T> request) Should access to this service require authentication?
Response<T>	service(Request<T> request) Service a request.

Method Detail

isAuthenticationRequired

boolean isAuthenticationRequired(Request<T> request)
                          throws ServiceException

Should access to this service require authentication?

Parameters:

request -

Returns:

true if authentication is required

Throws:

ServiceException

authorize

boolean authorize(Request<T> request)
           throws ServiceException

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

Parameters:

request -

Returns:

true if authorized

Throws:

ServiceException

service

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

Service a request.

Parameters:

request -

Returns:

response text

Throws:

ServiceException

initialize

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

Mechanism for setting up request for authorization

Parameters:

request -

principal -

roleCheck -

Throws:

ServiceException