ServiceInfo

ServiceInfo
ServiceInfo

A service is a logical feature unit. One service may have multiple instances. A service may have sub ?features. These sub features are called service end points. A service end point lets a service consumer know where to access the end point. However the end point does not provide automatic service binding. The service consumer needs to know how to use the API provided by service provider end point without any assistance from the component registry. ServiceType: A service is identified by it service type. Services of the same service type should have identical features. Instance identity: A service may register multiple instances. Each instance is identified by a service instance UUID. Service registration, update, and deregistration are on the basis of service instance. If a service has multiple instances registered, unregistering one instance does not affect other instances of the service. Attributes: Services may provide key/value pairs as service attributes.These attributes should not be used for storing significant amount of data. Endpoints: A service may provide a list of endpoints. An endpoint is an interface point and is typically associated with an IP address and a port number. An end point only shows where the service location is, but it does not provide any binding. A client that uses an end point should know how to use the end point independent of the service registration data. The ServiceInfo class provide information about a given registered Service with the ComponentRegistry and its properties.

JSON Example 
{
    "serviceVersion": "string",
    "serviceType": {
        "productId": "string",
        "serviceTypeId": "string",
        "typeId": "string",
        "serviceName": "string"
    },
    "lastUpdated": "string",
    "nameMsgKey": "string",
    "createdDate": "string",
    "name": "string",
    "serviceAttributes": [
        {
            "id": "string",
            "value": "string",
            "key": "string"
        }
    ],
    "id": "string",
    "ownerId": "string",
    "endPoints": [
        {
            "lastUpdated": "string",
            "endPointType": {
                "protocol": "string",
                "typeId": "string"
            },
            "serviceInfoId": "string",
            "createdDate": "string",
            "endPointAttributes": [
                {
                    "id": "string",
                    "value": "string",
                    "key": "string"
                }
            ],
            "id": "string",
            "sslTrusts": [
                "string"
            ],
            "url": "string"
        }
    ]
}
string
serviceVersion
Optional

The service version. For example, "1.0.0".

ServiceType
serviceType
Optional

serviceType

string As date-time As date-time
lastUpdated
Optional

The last updated date.

string
nameMsgKey
Optional

The service name message key used for localization

string As date-time As date-time
createdDate
Optional

The created date.

string
name
Optional

The name of the service. NOTE: Services of the same serviceType should have same name.

array of Attribute
serviceAttributes
Optional

Service specific attributes to be advertised to service consumers (optional).

string As uuid As uuid
id
Optional

The id.

string
ownerId
Optional

The solution username of the SSO principal owning the service.

array of EndPoint
endPoints
Optional

endPoints

Property Of
Parameter To
Returned By