Package org.springframework.cloud.servicebroker.model.catalog

Class ServiceDefinition

java.lang.Object
org.springframework.cloud.servicebroker.model.catalog.ServiceDefinition
public class ServiceDefinition extends Object
A service offered by this broker.
Author:
S Greenberg, Scott Frederick
See Also:

  • Constructor Details

    • ServiceDefinition

      public ServiceDefinition()
      Construct a new ServiceDefinition.

    • ServiceDefinition

      public ServiceDefinition(String id, String name, String description, boolean bindable, Boolean planUpdateable, Boolean instancesRetrievable, Boolean bindingsRetrievable, Boolean allowContextUpdates, List<Plan> plans, List<String> tags, Map<String,Object> metadata, List<String> requires, DashboardClient dashboardClient)
      Construct a new ServiceDefinition.
      Parameters:
      id - the service ID
      name - the service name
      description - the service description
      bindable - true if the service may be bound
      planUpdateable - true if the plan may be updated
      instancesRetrievable - true if the service instances may be retrieved
      bindingsRetrievable - true if the service bindings may be retrieved
      allowContextUpdates - true if the service instance supports context updates
      plans - the service plans
      tags - the tags
      metadata - the service metadata
      requires - the required permissions
      dashboardClient - the service dashboard URI

  • Method Details

    • getId

      public String getId()
      An identifier used to correlate this service in future requests to the catalog. This must be unique within the platform. Using a GUID is recommended.
      Returns:
      the service ID

    • getName

      public String getName()
      A CLI-friendly name of the service that will appear in the catalog. The value should be all lowercase, with no spaces.
      Returns:
      the service name

    • getDescription

      public String getDescription()
      A user-friendly short description of the service that will appear in the catalog.
      Returns:
      the service description

    • isBindable

      public boolean isBindable()
      Indicates whether the service can be bound to applications.
      Returns:
      true if the service may be bound

    • isPlanUpdateable

      public Boolean isPlanUpdateable()
      Indicates whether the service supports requests to update instances to use a different plan from the one used to provision a service instance.
      Returns:
      true if the plan may be updated

    • isInstancesRetrievable

      public Boolean isInstancesRetrievable()
      Indicates whether the service broker supports retrieving service instances.
      Returns:
      true if the service instances may be retrieved

    • isBindingsRetrievable

      public Boolean isBindingsRetrievable()
      Indicates whether the service broker supports retrieving service bindings.
      Returns:
      true if the service bindings may be retrieved

    • isAllowContextUpdates

      public Boolean isAllowContextUpdates()
      Indicates whether a service instance supports update requests when contextual data for the service instance in the platform changes.
      Returns:
      true if the service instances supports context updates

    • getPlans

      public List<Plan> getPlans()
      A list of plans for this service.
      Returns:
      the service plans

    • getTags

      public List<String> getTags()
      A list of tags to aid in categorizing and classifying services with similar characteristics.
      Returns:
      the tags

    • getMetadata

      public Map<String,Object> getMetadata()
      A map of metadata to further describe a service offering.
      Returns:
      the service metadata

    • getRequires

      public List<String> getRequires()
      A list of permissions that the user would have to give the service, if they provision it.
      Returns:
      the required permissions
      See Also:

    • getDashboardClient

      public DashboardClient getDashboardClient()
      Data necessary to activate the Dashboard SSO feature for this service.
      Returns:
      the service dashboard URI

    • builder

      public static ServiceDefinition.ServiceDefinitionBuilder builder()
      Create a builder that provides a fluent API for constructing a ServiceDefinition.
      Returns:
      the builder

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object