Class LogoutSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

com.kingsrook.qqq.middleware.javalin.specs.v1.LogoutSpecV1

public class LogoutSpecV1
extends AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

Endpoint spec for logging out a session.

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
LogoutSpecV1()

Method Summary

Modifier and Type	Method	Description
LogoutInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
boolean	isSecured()
LogoutResponseV1	serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion, io.javalin.http.Context context)

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, defineRequestParameters, defineResponses, defineRoute, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, handleOutput, newExecutor, newOutput, setQInstance

Methods inherited from class java.lang.Object

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

Constructor Details

LogoutSpecV1

public LogoutSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

isSecured

public boolean isSecured()

Overrides:

isSecured in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

serveRequest

public LogoutResponseV1 serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion,
 io.javalin.http.Context context)
                              throws Exception

Overrides:

serveRequest in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

Throws:

Exception

buildInput

public LogoutInput buildInput(io.javalin.http.Context context)
                       throws Exception

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

Throws:

Exception

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<LogoutInput,LogoutResponseV1,LogoutExecutor>