org.kuali.rice.ksb.api.registry

Interface ServiceInfoContract

All Superinterfaces:

Versioned

All Known Implementing Classes:

ServiceInfo, ServiceInfo.Builder, ServiceInfoBo

public interface ServiceInfoContract
extends Versioned

Defines the contract for information about a service that is published in the ServiceRegistry.

Author:

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

See Also:

ServiceRegistry

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationId() Returns the id of the application that published and owns the service.
String	getChecksum() Returns a checksum value for the ServiceConfiguration stored in the ServiceDescriptorContract for this service.
String	getEndpointUrl() Returns the URL of the service as a string.
String	getInstanceId() Returns the id of the instance that published and owns the service.
String	getServerIpAddress() Return the IP address of the server on which the application is running which published and owns the service.
String	getServiceDescriptorId() Returns the id of the service descriptor for this service.
String	getServiceId() Returns the identifier for the service.
QName	getServiceName() Returns the name of the service as a qualified name consisting of a namespace and a name.
String	getServiceVersion() Returns the version information of this service.
ServiceEndpointStatus	getStatus() Return the status of the service endpoint represented by this service.
String	getType() Returns the type of this service.
Long	getVersionNumber() Deprecated. will always return 1

Method Detail

getServiceId

String getServiceId()

Returns the identifier for the service.

Returns:

the identifier for the service, will only be null if the service has not yet been published to the registry

getServiceName

QName getServiceName()

Returns the name of the service as a qualified name consisting of a namespace and a name.

Returns:

the name of the service, should never be null

getEndpointUrl

String getEndpointUrl()

Returns the URL of the service as a string.

Returns:

the url of the service, should never be null or blank

getInstanceId

String getInstanceId()

Returns the id of the instance that published and owns the service.

Returns:

the instance id of this service, should never be null or blank

getApplicationId

String getApplicationId()

Returns the id of the application that published and owns the service.

Returns:

the application id of this service, should never be null or blank

getServerIpAddress

String getServerIpAddress()

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.

Returns:

the IP address of this service, should never be null or blank

getType

String getType()

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.)

Returns:

the type of this service, should never be null or blank

getServiceVersion

String getServiceVersion()

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.

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

ServiceEndpointStatus getStatus()

Return the status of the service endpoint represented by this service.

Returns:

the status of this service

getServiceDescriptorId

String getServiceDescriptorId()

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.

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

String getChecksum()

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.

Returns:

the checksum for this service, should never return a null or blank value

getVersionNumber

@Deprecated
Long getVersionNumber()

Deprecated. will always return 1

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 Versioned

Returns:

1