org.springframework.xd.dirt.module.store

Class ModuleMetadata

java.lang.Object

org.springframework.xd.dirt.module.store.ModuleMetadata

All Implemented Interfaces:

java.lang.Comparable<ModuleMetadata>

public class ModuleMetadata
extends java.lang.Object
implements java.lang.Comparable<ModuleMetadata>

Metadata class for modules at runtime. This includes configuration options, runtime deployment properties, container, and the overall status of the deployment unit.

Author:

Ilayaperumal Gopinathan, Patrick Peralta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleMetadata.Id Identity object for instances of ModuleMetadata.

Constructor Summary

Constructors

Constructor and Description
ModuleMetadata(ModuleMetadata.Id id, java.util.Properties moduleOptions, java.util.Properties deploymentProperties, DeploymentUnitStatus.State deploymentStatus) Construct a ModuleMetadata instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ModuleMetadata other)
java.lang.String	getContainerId()
java.util.Properties	getDeploymentProperties() Return the module options configured at deployment time.
DeploymentUnitStatus.State	getDeploymentStatus() Return the state of the deployment unit this module instance belongs to.
java.lang.String	getLabel()
java.util.Properties	getModuleOptions() Return the module options configured during stream/job creation.
ModuleType	getModuleType()
java.lang.String	getName() Return the name for the module instance this metadata object is tracking.
java.lang.String	getQualifiedId()
java.lang.String	getUnitName()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleMetadata

public ModuleMetadata(ModuleMetadata.Id id,
              java.util.Properties moduleOptions,
              java.util.Properties deploymentProperties,
              DeploymentUnitStatus.State deploymentStatus)

Construct a ModuleMetadata instance.

Parameters:

id - unique identifier for module metadata

moduleOptions - options for this module configured during stream/job creation

deploymentProperties - options for this module configured at deployment time

deploymentStatus - status for deployment unit this module is part of

Method Detail

getQualifiedId

public java.lang.String getQualifiedId()

See Also:

ModuleMetadata.Id.getFullyQualifiedId()

getName

public java.lang.String getName()

Return the name for the module instance this metadata object is tracking. The format for this string is "label.index", for example "log.1".

Returns:

name (label + index) for module

getLabel

public java.lang.String getLabel()

See Also:

ModuleMetadata.Id.getModuleLabel()

getUnitName

public java.lang.String getUnitName()

See Also:

ModuleMetadata.Id.getUnitName()

getModuleType

public ModuleType getModuleType()

See Also:

ModuleMetadata.Id.getModuleType()

getContainerId

public java.lang.String getContainerId()

See Also:

ModuleMetadata.Id.getContainerId()

getModuleOptions

public java.util.Properties getModuleOptions()

Return the module options configured during stream/job creation.

Returns:

module options set at creation

getDeploymentProperties

public java.util.Properties getDeploymentProperties()

Return the module options configured at deployment time.

Returns:

module options set at deployment

getDeploymentStatus

public DeploymentUnitStatus.State getDeploymentStatus()

Return the state of the deployment unit this module instance belongs to.

Returns:

deployment unit (stream or job) for this module instance

compareTo

public int compareTo(ModuleMetadata other)

Specified by:

compareTo in interface java.lang.Comparable<ModuleMetadata>