org.exolab.jms.server.rmi
Interface RemoteJmsServerConnectionIfc

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RmiJmsServerConnection

public interface RemoteJmsServerConnectionIfc

extends java.rmi.Remote

This class RMI enables the JmsServerConnection by allowing clients to access the object across another VM. It basically has been grafted off the JmsServerConnection class with the RemoteException appended to the message signature.

Version:

$Revision: 1.7 $ $Date: 2003/08/17 01:32:26 $

Author:

Jim Alateras

See Also:

JmsServerConnection

Method Summary

void	close() Close all the sessions allocated to this collection.
RemoteJmsServerSessionIfc	createSession(int ackMode, boolean transacted) Create and return a sesion for this connection Assign the connection's clientId to the sessions.
void	deleteSession(RemoteJmsServerSessionIfc session) Delete the specified session from the server.
java.lang.String	getConnectionId() Retrieve the identity of this conection.
int	getSessionCount() Return the number of session objects currently allocated to this connection.
java.util.Enumeration	getSessions() Return an enumeration of RemoteJmsServerSessionIfc objects currently allocated to this session.
void	ping() Send a ping to the server.
void	start() Start all the sessions allocated to this connection.
void	stop() Stop all the sessions allocated to this collection.

Method Detail

createSession

public RemoteJmsServerSessionIfc createSession(int ackMode,
                                               boolean transacted)
                                        throws javax.jms.JMSException,
                                               java.rmi.RemoteException

Create and return a sesion for this connection Assign the connection's clientId to the sessions.

The created session represents an endpoint with the JmsServer where you can create consumers, producers and destinations. If there is an error creating the session then RemoteException is thrown

Parameters:

ackMode - the ack mode for the session

Returns:

JmsSession created session

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

deleteSession

public void deleteSession(RemoteJmsServerSessionIfc session)
                   throws javax.jms.JMSException,
                          java.rmi.RemoteException

Delete the specified session from the server. This will destroy all associated consumers and producers.

If there is a problem completing this request then throw RemoteException exception

Parameters:

session - session to delete

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

getSessionCount

public int getSessionCount()
                    throws javax.jms.JMSException,
                           java.rmi.RemoteException

Return the number of session objects currently allocated to this connection.

If there is a problem completing this request then throw RemoteException exception

Returns:

int

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

getSessions

public java.util.Enumeration getSessions()
                                  throws javax.jms.JMSException,
                                         java.rmi.RemoteException

Return an enumeration of RemoteJmsServerSessionIfc objects currently allocated to this session.

If there is a problem completing this request then throw RemoteException exception

Returns:

Enumeration

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

start

public void start()
           throws javax.jms.JMSException,
                  java.rmi.RemoteException

Start all the sessions allocated to this connection.

If there is a problem completing this request then throw RemoteException exception

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

stop

public void stop()
          throws javax.jms.JMSException,
                 java.rmi.RemoteException

Stop all the sessions allocated to this collection. Do not reemove the session

If there is a problem completing this request then throw RemoteException exception

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

close

public void close()
           throws javax.jms.JMSException,
                  java.rmi.RemoteException

Close all the sessions allocated to this collection. This will also remove the session from the allocated list of sessions

If there is a problem completing this request then throw RemoteException exception

Throws:

javax.jms.JMSException -

java.rmi.RemoteException -

getConnectionId

public java.lang.String getConnectionId()
                                 throws java.rmi.RemoteException

Retrieve the identity of this conection.

Returns:

String

Throws:

java.rmi.RemoteException -

ping

public void ping()
          throws java.rmi.RemoteException

Send a ping to the server.

Throws:

java.rmi.RemoteException -