Class BrandingAssetSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

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

public class BrandingAssetSpecV1
extends AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

GET /branding/{role}: the app's declared branding image (logo or icon), before sign-in, so a login screen (or a standalone frontend server) can show it through the UI API (QRun-IO/qqq#1035). Fixed roles only: no path comes from the caller. Since UI API 1.6.0.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
BrandingAssetSpecV1()

Method Summary

Modifier and Type	Method	Description
AbstractMiddlewareInput	buildInput(io.javalin.http.Context context)	No input: serveRequest is overridden.
BasicOperation	defineBasicOperation()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
Map<Integer,Response>	defineResponses()
boolean	isSecured()
AbstractMiddlewareOutputInterface	serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion, io.javalin.http.Context context)	Serve the image directly (no executor, no session).

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineBasicSuccessResponse, defineCompleteOperation, defineMethod, defineRequestBody, defineRoute, getOpenApiOperationId, getOperationId, 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

BrandingAssetSpecV1

public BrandingAssetSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

isSecured

public boolean isSecured()

Overrides:

isSecured in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineResponses

public Map<Integer,Response> defineResponses()

Overrides:

defineResponses in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

buildInput

public AbstractMiddlewareInput buildInput(io.javalin.http.Context context)

No input: serveRequest is overridden.

Specified by:

buildInput in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

serveRequest

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

Serve the image directly (no executor, no session).

Overrides:

serveRequest in class AbstractEndpointSpec<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface,AbstractMiddlewareExecutor<AbstractMiddlewareInput,AbstractMiddlewareOutputInterface>>

Throws:

Exception