Package org.kuali.rice.ksb.api.registry

Interface ServiceDescriptorContract

All Superinterfaces:
Versioned
All Known Implementing Classes:
ServiceDescriptor, ServiceDescriptor.Builder
public interface ServiceDescriptorContract extends Versioned
A service descriptor includes a serialized XML representation of the ServiceConfiguration for the service.

It's expected that a client of this service which needs this information will materialize this value when it's needed to obtain additional information about the configuration information for the service. The process for materializing the information can be dependent upon the type of the ServiceInfo which contains this descriptor.

The separation of this descriptor information from the main ServiceInfo allows for clients of the registry to only load the basic information about the services in the registry, and then pull in the full descriptor for the services they actually need to invoke and work with.

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getId

      String getId()
      Returns the id of this service descriptor. This value should be unique across service descriptors. This value is generated when the service is published to the registry, so this value can be null if the service has not yet been published to the registry.
      Returns:
      the id of this service descriptor, or null if the service and it's descriptor has not yet been published to the registry

    • getDescriptor

      String getDescriptor()
      Returns an XML value which can be used to materialize the ServiceConfiguration for the service.
      Returns:
      the XML representation of the ServiceConfiguration for the service, should never return a null or blank value

    • getVersionNumber

      @Deprecated Long getVersionNumber()
      Deprecated.
      always returns null
      Deprecated: Will always return null as service descriptors have no version number column. This was included on the contract interface by mistake during the original implementation.
      Specified by:
      getVersionNumber in interface Versioned
      Returns:
      always returns null