Package com.zeroc.IceGrid

Interface Registry

All Superinterfaces:

Object

public interface Registry
extends Object

The IceGrid registry allows clients create sessions directly with the registry.

See Also:

• Session
• AdminSession

Nested Class Summary

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
AdminSessionPrx	createAdminSession(String userId, String password, Current current)	Create an administrative session.
AdminSessionPrx	createAdminSessionFromSecureConnection(Current current)	Create an administrative session from a secure connection.
SessionPrx	createSession(String userId, String password, Current current)	Create a client session.
SessionPrx	createSessionFromSecureConnection(Current current)	Create a client session from a secure connection.
int	getACMTimeout(Current current)	Get the value of the ACM timeout.
int	getSessionTimeout(Current current)	Get the session timeout.
default String	ice_id(Current current)	Returns the Slice type ID of the most-derived interface supported by this object.
default String[]	ice_ids(Current current)	Returns the Slice type IDs of the interfaces supported by this object.
static String	ice_staticId()	Returns the Slice type ID of the interface supported by this object.

Methods inherited from interface com.zeroc.Ice.Object

ice_dispatch, ice_isA, ice_ping

Method Details

createSession

SessionPrx createSession(String userId,
 String password,
 Current current)
                  throws PermissionDeniedException

Create a client session.

Parameters:

userId - The user id.

password - The password for the given user id.

current - The Current object for the invocation.

Returns:

A proxy for the newly created session.

Throws:

PermissionDeniedException - Raised if the password for the given user id is not correct, or if the user is not allowed access.

createAdminSession

AdminSessionPrx createAdminSession(String userId,
 String password,
 Current current)
                            throws PermissionDeniedException

Create an administrative session.

Parameters:

userId - The user id.

password - The password for the given user id.

current - The Current object for the invocation.

Returns:

A proxy for the newly created session.

Throws:

PermissionDeniedException - Raised if the password for the given user id is not correct, or if the user is not allowed access.

createSessionFromSecureConnection

SessionPrx createSessionFromSecureConnection(Current current)
                                      throws PermissionDeniedException

Create a client session from a secure connection.

Parameters:

current - The Current object for the invocation.

Returns:

A proxy for the newly created session.

Throws:

PermissionDeniedException - Raised if the password for the given user id is not correct, or if the user is not allowed access.

createAdminSessionFromSecureConnection

AdminSessionPrx createAdminSessionFromSecureConnection(Current current)
                                                throws PermissionDeniedException

Create an administrative session from a secure connection.

Parameters:

current - The Current object for the invocation.

Returns:

A proxy for the newly created session.

Throws:

PermissionDeniedException - Raised if the password for the given user id is not correct, or if the user is not allowed access.

getSessionTimeout

int getSessionTimeout(Current current)

Get the session timeout. If a client or administrative client doesn't call the session keepAlive method in the time interval defined by this timeout, IceGrid might reap the session.

Parameters:

current - The Current object for the invocation.

Returns:

The timeout (in seconds).

See Also:

• Session.keepAlive(com.zeroc.Ice.Current)
• AdminSession.keepAlive(com.zeroc.Ice.Current)

getACMTimeout

int getACMTimeout(Current current)

Get the value of the ACM timeout. Clients supporting ACM connection heartbeats can enable them instead of explicitly sending keep alives requests. NOTE: This method is only available since Ice 3.6.

Parameters:

current - The Current object for the invocation.

Returns:

The timeout (in seconds).

ice_ids

default String[] ice_ids(Current current)

Description copied from interface: Object

Returns the Slice type IDs of the interfaces supported by this object.

Specified by:

ice_ids in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

ice_id

default String ice_id(Current current)

Description copied from interface: Object

Returns the Slice type ID of the most-derived interface supported by this object.

Specified by:

ice_id in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type ID of the most-derived interface.

ice_staticId

static String ice_staticId()

Description copied from interface: Object

Returns the Slice type ID of the interface supported by this object.

Returns:

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