Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Interface AsyncRegistry

All Superinterfaces:

Object

public interface AsyncRegistry
extends Object

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

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

Nested Class Summary

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

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
CompletionStage<AdminSessionPrx>	createAdminSessionAsync(String userId, String password, Current current)	Creates an administrative session.
CompletionStage<AdminSessionPrx>	createAdminSessionFromSecureConnectionAsync(Current current)	Creates an administrative session from a secure connection.
CompletionStage<SessionPrx>	createSessionAsync(String userId, String password, Current current)	Creates a client session.
CompletionStage<SessionPrx>	createSessionFromSecureConnectionAsync(Current current)	Creates a client session from a secure connection.
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
CompletionStage<Integer>	getSessionTimeoutAsync(Current current)	Gets the session timeout.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

createSessionAsync

CompletionStage<SessionPrx> createSessionAsync(String userId,
 String password,
 Current current)
                                        throws PermissionDeniedException

Creates a client session.

Parameters:

userId - The user ID.

password - The password for the given user.

current - the Current object of the incoming request

Returns:

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

Throws:

PermissionDeniedException - Thrown when authentication or authorization fails.

createAdminSessionAsync

CompletionStage<AdminSessionPrx> createAdminSessionAsync(String userId,
 String password,
 Current current)
                                                  throws PermissionDeniedException

Creates an administrative session.

Parameters:

userId - The user ID.

password - The password for the given user.

current - the Current object of the incoming request

Returns:

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

Throws:

PermissionDeniedException - Thrown when authentication or authorization fails.

createSessionFromSecureConnectionAsync

CompletionStage<SessionPrx> createSessionFromSecureConnectionAsync(Current current)
                                                            throws PermissionDeniedException

Creates a client session from a secure connection.

Parameters:

current - the Current object of the incoming request

Returns:

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

Throws:

PermissionDeniedException - Thrown when authentication or authorization fails.

createAdminSessionFromSecureConnectionAsync

CompletionStage<AdminSessionPrx> createAdminSessionFromSecureConnectionAsync(Current current)
                                                                      throws PermissionDeniedException

Creates an administrative session from a secure connection.

Parameters:

current - the Current object of the incoming request

Returns:

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

Throws:

PermissionDeniedException - Thrown when authentication or authorization fails.

getSessionTimeoutAsync

CompletionStage<Integer> getSessionTimeoutAsync(Current current)

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 SessionPrx.keepAlive() (resp. AdminSessionPrx.keepAlive()) to keep a session alive in the IceGrid registry.

Parameters:

current - the Current object of the incoming request

Returns:

The session timeout (in seconds).

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::IceGrid::Registry"

dispatch

default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request)
                                            throws UserException

Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

UserException - if a UserException is thrown, Ice will marshal it as the response payload.