Package com.idmedia.translationstudio.api.rest

Interface IEndpoint

public interface IEndpoint

REST Endpoint

Author:

I-D Media AG

Method Summary

Modifier and Type	Method	Description
boolean	grantAccess(@NotNull IJWTInformation pJWTInformation)	Evaluate JWT
@NotNull IEndpointResponse	handleRequest(@NotNull IRestRequest request, @NotNull Map<String,String> pParameters)
@NotNull IEndpoint	requestInstance()	Create an instance of this handler, either a new one or a singleton
boolean	requireValidAccessKey()	Handler requires valid access key in in Authorization header of type Authorization: Bearer "xyz"
boolean	requireValidJWT()	Handler requires valid JWT in Authorization header
void	updateMetrics()	Update metrics

Method Details

requestInstance

@NotNull
@NotNull IEndpoint requestInstance()

Create an instance of this handler, either a new one or a singleton

Returns:

handleRequest

@NotNull
@NotNull IEndpointResponse handleRequest(@NotNull
 @NotNull IRestRequest request,
 @NotNull
 @NotNull Map<String,String> pParameters)
                                  throws InternalServerErrorException,
BadRequestException,
RuntimeException

Parameters:

request -

pParameters -

Returns:

Throws:

InternalServerErrorException

BadRequestException

RuntimeException

updateMetrics

void updateMetrics()

Update metrics

requireValidJWT

boolean requireValidJWT()

Handler requires valid JWT in Authorization header

Returns:

requireValidAccessKey

boolean requireValidAccessKey()

Handler requires valid access key in in Authorization header of type Authorization: Bearer "xyz"

Returns:

grantAccess

boolean grantAccess(@NotNull
 @NotNull IJWTInformation pJWTInformation)

Evaluate JWT

Parameters:

pJWTInformation -

Returns: