com.mesosphere.sdk.specification

Class DefaultServiceSpec

java.lang.Object

com.mesosphere.sdk.specification.DefaultServiceSpec

All Implemented Interfaces:

Configuration, ServiceSpec

public class DefaultServiceSpec
extends java.lang.Object
implements ServiceSpec

Default implementation of ServiceSpec.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultServiceSpec.Builder DefaultServiceSpec builder static inner class.
static class	DefaultServiceSpec.Comparator Comparer which checks for equality of DefaultServiceSpecs.
static class	DefaultServiceSpec.ConfigFactory Factory which performs the inverse of Configuration.getBytes().
static class	DefaultServiceSpec.Generator Generates a ServiceSpec from a given YAML definition in the form of a RawServiceSpec.

Field Summary

Fields inherited from interface com.mesosphere.sdk.config.Configuration

CHARSET

Constructor Summary

Constructors

Constructor and Description
DefaultServiceSpec(java.lang.String name, java.lang.String role, java.lang.String principal, java.lang.String webUrl, java.lang.String zookeeperConnection, java.util.List<PodSpec> pods, ReplacementFailurePolicy replacementFailurePolicy, java.lang.String user)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static ConfigurationComparator<ServiceSpec>	getComparatorInstance() Returns a ConfigurationComparator which may be used to compare DefaultServiceSpecs.
static ConfigurationFactory<ServiceSpec>	getConfigurationFactory(ServiceSpec serviceSpec) Returns a DefaultServiceSpec.ConfigFactory which may be used to deserialize DefaultServiceSpecs, which has been confirmed to successfully and consistently serialize/deserialize the provided ServiceSpecification instance.
static ConfigurationFactory<ServiceSpec>	getConfigurationFactory(ServiceSpec serviceSpec, java.util.Collection<java.lang.Class<?>> additionalSubtypesToRegister) Returns a DefaultServiceSpec.ConfigFactory which may be used to deserialize DefaultServiceSpecs, which has been confirmed to successfully and consistently serialize/deserialize the provided ServiceSpecification instance.
java.lang.String	getName()
java.util.List<PodSpec>	getPods()
java.lang.String	getPrincipal()
java.util.Optional<ReplacementFailurePolicy>	getReplacementFailurePolicy()
java.lang.String	getRole()
java.lang.String	getUser()
(package private) static java.lang.String	getUser(java.lang.String user, java.util.List<PodSpec> podSpecs)
java.lang.String	getWebUrl()
java.lang.String	getZookeeperConnection()
int	hashCode()
static DefaultServiceSpec.Builder	newBuilder()
static DefaultServiceSpec.Builder	newBuilder(ServiceSpec copy)
static DefaultServiceSpec.Generator	newGenerator(java.io.File rawServiceSpecFile, SchedulerConfig schedulerConfig) Used by unit tests.
static DefaultServiceSpec.Generator	newGenerator(RawServiceSpec rawServiceSpec, SchedulerConfig schedulerConfig, java.io.File configTemplateDir) Returns a new generator with the provided configuration.
static DefaultServiceSpec.Generator	newGenerator(RawServiceSpec rawServiceSpec, SchedulerConfig schedulerConfig, java.util.Map<java.lang.String,java.lang.String> schedulerEnvironment, java.io.File configTemplateDir) Used by unit tests.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mesosphere.sdk.config.Configuration

getBytes, toJsonString

Constructor Detail

DefaultServiceSpec

public DefaultServiceSpec(java.lang.String name,
                          java.lang.String role,
                          java.lang.String principal,
                          java.lang.String webUrl,
                          java.lang.String zookeeperConnection,
                          java.util.List<PodSpec> pods,
                          ReplacementFailurePolicy replacementFailurePolicy,
                          java.lang.String user)

Method Detail

getUser

static java.lang.String getUser(java.lang.String user,
                                java.util.List<PodSpec> podSpecs)

newGenerator

public static DefaultServiceSpec.Generator newGenerator(RawServiceSpec rawServiceSpec,
                                                        SchedulerConfig schedulerConfig,
                                                        java.io.File configTemplateDir)

Returns a new generator with the provided configuration.

Parameters:

rawServiceSpec - The object model representation of a Service Specification YAML file

schedulerConfig - Scheduler configuration containing operator-facing knobs

configTemplateDir - Path to the directory containing any config templates for the service, often the same directory as the Service Specification YAML file

newGenerator

public static DefaultServiceSpec.Generator newGenerator(java.io.File rawServiceSpecFile,
                                                        SchedulerConfig schedulerConfig)
                                                 throws java.lang.Exception

Used by unit tests.

Throws:

java.lang.Exception

newGenerator

public static DefaultServiceSpec.Generator newGenerator(RawServiceSpec rawServiceSpec,
                                                        SchedulerConfig schedulerConfig,
                                                        java.util.Map<java.lang.String,java.lang.String> schedulerEnvironment,
                                                        java.io.File configTemplateDir)
                                                 throws java.lang.Exception

Used by unit tests.

Throws:

java.lang.Exception

newBuilder

public static DefaultServiceSpec.Builder newBuilder()

newBuilder

public static DefaultServiceSpec.Builder newBuilder(ServiceSpec copy)

getName

public java.lang.String getName()

Specified by:

getName in interface ServiceSpec

getRole

public java.lang.String getRole()

Specified by:

getRole in interface ServiceSpec

getPrincipal

public java.lang.String getPrincipal()

Specified by:

getPrincipal in interface ServiceSpec

getWebUrl

public java.lang.String getWebUrl()

Specified by:

getWebUrl in interface ServiceSpec

getZookeeperConnection

public java.lang.String getZookeeperConnection()

Specified by:

getZookeeperConnection in interface ServiceSpec

getPods

public java.util.List<PodSpec> getPods()

Specified by:

getPods in interface ServiceSpec

getReplacementFailurePolicy

public java.util.Optional<ReplacementFailurePolicy> getReplacementFailurePolicy()

Specified by:

getReplacementFailurePolicy in interface ServiceSpec

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getComparatorInstance

public static ConfigurationComparator<ServiceSpec> getComparatorInstance()

Returns a ConfigurationComparator which may be used to compare DefaultServiceSpecs.

getUser

public java.lang.String getUser()

Specified by:

getUser in interface ServiceSpec

getConfigurationFactory

public static ConfigurationFactory<ServiceSpec> getConfigurationFactory(ServiceSpec serviceSpec)
                                                                 throws ConfigStoreException

Returns a DefaultServiceSpec.ConfigFactory which may be used to deserialize DefaultServiceSpecs, which has been confirmed to successfully and consistently serialize/deserialize the provided ServiceSpecification instance.

Parameters:

serviceSpec - specification to test for successful serialization/deserialization

Throws:

ConfigStoreException - if testing the provided specification fails

getConfigurationFactory

public static ConfigurationFactory<ServiceSpec> getConfigurationFactory(ServiceSpec serviceSpec,
                                                                        java.util.Collection<java.lang.Class<?>> additionalSubtypesToRegister)
                                                                 throws ConfigStoreException

Returns a DefaultServiceSpec.ConfigFactory which may be used to deserialize DefaultServiceSpecs, which has been confirmed to successfully and consistently serialize/deserialize the provided ServiceSpecification instance.

Parameters:

serviceSpec - specification to test for successful serialization/deserialization

additionalSubtypesToRegister - any class subtypes which should be registered with Jackson for deserialization. any custom placement rule implementations must be provided

Throws:

ConfigStoreException - if testing the provided specification fails