Package de.iip_ecosphere.platform.services.environment

Class FamilyServiceStub

java.lang.Object

de.iip_ecosphere.platform.services.environment.AbstractService

de.iip_ecosphere.platform.services.environment.DefaultServiceImpl

de.iip_ecosphere.platform.services.environment.FamilyServiceStub

All Implemented Interfaces:

ParameterConfigurerProvider, Service, ServiceBase

public class FamilyServiceStub
extends DefaultServiceImpl

Family service implementations are supposed to delegate their operations to the (alternative) active family member. Thus, there may not be a fully fledged service implementation for the family and management operations may just not work. This class is a basis for a no-operation service (stub) that delegates relevant operations to its active service. To not further interfere with the switching mechanism, the active service is provided via a supplier. Currently, not all management operations are supported, e.g., migrate, switch etc. are missing (in the ServiceBase interface).

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private Supplier<ServiceBase>	active

Fields inherited from interface de.iip_ecosphere.platform.services.environment.Service

START_COMPARATOR

Fields inherited from interface de.iip_ecosphere.platform.services.environment.switching.ServiceBase

APPLICATION_SEPARATOR, DEFAULT_APPLICATION_INSTANCE_ID

Constructor Summary

Constructors

Constructor	Description
FamilyServiceStub(String serviceId, InputStream ymlFile)	Creates a family service stub from a service id and a YAML artifact.

Method Summary

Modifier and Type	Method	Description
ServiceState	getState()	Returns the state the service is currently in.
void	setActiveMemberSupplier(Supplier<ServiceBase> active)	Changes the active service member.
void	setState(ServiceState state)	Changes the state.
void	update(URI location)	Updates the service by the service in the given location.

Methods inherited from class de.iip_ecosphere.platform.services.environment.DefaultServiceImpl

migrate, switchTo

Methods inherited from class de.iip_ecosphere.platform.services.environment.AbstractService

activate, addConfigurer, addConfigurer, addConfigurer, addTypeSubstitution, createGenericInstance, createGenericInstance, createGenericInstanceByPlugin, createGenericMultiInstance, createGenericMultiInstance, createGenericMultiInstanceByPlugin, createInstance, createInstance, createInstance, createInstanceByPlugin, getArg, getArtifact, getDescription, getId, getKind, getName, getNetMgtKeyAddress, getResourceAsStream, getStringArg, getSubstitutedType, getTypeCreator, getTypeSubstitutions, getVersion, initializeFrom, isDeployable, isTopLevel, notifyReconfigured, passivate, reconf, reconfigure, reconfigure, rollbackReconfigurationOnFailure, setLibJars, start, stop, transferData, transferState

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.services.environment.Service

createType, createType, getParameterConfigurer, getParameterNames, startData, stopData

Field Details

active

private Supplier<ServiceBase> active

Constructor Details

FamilyServiceStub

public FamilyServiceStub(String serviceId,
 InputStream ymlFile)

Creates a family service stub from a service id and a YAML artifact.

Parameters:

serviceId - the service id

ymlFile - the YML file containing the YAML artifact with the service descriptor

Method Details

setActiveMemberSupplier

public void setActiveMemberSupplier(Supplier<ServiceBase> active)

Changes the active service member.

Parameters:

active - the new active member

setState

public void setState(ServiceState state)
              throws ExecutionException

Description copied from class: AbstractService

Changes the state. [R133c]

Specified by:

setState in interface ServiceBase

Overrides:

setState in class AbstractService

Parameters:

state - the new state

Throws:

ExecutionException - if changing the state fails for some reason

See Also:

• AbstractService.start()
• AbstractService.stop()

getState

public ServiceState getState()

Description copied from interface: ServiceBase

Returns the state the service is currently in. [R4c]

Specified by:

getState in interface ServiceBase

Overrides:

getState in class AbstractService

Returns:

the state

update

public void update(URI location)
            throws ExecutionException

Description copied from interface: Service

Updates the service by the service in the given location. This operation is responsible for stopping the running service (if needed), replacing it, starting the new service.

Specified by:

update in interface Service

Overrides:

update in class DefaultServiceImpl

Parameters:

location - the location of the new service, e.g., an URL

Throws:

ExecutionException - if the given service cannot be updated for some reason, e.g., because the replacement service is not an evolved version of the running service