IceGrid.RegistryPrx

class IceGrid.RegistryPrx

Bases: ObjectPrx

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 proxy class from Slice interface ::IceGrid::Registry.

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → RegistryPrx | 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, optional) – A facet name.

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

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object 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[RegistryPrx | 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, optional) – A facet name.

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

Returns:

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

Return type:

ObjectPrx | None

createAdminSession(userId: str, password: str, context: dict[str, str] | None = None) → AdminSessionPrx | None

Creates an administrative session.

Parameters:

  • userId (str) – The user ID.

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

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

Returns:

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

Return type:

AdminSessionPrx | None

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

createAdminSessionAsync(userId: str, password: str, context: dict[str, str] | None = None) → Awaitable[AdminSessionPrx | None]

Creates an administrative session.

Parameters:

  • userId (str) – The user ID.

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

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

Returns:

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

Return type:

Awaitable[AdminSessionPrx | None]

createAdminSessionFromSecureConnection(context: dict[str, str] | None = None) → AdminSessionPrx | None

Creates an administrative session from a secure connection.

Parameters:

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

Returns:

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

Return type:

AdminSessionPrx | None

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

createAdminSessionFromSecureConnectionAsync(context: dict[str, str] | None = None) → Awaitable[AdminSessionPrx | None]

Creates an administrative session from a secure connection.

Parameters:

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

Returns:

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

Return type:

Awaitable[AdminSessionPrx | None]

createSession(userId: str, password: str, context: dict[str, str] | None = None) → SessionPrx | None

Creates a client session.

Parameters:

  • userId (str) – The user ID.

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

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

Returns:

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

Return type:

SessionPrx | None

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

createSessionAsync(userId: str, password: str, context: dict[str, str] | None = None) → Awaitable[SessionPrx | None]

Creates a client session.

Parameters:

  • userId (str) – The user ID.

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

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

Returns:

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

Return type:

Awaitable[SessionPrx | None]

createSessionFromSecureConnection(context: dict[str, str] | None = None) → SessionPrx | None

Creates a client session from a secure connection.

Parameters:

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

Returns:

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

Return type:

SessionPrx | None

Raises:

PermissionDeniedException – Thrown when authentication or authorization fails.

createSessionFromSecureConnectionAsync(context: dict[str, str] | None = None) → Awaitable[SessionPrx | None]

Creates a client session from a secure connection.

Parameters:

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

Returns:

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

Return type:

Awaitable[SessionPrx | None]

getSessionTimeout(context: dict[str, str] | None = None) → 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:

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

Returns:

The session timeout (in seconds).

Return type:

int

getSessionTimeoutAsync(context: dict[str, str] | None = None) → 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:

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

Returns:

The session timeout (in seconds).

Return type:

Awaitable[int]

static ice_staticId() → str

Gets the Slice type ID of the interface associated with this proxy.

Returns:

The type ID, “::Ice::Object”.

Return type:

str

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → RegistryPrx
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, optional) – A facet name.

Returns:

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

Return type:

ObjectPrx | None