aQute.openapi.security.api

Interface OpenAPIAuthenticator

public interface OpenAPIAuthenticator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME Mandatory name as used in Open API TODO
static java.lang.String	TYPE Mandatory base path as used in Open API

Method Summary

Modifier and Type	Method and Description
Authentication	authenticate(HttpServletRequest request, HttpServletResponse response, OpenAPISecurityDefinition dto) Create an authentication object for verifying the authentication state machine.
static java.lang.String	filter(java.lang.String name, java.lang.String type)
default OpenAPISecurityProviderInfo	getInfo(HttpServletRequest request)
default java.net.URI	login(HttpServletRequest request, HttpServletResponse response)
default java.net.URI	logout(HttpServletRequest request, HttpServletResponse response)
default java.net.URI	other(java.lang.String command, HttpServletRequest request, HttpServletResponse response)

Field Detail

NAME

static final java.lang.String NAME

Mandatory name as used in Open API TODO

See Also:

Constant Field Values

TYPE

static final java.lang.String TYPE

Mandatory base path as used in Open API

See Also:

Constant Field Values

Method Detail

filter

static java.lang.String filter(java.lang.String name,
                               java.lang.String type)

authenticate

Authentication authenticate(HttpServletRequest request,
                            HttpServletResponse response,
                            OpenAPISecurityDefinition dto)

Create an authentication object for verifying the authentication state machine.

Parameters:

context - the current context

dto - the security definition

Returns:

an Authentication

login

default java.net.URI login(HttpServletRequest request,
                           HttpServletResponse response)
                    throws java.lang.Exception

Throws:

java.lang.Exception

other

default java.net.URI other(java.lang.String command,
                           HttpServletRequest request,
                           HttpServletResponse response)
                    throws java.lang.Exception

Throws:

java.lang.Exception

logout

default java.net.URI logout(HttpServletRequest request,
                            HttpServletResponse response)
                     throws java.lang.Exception

Throws:

java.lang.Exception

getInfo

default OpenAPISecurityProviderInfo getInfo(HttpServletRequest request)
                                     throws java.lang.Exception

Throws:

java.lang.Exception