Package org.objectweb.jtests.jms.admin

Interface Admin

public interface Admin
Simple Administration interface.
JMS Provider has to implement this simple interface to be able to use the test suite.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createConnectionFactory(String name)
    Creates a ConnectionFactory and makes it available from JNDI with name name.
    Context
    createContext()
    Returns an Context for the JMS Provider.
    void
    createQueue(String name)
    Creates a Queue and makes it available from JNDI with name name.
    void
    createQueueConnectionFactory(String name)
    Creates a QueueConnectionFactory and makes it available from JNDI with name name.
    void
    createTopic(String name)
    Creates a Topic and makes it available from JNDI with name name.
    void
    createTopicConnectionFactory(String name)
    Creates a TopicConnectionFactory and makes it available from JNDI with name name.
    void
    deleteConnectionFactory(String name)
    Removes the ConnectionFactory of name name from JNDI and deletes it
    void
    deleteQueue(String name)
    Removes the Queue of name name from JNDI and deletes it
    void
    deleteQueueConnectionFactory(String name)
    Removes the QueueConnectionFactory of name name from JNDI and deletes it
    void
    deleteTopic(String name)
    Removes the Topic of name name from JNDI and deletes it
    void
    deleteTopicConnectionFactory(String name)
    Removes the TopicConnectionFactory of name name from JNDI and deletes it
    String
    getName()
    Returns the name of the JMS Provider.
    void
    start()
    Optional method for processing to be made after the Admin is instantiated and before it is used to create the administrated objects
    void
    startServer()
    Optional method to start the server embedded (instead of running an external server)
    void
    stop()
    Optional method for processing to be made after the administrated objects have been cleaned up
    void
    stopServer()
    Optional method to stop the server embedded (instead of running an external server)

  • Method Details

    • getName

      String getName()
      Returns the name of the JMS Provider.
      Returns:
      name of the JMS Provider

    • createContext

      Context createContext() throws NamingException
      Returns an Context for the JMS Provider.
      Returns:
      an Context for the JMS Provider.
      Throws:
      NamingException

    • createConnectionFactory

      void createConnectionFactory(String name)
      Creates a ConnectionFactory and makes it available from JNDI with name name.
      Parameters:
      name - JNDI name of the ConnectionFactory
      Since:
      JMS 1.1

    • createQueueConnectionFactory

      void createQueueConnectionFactory(String name)
      Creates a QueueConnectionFactory and makes it available from JNDI with name name.
      Parameters:
      name - JNDI name of the QueueConnectionFactory

    • createTopicConnectionFactory

      void createTopicConnectionFactory(String name)
      Creates a TopicConnectionFactory and makes it available from JNDI with name name.
      Parameters:
      name - JNDI name of the TopicConnectionFactory

    • createQueue

      void createQueue(String name)
      Creates a Queue and makes it available from JNDI with name name.
      Parameters:
      name - JNDI name of the Queue

    • createTopic

      void createTopic(String name)
      Creates a Topic and makes it available from JNDI with name name.
      Parameters:
      name - JNDI name of the Topic

    • deleteQueue

      void deleteQueue(String name)
      Removes the Queue of name name from JNDI and deletes it
      Parameters:
      name - JNDI name of the Queue

    • deleteTopic

      void deleteTopic(String name)
      Removes the Topic of name name from JNDI and deletes it
      Parameters:
      name - JNDI name of the Topic

    • deleteConnectionFactory

      void deleteConnectionFactory(String name)
      Removes the ConnectionFactory of name name from JNDI and deletes it
      Parameters:
      name - JNDI name of the ConnectionFactory
      Since:
      JMS 1.1

    • deleteQueueConnectionFactory

      void deleteQueueConnectionFactory(String name)
      Removes the QueueConnectionFactory of name name from JNDI and deletes it
      Parameters:
      name - JNDI name of the QueueConnectionFactory

    • deleteTopicConnectionFactory

      void deleteTopicConnectionFactory(String name)
      Removes the TopicConnectionFactory of name name from JNDI and deletes it
      Parameters:
      name - JNDI name of the TopicConnectionFactory

    • startServer

      void startServer() throws Exception
      Optional method to start the server embedded (instead of running an external server)
      Throws:
      Exception

    • stopServer

      void stopServer() throws Exception
      Optional method to stop the server embedded (instead of running an external server)
      Throws:
      Exception

    • start

      void start() throws Exception
      Optional method for processing to be made after the Admin is instantiated and before it is used to create the administrated objects
      Throws:
      Exception

    • stop

      void stop() throws Exception
      Optional method for processing to be made after the administrated objects have been cleaned up
      Throws:
      Exception