aQute.openapi.security.environment.api

Interface OpenAPISecurityEnvironment

public interface OpenAPISecurityEnvironment

Abstracts an application's user oriented security model. The idea is that authenticators will find a defined user by, for example, its email. They then can look for passwords or other credentials in the properties to authenticate that user. The OpenAPI Runtime then uses the authenticated user to run the request in a thread that is marked with the authenticated user.

Method Summary

Modifier and Type	Method and Description
<T> T	dispatch(java.lang.String authenticatedUser, java.lang.String base, java.lang.String operation, java.util.concurrent.Callable<T> request) Dispatch the request and associate the authenticated user.
java.util.Optional<byte[]>	getCredential(java.lang.String user, java.lang.String key) Get a credential for a user.
java.util.Optional<java.lang.String>	getProperty(java.lang.String user, java.lang.String key) Get a property for a given user
java.util.Optional<java.lang.String>	getUser(java.lang.String userId) Get the user currently associated with the thread.
java.util.Optional<java.lang.String>	getUser(java.lang.String key, java.lang.String value) Return a user id for a user that has the given value for the given key
default boolean	handleException(java.lang.Exception exception, java.lang.String operation, HttpServletRequest request, HttpServletResponse response) Handle any exceptions throw by the user code.
default boolean	hasPermission(java.lang.String action, java.lang.String... arguments) Answer if the user associated with this thread has the following permission
void	setCredential(java.lang.String user, java.lang.String key, byte[] value) Set a credential for a user.
void	setProperty(java.lang.String user, java.lang.String key, java.lang.String value) Set a property for a user.

Method Detail

getProperty

java.util.Optional<java.lang.String> getProperty(java.lang.String user,
                                                 java.lang.String key)

Get a property for a given user

Parameters:

user - the user id

key - the property key

Returns:

the value or null to remove

setProperty

void setProperty(java.lang.String user,
                 java.lang.String key,
                 java.lang.String value)

Set a property for a user. Will create the user if it does not exist yet

Parameters:

user - the user, not null

key - the key

value - the value

setCredential

void setCredential(java.lang.String user,
                   java.lang.String key,
                   byte[] value)

Set a credential for a user. Will create the user if it does not exist yet

Parameters:

user - the user, not null

key - the key

value - the value

getCredential

java.util.Optional<byte[]> getCredential(java.lang.String user,
                                         java.lang.String key)

Get a credential for a user. Will create the user if it does not exist yet

Parameters:

user -

key -

Returns:

the value

getUser

java.util.Optional<java.lang.String> getUser(java.lang.String key,
                                             java.lang.String value)

Return a user id for a user that has the given value for the given key

Parameters:

user - the user id

key - the property key

value - the expected value

Returns:

the associated user id

dispatch

<T> T dispatch(java.lang.String authenticatedUser,
               java.lang.String base,
               java.lang.String operation,
               java.util.concurrent.Callable<T> request)
        throws java.lang.Exception

Dispatch the request and associate the authenticated user. After running, the current user is restored.

Parameters:

authenticatedUser - the user or null if not authenticated

request -

Returns:

the return value of the request

Throws:

java.lang.Exception

getUser

java.util.Optional<java.lang.String> getUser(java.lang.String userId)

Get the user currently associated with the thread.

Parameters:

userId -

Returns:

hasPermission

default boolean hasPermission(java.lang.String action,
                              java.lang.String... arguments)

Answer if the user associated with this thread has the following permission

Parameters:

action - the action to perform

arguments - the arguments of the action

Returns:

true if the permission is granted, false otherwise

handleException

default boolean handleException(java.lang.Exception exception,
                                java.lang.String operation,
                                HttpServletRequest request,
                                HttpServletResponse response)

Handle any exceptions throw by the user code. If this returns true, the the method handled the exception and the runtime should not further touch the exception nor the servlet response. If it returns false, the normal exception processing is used. This method is not called for the ResponseExceptions since they are not real exceptions but only used for their alternative flow.

Parameters:

exception - Any exception by user code

operation - The operation id

request - The servlet request

response - The servlet response. The output can of course already be (partially) committed.

Returns:

true if the exception is handled, false if the runtime must handle it.