IceGrid.Registry

class IceGrid.Registry

Bases: Object, ABC

Represents the main entry point into the IceGrid registry service. It provides operations to create sessions with the registry.

Notes

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

static ice_staticId() → str

Returns the type ID of the associated Slice interface.

Returns:

The return value is always "::Ice::Object".

Return type:

str

abstractmethod createSession(userId: str, password: str, current: Current) → SessionPrx | None | Awaitable[SessionPrx | None]

Creates a client session.

Parameters:

  • userId (str) – The user ID.

  • password (str) – The password for the given user.

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

Returns:

A proxy to the newly created session. This proxy is never null.

Return type:

SessionPrx | None | Awaitable[SessionPrx | None]

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

abstractmethod createAdminSession(userId: str, password: str, current: Current) → AdminSessionPrx | None | Awaitable[AdminSessionPrx | None]

Creates an administrative session.

Parameters:

  • userId (str) – The user ID.

  • password (str) – The password for the given user.

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

Returns:

A proxy to the newly created session. This proxy is never null.

Return type:

AdminSessionPrx | None | Awaitable[AdminSessionPrx | None]

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

abstractmethod createSessionFromSecureConnection(current: Current) → SessionPrx | None | Awaitable[SessionPrx | None]

Creates a client session from a secure connection.

Parameters:

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

Returns:

A proxy to the newly created session. This proxy is never null.

Return type:

SessionPrx | None | Awaitable[SessionPrx | None]

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

abstractmethod createAdminSessionFromSecureConnection(current: Current) → AdminSessionPrx | None | Awaitable[AdminSessionPrx | None]

Creates an administrative session from a secure connection.

Parameters:

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

Returns:

A proxy to the newly created session. This proxy is never null.

Return type:

AdminSessionPrx | None | Awaitable[AdminSessionPrx | None]

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

abstractmethod getSessionTimeout(current: Current) → int | Awaitable[int]

Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call IceGrid.SessionPrx.keepAliveAsync() (resp. IceGrid.AdminSessionPrx.keepAliveAsync()) to keep a session alive in the IceGrid registry.

Parameters:

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

Returns:

The session timeout (in seconds).

Return type:

int | Awaitable[int]