Package de.iip_ecosphere.platform.services

Class AbstractServiceDescriptor<A extends ArtifactDescriptor>

java.lang.Object

de.iip_ecosphere.platform.services.AbstractServiceDescriptor<A>

Type Parameters:

A - the type of artifact descriptor

All Implemented Interfaces:

ServiceDescriptor

public abstract class AbstractServiceDescriptor<A extends ArtifactDescriptor>
extends Object
implements ServiceDescriptor

Abstract ServiceDescriptor implementation, e.g., including a representation of the ServiceState statemachine. We do not protect the setters here explicitly, e.g., through a builder pattern as we assume that the respective messages will only be called within the package of the implementing manager. Holds a ServiceStub while the underlying service instance is operational. Must be set by the service manager, will be released when state goes to ServiceState.STOPPING.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.services.ServiceDescriptor

ServiceDescriptor.Action

Field Summary

Fields

Modifier and Type	Field	Description
private Map<ServiceDescriptor.Action,Runnable>	actions
private List<String>	additionalArgs
private String	applicationId
private A	artifact
private String	description
private String	id
private List<TypedDataConnectorDescriptor>	input
private boolean	isDeployable
private boolean	isTopLevel
private de.iip_ecosphere.platform.services.environment.ServiceKind	kind
private String	name
private List<TypedDataConnectorDescriptor>	output
private List<TypedDataDescriptor>	parameters
private de.iip_ecosphere.platform.services.environment.ServiceState	state
private de.iip_ecosphere.platform.services.environment.ServiceStub	stub
private de.iip_ecosphere.platform.support.Version	version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractServiceDescriptor(String id, String applicationId, String name, String description, de.iip_ecosphere.platform.support.Version version)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
protected void	addInputDataConnector(TypedDataConnectorDescriptor input)	Adds an input descriptor.
protected void	addOutputDataConnector(TypedDataConnectorDescriptor output)	Adds an output descriptor.
protected void	addParameter(TypedDataDescriptor parameter)	Adds a parameter descriptor.
void	attachAction(ServiceDescriptor.Action action, Runnable run)	Attaches a runnable to an action.
static Set<String>	connectorIds(Collection<TypedDataConnectorDescriptor> cons)	Returns all connector ids for the connectors in cons.
static Set<ServiceDescriptor>	ensemble(ServiceDescriptor service)	Returns all services in the same ensemble.
static Set<String>	ensembleConnectorNames(ServiceDescriptor service)	Returns the names of all channel names of connectors within the ensemble of service.
protected void	executeAction(ServiceDescriptor.Action action)	If there is a registered runnable for action, execute it.
List<String>	getAdditionalArguments()	Returns the additional arguments to be passed on during service start.
String	getApplicationId()	Returns the application id this service is assigned to (without application instance id).
A	getArtifact()	Returns the containing artifact.
protected abstract Class<A>	getArtifactDescriptorClass()	Returns the utilized artifact descriptor class.
List<TypedDataConnectorDescriptor>	getDataConnectors()	Returns all (asynchronous) connectors from this service.
String	getDescription()	The description of the service.
ServiceDescriptor	getEnsembleLeader()	Returns the ensemble leader service, i.e., if multiple services are packaged together and shall be executed in the same process, it is important to synchronize aspects (via the ensemble leader service).
String	getId()	Returns the unique id of the service.
List<TypedDataConnectorDescriptor>	getInputDataConnectors()	Returns all (asynchronous) input connectors into this service.
de.iip_ecosphere.platform.services.environment.ServiceKind	getKind()	Returns the service kind.
String	getName()	The name of the service.
List<TypedDataConnectorDescriptor>	getOutputDataConnectors()	Returns all (asynchronous) output connectors from this service.
List<TypedDataDescriptor>	getParameters()	Returns all information about parameter for ServiceOperations.reconfigureService(String, Map).
de.iip_ecosphere.platform.services.environment.ServiceState	getState()	Returns the state the service is currently in.
protected de.iip_ecosphere.platform.services.environment.ServiceStub	getStub()	Returns a service stub to control the service when it is running.
de.iip_ecosphere.platform.support.Version	getVersion()	The version of the service.
protected void	instantiateFrom(AbstractServiceDescriptor<A> template)	Does further initialization after AbstractServiceDescriptor(String, String, String, String, Version) to instantiate an instance from template.
protected void	instantiateFrom(AbstractServiceDescriptor<A> template, boolean addParameters, boolean addConnectors)	Does further initialization after AbstractServiceDescriptor(String, String, String, String, Version) to instantiate an instance from template.
static Set<String>	internalConnectorNames(Collection<? extends ServiceDescriptor> services)	Returns the ids of all connectors within services.
boolean	isDeployable()	Returns whether the service is deployable in distributable manner or fixed in deployment location.
boolean	isTopLevel()	Returns whether the service is top-level or nested, e.g., as family member.
void	setAdditionalArguments(List<String> additionalArgs)	Defines additional arguments to be passed on during service start.
protected void	setArtifact(ArtifactDescriptor artifact)	Defines an artifact.
protected void	setClassification(de.iip_ecosphere.platform.services.environment.ServiceKind kind, boolean isDeployable, boolean isTopLevel)	Sets the classification of this service.
void	setState(de.iip_ecosphere.platform.services.environment.ServiceState state)	Changes the state.
protected void	setStub(de.iip_ecosphere.platform.services.environment.ServiceStub stub)	Defines the actual service stub.

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.ServiceDescriptor

getApplicationInstanceId, getInvocablesCreator, getServiceId

Field Details

id

private String id

applicationId

private String applicationId

name

private String name

description

private String description

version

private de.iip_ecosphere.platform.support.Version version

artifact

private A extends ArtifactDescriptor artifact

state

private de.iip_ecosphere.platform.services.environment.ServiceState state

kind

private de.iip_ecosphere.platform.services.environment.ServiceKind kind

isDeployable

private boolean isDeployable

isTopLevel

private boolean isTopLevel

parameters

private List<TypedDataDescriptor> parameters

input

private List<TypedDataConnectorDescriptor> input

output

private List<TypedDataConnectorDescriptor> output

stub

private de.iip_ecosphere.platform.services.environment.ServiceStub stub

additionalArgs

private List<String> additionalArgs

actions

private Map<ServiceDescriptor.Action,Runnable> actions

Constructor Details

AbstractServiceDescriptor

protected AbstractServiceDescriptor(String id,
 String applicationId,
 String name,
 String description,
 de.iip_ecosphere.platform.support.Version version)

Creates an instance. Call setClassification(ServiceKind, boolean, boolean) afterwards.

Parameters:

id - the service id

applicationId - the application id, may be empty for default application/legacy

name - the name of this service

description - the description of the service

version - the version

Method Details

instantiateFrom

protected void instantiateFrom(AbstractServiceDescriptor<A> template)

Does further initialization after AbstractServiceDescriptor(String, String, String, String, Version) to instantiate an instance from template. By default, adds parameters and connectors.

Parameters:

template - the descriptor being used as template

See Also:

• instantiateFrom(AbstractServiceDescriptor, boolean, boolean)

instantiateFrom

protected void instantiateFrom(AbstractServiceDescriptor<A> template,
 boolean addParameters,
 boolean addConnectors)

Does further initialization after AbstractServiceDescriptor(String, String, String, String, Version) to instantiate an instance from template.

Parameters:

template - the descriptor being used as template

addParameters - add the parameters from template

addConnectors - add the input/output connectors from template

getArtifactDescriptorClass

protected abstract Class<A> getArtifactDescriptorClass()

Returns the utilized artifact descriptor class.

Returns:

the class

setArtifact

protected void setArtifact(ArtifactDescriptor artifact)

Defines an artifact.

Parameters:

artifact - the containing artifact descriptor

setClassification

protected void setClassification(de.iip_ecosphere.platform.services.environment.ServiceKind kind,
 boolean isDeployable,
 boolean isTopLevel)

Sets the classification of this service. If not called, default values will be used.

Parameters:

kind - the service kind

isDeployable - whether the service can be deployed in distributed manner or not (fixed, centralized)

isTopLevel - whether the service is a top-level service or whether it is nested, e.g., family member

getEnsembleLeader

public ServiceDescriptor getEnsembleLeader()

Description copied from interface: ServiceDescriptor

Returns the ensemble leader service, i.e., if multiple services are packaged together and shall be executed in the same process, it is important to synchronize aspects (via the ensemble leader service).

Specified by:

getEnsembleLeader in interface ServiceDescriptor

Returns:

the ensemble leader, may be null if there is none

getId

public String getId()

Description copied from interface: ServiceDescriptor

Returns the unique id of the service.

Specified by:

getId in interface ServiceDescriptor

Returns:

the id (may contain the application id and the application instance id if specified)

getApplicationId

public String getApplicationId()

Description copied from interface: ServiceDescriptor

Returns the application id this service is assigned to (without application instance id).

Specified by:

getApplicationId in interface ServiceDescriptor

Returns:

the application id

getName

public String getName()

Description copied from interface: ServiceDescriptor

The name of the service.

Specified by:

getName in interface ServiceDescriptor

Returns:

the name

getVersion

public de.iip_ecosphere.platform.support.Version getVersion()

Description copied from interface: ServiceDescriptor

The version of the service.

Specified by:

getVersion in interface ServiceDescriptor

Returns:

the version

getDescription

public String getDescription()

Description copied from interface: ServiceDescriptor

The description of the service.

Specified by:

getDescription in interface ServiceDescriptor

Returns:

the description, may be empty

getState

public de.iip_ecosphere.platform.services.environment.ServiceState getState()

Description copied from interface: ServiceDescriptor

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

Specified by:

getState in interface ServiceDescriptor

Returns:

the state

setState

public void setState(de.iip_ecosphere.platform.services.environment.ServiceState state)
              throws ExecutionException

Description copied from interface: ServiceDescriptor

Changes the state. [R133c]

Specified by:

setState in interface ServiceDescriptor

Parameters:

state - the new state

Throws:

ExecutionException - if changing the state fails for some reason

isDeployable

public boolean isDeployable()

Description copied from interface: ServiceDescriptor

Returns whether the service is deployable in distributable manner or fixed in deployment location.

Specified by:

isDeployable in interface ServiceDescriptor

Returns:

true for deployable, false for fixed

isTopLevel

public boolean isTopLevel()

Description copied from interface: ServiceDescriptor

Returns whether the service is top-level or nested, e.g., as family member.

Specified by:

isTopLevel in interface ServiceDescriptor

Returns:

true for top-level, false else

getKind

public de.iip_ecosphere.platform.services.environment.ServiceKind getKind()

Description copied from interface: ServiceDescriptor

Returns the service kind.

Specified by:

getKind in interface ServiceDescriptor

Returns:

the service kind

getArtifact

public A getArtifact()

Description copied from interface: ServiceDescriptor

Returns the containing artifact.

Specified by:

getArtifact in interface ServiceDescriptor

Returns:

the containing artifact (descriptor)

getParameters

public List<TypedDataDescriptor> getParameters()

Description copied from interface: ServiceDescriptor

Returns all information about parameter for ServiceOperations.reconfigureService(String, Map).

Specified by:

getParameters in interface ServiceDescriptor

Returns:

the name-descriptor mapping for all supported parameters

getInputDataConnectors

public List<TypedDataConnectorDescriptor> getInputDataConnectors()

Description copied from interface: ServiceDescriptor

Returns all (asynchronous) input connectors into this service.

Specified by:

getInputDataConnectors in interface ServiceDescriptor

Returns:

all input channels, may contain other-sided connectors where TypedDataConnectorDescriptor.getService() is not ServiceDescriptor.getId()

getOutputDataConnectors

public List<TypedDataConnectorDescriptor> getOutputDataConnectors()

Description copied from interface: ServiceDescriptor

Returns all (asynchronous) output connectors from this service.

Specified by:

getOutputDataConnectors in interface ServiceDescriptor

Returns:

all input channels, may contain other-sided connectors where TypedDataConnectorDescriptor.getService() is not ServiceDescriptor.getId()

getDataConnectors

public List<TypedDataConnectorDescriptor> getDataConnectors()

Description copied from interface: ServiceDescriptor

Returns all (asynchronous) connectors from this service.

Specified by:

getDataConnectors in interface ServiceDescriptor

Returns:

all channels, may contain other-sided connectors where TypedDataConnectorDescriptor.getService() is not ServiceDescriptor.getId()

See Also:

• ServiceDescriptor.getInputDataConnectors()
• ServiceDescriptor.getOutputDataConnectors()

getStub

protected de.iip_ecosphere.platform.services.environment.ServiceStub getStub()

Returns a service stub to control the service when it is running.

Returns:

the service stub (may be null if the service is only available or about to be removed)

setStub

protected void setStub(de.iip_ecosphere.platform.services.environment.ServiceStub stub)

Defines the actual service stub.

Parameters:

stub - the stub

addParameter

protected void addParameter(TypedDataDescriptor parameter)

Adds a parameter descriptor.

Parameters:

parameter - the descriptor

addInputDataConnector

protected void addInputDataConnector(TypedDataConnectorDescriptor input)

Adds an input descriptor.

Parameters:

input - the descriptor

addOutputDataConnector

protected void addOutputDataConnector(TypedDataConnectorDescriptor output)

Adds an output descriptor.

Parameters:

output - the descriptor

setAdditionalArguments

public void setAdditionalArguments(List<String> additionalArgs)

Description copied from interface: ServiceDescriptor

Defines additional arguments to be passed on during service start.

Specified by:

setAdditionalArguments in interface ServiceDescriptor

Parameters:

additionalArgs - the arguments, may be empty or null for none

getAdditionalArguments

public List<String> getAdditionalArguments()

Description copied from interface: ServiceDescriptor

Returns the additional arguments to be passed on during service start.

Specified by:

getAdditionalArguments in interface ServiceDescriptor

Returns:

the arguments, may be empty or null for none

ensemble

public static Set<ServiceDescriptor> ensemble(ServiceDescriptor service)

Returns all services in the same ensemble. [public, static for testing]

Parameters:

service - the service to return the ensemble (in the same artifact) for

Returns:

all services in the same ensemble

ensembleConnectorNames

public static Set<String> ensembleConnectorNames(ServiceDescriptor service)

Returns the names of all channel names of connectors within the ensemble of service.

Parameters:

service - the service to return the channel names for

Returns:

all channel names of connectors within the ensemble of service

internalConnectorNames

public static Set<String> internalConnectorNames(Collection<? extends ServiceDescriptor> services)

Returns the ids of all connectors within services.

Parameters:

services - the services to return the internal channel names for

Returns:

all ids of connectors within the ensemble of service

connectorIds

public static Set<String> connectorIds(Collection<TypedDataConnectorDescriptor> cons)

Returns all connector ids for the connectors in cons.

Parameters:

cons - the connectors

Returns:

the connector ids

attachAction

public void attachAction(ServiceDescriptor.Action action,
 Runnable run)

Description copied from interface: ServiceDescriptor

Attaches a runnable to an action.

Specified by:

attachAction in interface ServiceDescriptor

Parameters:

action - the action

run - the runnable

executeAction

protected void executeAction(ServiceDescriptor.Action action)

If there is a registered runnable for action, execute it.

Parameters:

action - the action to look for