IceGrid.FileParserPrx

class IceGrid.FileParserPrx

Bases: ObjectPrx

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

Notes

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

parse(xmlFile: str, adminProxy: AdminPrx | None, context: dict[str, str] | None = None) → 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The application descriptor.

Return type:

ApplicationDescriptor

Raises:

ParseException – Thrown when an error occurs during parsing.

parseAsync(xmlFile: str, adminProxy: AdminPrx | None, context: dict[str, str] | None = None) → 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.

  • context (dict[str, str]) – The request context for the invocation.

Returns:

The application descriptor.

Return type:

Awaitable[ApplicationDescriptor]

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → FileParserPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[FileParserPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

  • context (dict[str, str] | None, optional) – The request context.

Returns:

A new proxy with the requested facet, or None if the source proxy is None or if the target object/facet does not support the requested type.

Return type:

ObjectPrx | None

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → FileParserPrx
static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

  • proxy (ObjectPrx | None) – The source proxy.

  • facet (str | None, optional) – A facet name.

Returns:

A new proxy with the requested facet, or None if the source proxy is None.

Return type:

ObjectPrx | None

static ice_staticId() → str

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.

Return type:

str