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

Class ServiceInfo

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.ksb.api.registry.ServiceInfo
All Implemented Interfaces:
Serializable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, ServiceInfoContract
public final class ServiceInfo extends org.kuali.rice.core.api.mo.AbstractDataTransferObject implements ServiceInfoContract
Immutable implementation of the ServiceInfoContract interface. Includes standard configuration information about a service that has been published to the service registry.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Details

    • getServiceId

      public String getServiceId()
      Description copied from interface: ServiceInfoContract
      Returns the identifier for the service.
      Specified by:
      getServiceId in interface ServiceInfoContract
      Returns:
      the identifier for the service, will only be null if the service has not yet been published to the registry

    • getServiceName

      public QName getServiceName()
      Description copied from interface: ServiceInfoContract
      Returns the name of the service as a qualified name consisting of a namespace and a name.
      Specified by:
      getServiceName in interface ServiceInfoContract
      Returns:
      the name of the service, should never be null

    • getEndpointUrl

      public String getEndpointUrl()
      Description copied from interface: ServiceInfoContract
      Returns the URL of the service as a string.
      Specified by:
      getEndpointUrl in interface ServiceInfoContract
      Returns:
      the url of the service, should never be null or blank

    • getInstanceId

      public String getInstanceId()
      Description copied from interface: ServiceInfoContract
      Returns the id of the instance that published and owns the service.
      Specified by:
      getInstanceId in interface ServiceInfoContract
      Returns:
      the instance id of this service, should never be null or blank

    • getApplicationId

      public String getApplicationId()
      Description copied from interface: ServiceInfoContract
      Returns the id of the application that published and owns the service.
      Specified by:
      getApplicationId in interface ServiceInfoContract
      Returns:
      the application id of this service, should never be null or blank

    • getServerIpAddress

      public String getServerIpAddress()
      Description copied from interface: ServiceInfoContract
      Return the IP address of the server on which the application is running which published and owns the service. This value could be either an IPv4 or IPv6 address, but it should never return a null or empty string.
      Specified by:
      getServerIpAddress in interface ServiceInfoContract
      Returns:
      the IP address of this service, should never be null or blank

    • getType

      public String getType()
      Description copied from interface: ServiceInfoContract
      Returns the type of this service. Will generally distinguish the format of the data being brokered by the service (i.e. SOAP, REST, Java Serialization, etc.)
      Specified by:
      getType in interface ServiceInfoContract
      Returns:
      the type of this service, should never be null or blank

    • getServiceVersion

      public String getServiceVersion()
      Description copied from interface: ServiceInfoContract
      Returns the version information of this service. The publisher of the service can use any value they choose for the service versions. However, there is one standard version which represents a service without any version information, and that is CoreConstants.Versions.UNSPECIFIED.
      Specified by:
      getServiceVersion in interface ServiceInfoContract
      Returns:
      the version of this service, or CoreConstants.Versions.UNSPECIFIED if no version has been secified, should never return a null or blank value

    • getStatus

      public ServiceEndpointStatus getStatus()
      Description copied from interface: ServiceInfoContract
      Return the status of the service endpoint represented by this service.
      Specified by:
      getStatus in interface ServiceInfoContract
      Returns:
      the status of this service

    • getServiceDescriptorId

      public String getServiceDescriptorId()
      Description copied from interface: ServiceInfoContract
      Returns the id of the service descriptor for this service. This id can be used to help locate the ServiceDescriptorContract for this service which includes more detailed information on this service.
      Specified by:
      getServiceDescriptorId in interface ServiceInfoContract
      Returns:
      the id of the service descriptor for this service, will only return a null value if the service has not yet been published

    • getChecksum

      public String getChecksum()
      Description copied from interface: ServiceInfoContract
      Returns a checksum value for the ServiceConfiguration stored in the ServiceDescriptorContract for this service. This allows for fast comparison of services during various registry operations.
      Specified by:
      getChecksum in interface ServiceInfoContract
      Returns:
      the checksum for this service, should never return a null or blank value

    • getVersionNumber

      public Long getVersionNumber()
      Description copied from interface: ServiceInfoContract
      Deprecated value which previously stored version number for optimistic locking purposes. Optimistic locking was never really necessary for service info. This method will always return 1.
      Specified by:
      getVersionNumber in interface ServiceInfoContract
      Specified by:
      getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned
      Returns:
      1