Package de.aristaflow.ilm.ws.rest.base.licensing

Class LicenceManagerRest

java.lang.Object

de.aristaflow.ilm.ws.rest.base.service.AbstractRootResource<LicenceManager,LicenceManagerWebService>

de.aristaflow.ilm.ws.rest.base.licensing.LicenceManagerRest

All Implemented Interfaces:

de.aristaflow.adept2.base.communication.rest.ServiceResource

@Path("/")
public class LicenceManagerRest
extends AbstractRootResource<LicenceManager,LicenceManagerWebService>

See Also:

LicenceManagerWebService

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION	The current API version of this REST web service.

Constructor Summary

Constructors

Constructor	Description
LicenceManagerRest()

Method Summary

Modifier and Type	Method	Description
void	addQualifiedAgentIdsToModel(QualifiedAgentIds qais)	This method just serves to add its parameter to the OpenAPI model, e. g. to have type inheritance which would get missed in case the parent classes are not part of the model.
protected LicenceManagerWebService	createWebService(LicenceManager serv, ServiceMetaData smd)	Creates the generic web service implementation for the designated service.
@NotNull @Valid LicenceInformation	getLicenceInformation(javax.ws.rs.core.Application unused)
protected String	getVersion()	Gets the current API version of this REST web service.

Methods inherited from class de.aristaflow.ilm.ws.rest.base.service.AbstractRootResource

adaptSessionTokenParam, ensureReqMaxVersion, ensureReqMinVersion, ensureVersion, exportService, getExceptionHandler, getLogger, getObjectMapper, getRelease, getRequestHandler, getResponseHandler, getServiceInstanceName, getServiceResourceConfig, getUris, getWebService, headerData, init, ping, registerSse, unregisterService, unregisterSse

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

The current API version of this REST web service.

See Also:

Constant Field Values

Constructor Detail

LicenceManagerRest

public LicenceManagerRest()

Method Detail

getVersion

protected String getVersion()

Description copied from class: AbstractRootResource

Gets the current API version of this REST web service.

Specified by:

getVersion in class AbstractRootResource<LicenceManager,LicenceManagerWebService>

Returns:

The current API version of this REST web service.

createWebService

protected LicenceManagerWebService createWebService(LicenceManager serv,
                                                    ServiceMetaData smd)

Description copied from class: AbstractRootResource

Creates the generic web service implementation for the designated service.

Specified by:

createWebService in class AbstractRootResource<LicenceManager,LicenceManagerWebService>

Parameters:

serv - The service instance for which to create a generic web service implementation.

smd - The service meta data for provision to the sub resources.

Returns:

The generic web service implementation for the designated service.

getLicenceInformation

@GET
@Path("/licence")
@NotNull
@Valid
public @NotNull @Valid LicenceInformation getLicenceInformation(@Context
                                                                javax.ws.rs.core.Application unused)

Parameters:

unused - This unused parameter just prevents Bean Validation from treating this method as simple getter and calling it arbitrarily even without request context.

See Also:

LicenceManagerWebService.getLicenceInformation()

addQualifiedAgentIdsToModel

@POST
@Path("/qasi/model-types")
public void addQualifiedAgentIdsToModel(QualifiedAgentIds qais)

This method just serves to add its parameter to the OpenAPI model, e. g. to have type inheritance which would get missed in case the parent classes are not part of the model.

Without this, QualifiedAgent would not be a subclass of QualifiedAgentIds.