|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Service Registration interface provides the methods used for the registration of network SCFs at the framework. This interface and at least the methods registerService(), announceServiceAvailability(), unregisterService() and unannounceService() shall be implemented by a Framework.
Method Summary | |
void |
announceServiceAvailability(java.lang.String serviceID,
org.csapi.jr.se.fw.fw_service.service_lifecycle.ServiceInstanceLifecycleManager serviceInstanceLifecycleManagerRef)
The registerService() method described previously does not make the service discoverable. |
org.csapi.jr.se.fw.ServiceDescription |
describeService(java.lang.String serviceID)
The describeService() operation returns the information about a service that is registered in the framework. |
java.lang.String |
registerService(java.lang.String serviceTypeName,
org.csapi.jr.se.fw.ServiceProperty[] servicePropertyList)
The registerService() operation is the means by which a service is registered in the Framework, for subsequent discovery by the enterprise applications. |
java.lang.String |
registerServiceSubType(java.lang.String serviceTypeName,
org.csapi.jr.se.fw.ServiceProperty[] servicePropertyList,
org.csapi.jr.se.fw.ServiceTypePropertyValue[] extendedServicePropertyList)
The registerServiceSubType() operation is the means by which an extended service is registered in the Framework, for subsequent discovery by the enterprise applications. |
void |
unannounceService(java.lang.String serviceID)
This method results in the service no longer being discoverable by applications. |
void |
unregisterService(java.lang.String serviceID)
The unregisterService() operation is used by the service suppliers to remove a registered service from the Framework. |
Method Detail |
public java.lang.String registerService(java.lang.String serviceTypeName, org.csapi.jr.se.fw.ServiceProperty[] servicePropertyList) throws CommonException, PropertyTypeMismatchException, DuplicatePropertyNameException, IllegalServiceTypeException, UnknownServiceTypeException, MissingMandatoryPropertyException, ServiceTypeUnavailableException, PlatformException
serviceTypeName
- The "serviceTypeName" parameter identifies the service type. If the string representation of the "type" does not obey the rules for identifiers, then a P_ILLEGAL_SERVICE_TYPE exception is raised. If the "type" is correct syntactically but the Framework is able to unambiguously determine that it is not a recognised service type, then a P_UNKNOWN_SERVICE_TYPE exception is raised.servicePropertyList
- The "servicePropertyList" parameter is a list of property name and property value pairs. They describe the service being registered. This description typically covers behavioural, non-functional and non-computational aspects of the service. Service properties are marked "mandatory" or "readonly". These property mode attributes have the following semantics: a. mandatory - a service associated with this service type must provide an appropriate value for this property when registering. b. readonly - this modifier indicates that the property is optional, but that once given a value, subsequently it may not be modified. Specifying both modifiers indicates that a value must be provided and that subsequently it may not be modified. Examples of such properties are those which form part of a service agreement and hence cannot be modified by service suppliers during the life time of service. If the type or the semantics of the type of any of the property values is not the same as the declared type (declared in the service type), then a P_PROPERTY_TYPE_MISMATCH exception is raised. If the "servicePropertyList" parameter omits any property declared in the service type with a mode of mandatory, then a P_MISSING_MANDATORY_PROPERTY exception is raised. If two or more properties with the same property name are included in this parameter, the P_DUPLICATE_PROPERTY_NAME exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PropertyTypeMismatchException
- Property Type Mismatch
DuplicatePropertyNameException
- A duplicate property name has been received
IllegalServiceTypeException
- Illegal Service Type
UnknownServiceTypeException
- Unknown Service Type
MissingMandatoryPropertyException
- Mandatory Property Missing
ServiceTypeUnavailableException
- The service type is not available according to the Framework.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void announceServiceAvailability(java.lang.String serviceID, org.csapi.jr.se.fw.fw_service.service_lifecycle.ServiceInstanceLifecycleManager serviceInstanceLifecycleManagerRef) throws CommonException, IllegalServiceIdException, UnknownServiceIdException, InvalidInterfaceTypeException, PlatformException
serviceID
- The service ID of the service that is being announced. If the string representation of the "serviceID" does not obey the rules for service identifiers, then a P_ILLEGAL_SERVICE_ID exception is raised. If the "serviceID" is legal but there is no service offer within the Framework with that ID, then a P_UNKNOWN_SERVICE_ID exception is raised.serviceInstanceLifecycleManagerRef
- The interface reference at which the service instance lifecycle manager of the previously registered service is available.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceIdException
- Illegal Service ID
UnknownServiceIdException
- Unknown Service ID
InvalidInterfaceTypeException
- The interface reference supplied by the client is the wrong type.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void unregisterService(java.lang.String serviceID) throws CommonException, IllegalServiceIdException, UnknownServiceIdException, PlatformException
serviceID
- The service to be withdrawn is identified by the "serviceID" parameter which was originally returned by the registerService() operation. If the string representation of the "serviceID" does not obey the rules for service identifiers, then a P_ILLEGAL_SERVICE_ID exception is raised. If the "serviceID" is legal but there is no service offer within the Framework with that ID, then a P_UNKNOWN_SERVICE_ID exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceIdException
- Illegal Service ID
UnknownServiceIdException
- Unknown Service ID
PlatformException
- The implementation detected an internal (for example, communication) errorpublic org.csapi.jr.se.fw.ServiceDescription describeService(java.lang.String serviceID) throws CommonException, IllegalServiceIdException, UnknownServiceIdException, PlatformException
serviceID
- The service to be described is identified by the "serviceID" parameter which was originally returned by the registerService() operation. If the string representation of the "serviceID" does not obey the rules for object identifiers, then an P_ILLEGAL_SERVICE_ID exception is raised. If the "serviceID" is legal but there is no service offer within the Framework with that ID, then a P_UNKNOWN_SERVICE_ID exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceIdException
- Illegal Service ID
UnknownServiceIdException
- Unknown Service ID
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void unannounceService(java.lang.String serviceID) throws CommonException, IllegalServiceIdException, UnknownServiceIdException, PlatformException
serviceID
- The service ID of the service that is being unannounced. If the string representation of the "serviceID" does not obey the rules for service identifiers, then an P_ILLEGAL_SERVICE_ID exception is raised. If the "serviceID" is legal but there is no service offer within the Framework with that ID, then an P_UNKNOWN_SERVICE_ID exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
IllegalServiceIdException
- Illegal Service ID
UnknownServiceIdException
- Unknown Service ID
PlatformException
- The implementation detected an internal (for example, communication) errorpublic java.lang.String registerServiceSubType(java.lang.String serviceTypeName, org.csapi.jr.se.fw.ServiceProperty[] servicePropertyList, org.csapi.jr.se.fw.ServiceTypePropertyValue[] extendedServicePropertyList) throws CommonException, PropertyTypeMismatchException, DuplicatePropertyNameException, IllegalServiceTypeException, UnknownServiceTypeException, MissingMandatoryPropertyException, ServiceTypeUnavailableException, PlatformException
serviceTypeName
- The "serviceTypeName" parameter identifies the service type. If the string representation of the "type" does not obey the rules for identifiers, then a P_ILLEGAL_SERVICE_TYPE exception is raised. If the "type" is correct syntactically but the Framework is able to unambiguously determine that it is not a recognised service type, then a P_UNKNOWN_SERVICE_TYPE exception is raised.servicePropertyList
- The "servicePropertyList" parameter is a list of property name and property value pairs corresponding to the service properties applicable to the standard service. They describe the service being registered.
If the type or the semantics of the type of any of the property values is not the same as the declared type (declared in the service type), then a P_PROPERTY_TYPE_MISMATCH exception is raised.
If the "servicePropertyList" parameter omits any property declared in the service type with a mode of mandatory, then a P_MISSING_MANDATORY_PROPERTY exception is raised.
If two or more properties with the same property name are included in this parameter, the P_DUPLICATE_PROPERTY_NAME exception is raised.extendedServicePropertyList
- The "extendedServicePropertyList" parameter is a list of property name, mode, type, and property value tuples corresponding to the service properties applicable to the extended standard service. They describe the service being registered.
If two or more properties with the same property name are included in this parameter, the P_DUPLICATE_PROPERTY_NAME exception is raised.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PropertyTypeMismatchException
- Property Type Mismatch
DuplicatePropertyNameException
- A duplicate property name has been received
IllegalServiceTypeException
- Illegal Service Type
UnknownServiceTypeException
- Unknown Service Type
MissingMandatoryPropertyException
- Mandatory Property Missing
ServiceTypeUnavailableException
- The service type is not available according to the Framework.
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 |