org.rvpf.base.rmi

Interface Session

All Superinterfaces:

Remote

All Known Subinterfaces:

AgentSession, PublisherSession, ReceiverSession, RemoteEngineSession, SenderSession, SOMSession, StoreSession, SubscriberSession

All Known Implementing Classes:

AgentSessionImpl, AgentSessionProxy, ExportedSessionImpl, PublisherSessionImpl, QueueProxy, QueueProxy.Receiver, QueueProxy.Sender, ReceiverSessionImpl, RemoteEngineProxy, RemoteEngineSessionImpl, SenderSessionImpl, SessionImpl, SessionProxy, SOMProxy, SOMSessionImpl, StoreSessionImpl, StoreSessionProxy, SubscriberSessionImpl, TopicProxy, TopicProxy.Publisher, TopicProxy.Subscriber

public interface Session
extends Remote

Remote object session.

A remote object implements a session when it has security requirements. A session allows a client to provide identification and authentification. The mode of connection to the remote object may have an effect on the security constraints.

A session object is created by a remote session factory object with an appropriate connection mode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Session.ConnectionMode Connection mode.

Method Summary

Modifier and Type	Method and Description
Session.ConnectionMode	getConnectionMode() Gets the connection mode.
void	login(String identifier, char[] password) Identifies and authenticates the identity associated with the Session.
void	logout() Logs out.

Method Detail

getConnectionMode

@Nullable
 @CheckReturnValue
Session.ConnectionMode getConnectionMode()
                                                                 throws RemoteException

Gets the connection mode.

This method may be called before or after login(java.lang.String, char[]).

Returns:

The connection mode.

Throws:

RemoteException - From RMI RunTime.

login

void login(@Nullable
           String identifier,
           @Nullable
           char[] password)
    throws RemoteException,
           SessionException

Identifies and authenticates the identity associated with the Session.

Parameters:

identifier - The identifier for the identity.

password - The password authenticating the identity.

Throws:

RemoteException - From RMI RunTime.

SessionException - From the session implementation.

logout

void logout()
     throws RemoteException,
            SessionException

Logs out.

Throws:

RemoteException - From RMI RunTime.

SessionException - When the session logout fails.