IceGrid.FileParser

class IceGrid.FileParser

Bases: Object, ABC

icegridadmin provides a FileParser object to transform XML files into IceGrid.ApplicationDescriptor objects.

Notes

The Slice compiler generated this skeleton class from Slice interface ::IceGrid::FileParser.

static ice_staticId() → str

Obtain the type ID of the Slice interface.

Returns:

The type ID.

Return type:

str

abstractmethod parse(xmlFile: str, adminProxy: AdminPrx | None, current: Current) → ApplicationDescriptor | Awaitable[ApplicationDescriptor]

Parses a file.

Parameters:

  • xmlFile (str) – The full path to the file.

  • adminProxy (AdminPrx | None) – An IceGrid.AdminPrx proxy, used only to retrieve default templates when needed. May be null.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

The application descriptor.

Return type:

ApplicationDescriptor | Awaitable[ApplicationDescriptor]

Raises:

ParseException – Thrown when an error occurs during parsing.