Class FileParser`Abstract`

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

Remarks

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

Hierarchy (View Summary)

Object
- FileParser

Index

Constructors

Methods

dispatch ice_id ice_ids ice_isA ice_ping parse ice_staticId

Constructors

constructor

new FileParser(): FileParser
Returns FileParser
Inherited from Object.constructor

Methods

dispatch

dispatch(
request: IncomingRequest,
): OutgoingResponse | PromiseLike<OutgoingResponse>
Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.
Parameters
- request: IncomingRequest
  The incoming request.
Returns OutgoingResponse | PromiseLike<OutgoingResponse>
The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

Remarks
Ice marshals any exception thrown by this method into the response.

Overrides Object.dispatch

ice_id

ice_id(current: Current): string | PromiseLike<string>
Returns the Slice type ID of the most-derived interface supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string | PromiseLike<string>
The Slice type ID of the most-derived interface.

Inherited from Object.ice_id

ice_ids

ice_ids(current: Current): string[] | PromiseLike<string[]>
Returns the Slice type IDs of the interfaces supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string[] | PromiseLike<string[]>
The Slice type IDs of the interfaces supported by this object, in alphabetical order.

Inherited from Object.ice_ids

ice_isA

ice_isA(typeID: string, current: Current): boolean | PromiseLike<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeID: string
  The type ID of the Slice interface to test against.
- current: Current
  The Current object for the invocation.
Returns boolean | PromiseLike<boolean>
True if this object has the interface specified by typeID or derives from the interface specified by typeID.

Inherited from Object.ice_isA

ice_ping

ice_ping(current: Current): void | PromiseLike<void>
Tests whether this object can be reached.
Parameters
- current: Current
  The Current object for the invocation.
Returns void | PromiseLike<void>
Inherited from Object.ice_ping

`Abstract`parse

parse(
    xmlFile: string,
    adminProxy: AdminPrx,
    current: Current,
): ApplicationDescriptor | PromiseLike<ApplicationDescriptor>
Parses a file.
Parameters
- xmlFile: string
  The full path to the file.
- adminProxy: AdminPrx
  An IceGrid.AdminPrx proxy, used only to retrieve default templates when needed. May be null.
- current: Current
  The Current object for the dispatch.
Returns ApplicationDescriptor | PromiseLike<ApplicationDescriptor>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ApplicationDescriptor : The application descriptor.
Throws
IceGrid.ParseException Thrown when an error occurs during parsing.

`Static`ice_staticId

ice_staticId(): string
Obtains the Slice type ID of this type.

Returns string
The return value is always "::IceGrid::FileParser".

Overrides Object.ice_staticId