|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface shall be implemented by a Framework with as a minimum requirement the listServiceTypes(), describeServiceType() and discoverService() methods.
Method Summary | |
org.csapi.jr.se.fw.ServiceTypeDescription |
describeServiceType(java.lang.String name)
This operation lets the caller obtain the details for a particular service type. |
org.csapi.jr.se.fw.Service[] |
discoverService(java.lang.String serviceTypeName,
org.csapi.jr.se.fw.ServiceProperty[] desiredPropertyList,
int max)
The discoverService operation is the means by which the service supplier can retrieve a specific set of registered services that both belong to a given type and possess a specific set of "property values". |
org.csapi.jr.se.fw.Service[] |
listRegisteredServices()
Returns a list of services so far registered in the framework. |
java.lang.String[] |
listServiceTypes()
This operation returns the names of all service types that are in the repository. |
Method Detail |
public java.lang.String[] listServiceTypes() throws CommonException, PlatformException
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic org.csapi.jr.se.fw.ServiceTypeDescription describeServiceType(java.lang.String name) throws CommonException, IllegalServiceTypeException, UnknownServiceTypeException, PlatformException
name
- The name of the service type to be described. If the "name" is malformed, then the P_ILLEGAL_SERVICE_TYPE exception is raised. If the "name" does not exist in the repository, then the P_UNKNOWN_SERVICE_TYPE exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceTypeException
- Illegal Service Type
UnknownServiceTypeException
- Unknown Service Type
PlatformException
- The implementation detected an internal (for example, communication) errorpublic org.csapi.jr.se.fw.Service[] discoverService(java.lang.String serviceTypeName, org.csapi.jr.se.fw.ServiceProperty[] desiredPropertyList, int max) throws CommonException, IllegalServiceTypeException, UnknownServiceTypeException, InvalidPropertyException, PlatformException
serviceTypeName
- The name of the required service type. If the string representation of the "type" does not obey the rules for service type identifiers, then the P_ILLEGAL_SERVICE_TYPE exception is raised. If the "type" is correct syntactically but is not recognised as a service type within the Framework, then the P_UNKNOWN_SERVICE_TYPE exception is raised. The framework may return a service of a subtype of the "type" requested. A service sub-type can be described by the properties of its supertypes.desiredPropertyList
- The "desiredPropertyList" parameter is a list of service properties {name and value list} that the required services should satisfy. These properties deal with the non-functional and non-computational aspects of the desired service. The property values in the desired property list must be logically interpreted as "minimum", "maximum", etc. by the framework (due to the absence of a Boolean constraint expression for the specification of the service criterion). It is suggested that, at the time of service registration, each property value be specified as an appropriate range of values, so that desired property values can specify an "enclosing" range of values to help in the selection of desired services.max
- The "max" parameter states the maximum number of services that are to be returned in the "serviceList" result.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceTypeException
- Illegal Service Type
UnknownServiceTypeException
- Unknown Service Type
InvalidPropertyException
- The framework does not recognise the property supplied by the client
PlatformException
- The implementation detected an internal (for example, communication) errorpublic org.csapi.jr.se.fw.Service[] listRegisteredServices() throws CommonException, PlatformException
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) error
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |