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

Class AbstractConfigurableRootResource<S extends ConfigurableService,W extends AbstractRootResourceConfigurableWebService<S>>

java.lang.Object

de.aristaflow.ilm.ws.rest.base.service.AbstractRootResource<S,W>

de.aristaflow.ilm.ws.rest.base.service.AbstractConfigurableRootResource<S,W>

Type Parameters:

S - The ADEPT2Service which is exported as REST web service.

W - The AbstractRootResourceConfigurableWebService which transforms between web service calls and the corresponding Java API.

All Implemented Interfaces:

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

Direct Known Subclasses:

ExecutionManagerRest

@Produces("application/json")
@Consumes("application/json")
public abstract class AbstractConfigurableRootResource<S extends ConfigurableService,W extends AbstractRootResourceConfigurableWebService<S>>
extends AbstractRootResource<S,W>

This class extends the REST root resource by the means for managing a configuration. Therefore it corresponds to AbstractRootResourceConfigurableWebService.

See Also:

• AbstractRootResourceConfigurableWebService

Constructor Summary

Constructors

Constructor	Description
AbstractConfigurableRootResource()

Method Summary

Modifier and Type	Method	Description
List<String>	getChangeableConfigurationKeys(jakarta.ws.rs.core.Application unused)
Map<String,String>	getConfiguration(jakarta.ws.rs.core.Application unused)
String	getConfigurationValue(@NotNull String key)
void	setConfigurationValue(@NotNull String key, @NotNull String value)

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

adaptSessionTokenParam, createWebService, ensureReqMaxVersion, ensureReqMinVersion, ensureVersion, exportService, getExceptionHandler, getLogger, getObjectMapper, getRelease, getRequestHandler, getResponseHandler, getServiceInstanceName, getServiceResourceConfig, getUris, getVersion, 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

Constructor Details

AbstractConfigurableRootResource

public AbstractConfigurableRootResource()

Method Details

getConfiguration

@GET
@Path("/complete-configuration")
public Map<String,String> getConfiguration(@Context
 jakarta.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:

• AbstractRootResourceConfigurableWebService.getConfiguration(de.aristaflow.ilm.base.sessionmanagement.SessionToken)

getConfigurationValue

@POST
@Path("/configuration-value")
@Consumes("application/x-www-form-urlencoded")
public String getConfigurationValue(@NotNull @FormParam("key")
 @NotNull String key)

See Also:

• AbstractRootResourceConfigurableWebService.getConfigurationValue(de.aristaflow.ilm.base.sessionmanagement.SessionToken, String)

getChangeableConfigurationKeys

@GET
@Path("/configuration")
public List<String> getChangeableConfigurationKeys(@Context
 jakarta.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:

• AbstractRootResourceConfigurableWebService.getChangeableConfigurationKeys(de.aristaflow.ilm.base.sessionmanagement.SessionToken)

setConfigurationValue

@PUT
@Path("/configuration")
@Consumes("application/x-www-form-urlencoded")
public void setConfigurationValue(@NotNull @FormParam("key")
 @NotNull String key,
 @NotNull @FormParam("value")
 @NotNull String value)

See Also:

• AbstractRootResourceConfigurableWebService.setConfigurationValue(de.aristaflow.ilm.base.sessionmanagement.SessionToken, String, String)