Package org.eclipse.ecf.osgi.services.remoteserviceadmin

Interface IEndpointDescriptionReader

All Known Implementing Classes:
EndpointDescriptionReader
public interface IEndpointDescriptionReader
Service for reading endpoint descriptions from xml-files in the Endpoint Description Extender Format (EDEF) specified in section 122.8 of the OSGi Enterprise Specification (chapter 122). The InputStream provided must be of the EDEF format, otherwise an IOException or EndpointDescriptionParseException will be thrown.
Restriction:
This interface is not intended to be extended by clients.

  • Method Details

    • readEndpointDescriptions

      EndpointDescription[] readEndpointDescriptions(InputStream ins) throws IOException, EndpointDescriptionParseException
      Read endpoint descriptions from the given input stream. The ins parameter must not be null, and must provide data in the Endpoint Description Extender Format (EDEF) specified in section 122.8 of the OSGi Enterprise Specification.
      Parameters:
      ins - the input stream to read from. Must be non-null, and must provide data in the format specified the EDEF specification (see link above).
      Returns:
      array of EndpointDescription instance read from the given input stream.
      Throws:
      IOException - if the inputstream does not have valid data in the EDE format. Note that the implementation of this method may call InputStream.close().
      EndpointDescriptionParseException - if the EDE format cannot be parsed from the input stream.

    • readEndpointDescriptions

      EndpointDescription[] readEndpointDescriptions(InputStream ins, Map<String,Object> overrideProperties) throws IOException
      Read endpoint descriptions from the given input stream. The ins parameter must not be null, and must provide data in the Endpoint Description Extender Format (EDEF) specified in section 122.8 of the OSGi Enterprise Specification.
      Parameters:
      ins - the input stream to read from. Must be non-null, and must provide data in the format specified the EDEF specification (see link above).
      overrideProperties - map of property name/values that will override the same-named values from the edef. If null then no overriding will be done.
      Returns:
      array of EndpointDescription instance read from the given input stream.
      Throws:
      IOException - if the inputstream does not have valid data in the EDE format. Note that the implementation of this method may call InputStream.close().
      EndpointDescriptionParseException - if the EDE format cannot be parsed from the input stream.
      Since:
      4.7