Package org.ow2.joram.jakarta.connector

Interface JoramAdapterMBean

  • All Known Implementing Classes:
    JoramAdapter
    public interface JoramAdapterMBean

    • Method Detail

      • isActive

        boolean isActive()
        return the activity of the Joram administration connection.
        Returns:
        true if connection admin connection is active.

      • getAdminDurationBeforeChangeState

        long getAdminDurationBeforeChangeState()
        get the duration of admin connection before change state.
        Returns:
        the duration of admin connection before change state.

      • getAdminDurationBeforeChangeStateDate

        String getAdminDurationBeforeChangeStateDate()
        get the duration of admin connection before change state.
        Returns:
        the duration of admin connection before change state.

      • getJMSVersion

        String getJMSVersion()
        Gets the JMS API version.
        Returns:
        The JMS API version.

      • getJMSProviderName

        String getJMSProviderName()
        Get the provider name: Joram.
        Returns:
        The provider name: Joram.

      • getProviderVersion

        String getProviderVersion()
        Gets the Joram's implementation version.
        Returns:
        The Joram's implementation version.

      • getServerId

        Short getServerId()
        Returns the unique identifier of the Joram server.
        Returns:
        The unique identifier of the Joram server.

      • getName

        String getName()
        Returns the name of the resource adapter.
        Returns:
        The name of the resource adapter.

      • getHostName

        String getHostName()
        Returns the location of the Joram server.
        Returns:
        The location of the Joram server.

      • getServerPort

        Integer getServerPort()
        Returns the listening port of the Joram server.
        Returns:
        The listening port of the Joram server.

      • getCollocated

        Boolean getCollocated()
        Returns true if the Joram server is collocated.
        Returns:
        true if the Joram server is collocated.

      • getConnectingTimer

        Integer getConnectingTimer()
        Duration in seconds during which connecting is attempted (connecting might take time if the server is temporarily not reachable); the 0 value is set for connecting only once and aborting if connecting failed.

      • getDefaultDMQId

        String getDefaultDMQId()
                throws ConnectException,
                       AdminException
        Returns the unique identifier of the default dead message queue for the local server, null if not set.
        Returns:
        The unique identifier of the dead message queue of the local server or null if none exists.
        Throws:
        ConnectException - If the connection fails.
        AdminException - Never thrown.

      • getDefaultDMQId

        String getDefaultDMQId​(short serverId)
                throws ConnectException,
                       AdminException
        Returns the unique identifier of the default dead message queue for a given server, null if not set.

        The request fails if the target server does not belong to the platform.

        Parameters:
        serverId - Unique identifier of the given server.
        Returns:
        The unique identifier of the dead message queue of the given server or null if none exists.
        Throws:
        ConnectException - If the connection fails.
        AdminException - If the request fails.

      • getDestinations

        String[] getDestinations()
                  throws ConnectException,
                         AdminException
        Returns the list of all destinations that exist on the local server. This method creates and registers MBeans for all the destinations of the selected servers.
        Returns:
        An array containing the object name of all destinations defined on the given server or null if none exists.
        Throws:
        ConnectException - If the connection is closed or broken.
        AdminException - Never thrown.
        See Also:
        getDestinations(short)

      • getDestinations

        String[] getDestinations​(short serverId)
                  throws ConnectException,
                         AdminException
        Returns the list of all destinations that exist on the given server. This method creates and registers MBeans for all the destinations of the selected servers.

        The request fails if the target server does not belong to the platform.

        Returns:
        An array containing the object name of all destinations defined on the given server or null if none exists.
        Throws:
        ConnectException - If the connection is closed or broken.
        AdminException - Never thrown.
        See Also:
        getDestinations(short)

      • createQueue

        String createQueue​(short serverId,
                   String name)
            throws AdminException,
                   ConnectException
        Creates or retrieves a queue destination on the underlying JORAM server, (re)binds the corresponding Queue instance.
        Parameters:
        serverId - The identifier of the server where deploying the queue.
        name - The name of the queue.
        Throws:
        AdminException - If the creation fails.
        ConnectException - if the connection is closed or broken

      • createTopic

        String createTopic​(String name)
            throws AdminException,
                   ConnectException
        Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
        Parameters:
        name - The name of the topic.
        Throws:
        AdminException - If the creation fails.
        ConnectException - if the connection is closed or broken
        See Also:
        #createTopic(int, String)

      • createTopic

        String createTopic​(short serverId,
                   String name)
            throws AdminException,
                   ConnectException
        Creates or retrieves a topic destination on the underlying JORAM server, (re)binds the corresponding Topic instance.
        Parameters:
        serverId - The identifier of the server where deploying the topic.
        name - The name of the topic.
        Throws:
        AdminException - If the creation fails.
        ConnectException - if the connection is closed or broken

      • removeDestination

        void removeDestination​(String name)
                throws AdminException
        Remove a destination specified by its JNDI name on the underlying JORAM platform.
        Parameters:
        name - The JNDI name of the destination.
        Throws:
        AdminException

      • getUsers

        String[] getUsers()
           throws ConnectException,
                  AdminException
        Returns the list of all users that exist on the local server. This method creates and registers MBeans for all the users of the selected servers.
        Returns:
        An array containing the object name of all users defined on the given server or null if none exists.
        Throws:
        ConnectException - If the connection fails.
        AdminException - Never thrown.
        See Also:
        getUsers(short)

      • getUsers

        String[] getUsers​(short serverId)
           throws ConnectException,
                  AdminException
        Returns the list of all users that exist on a given server. This method creates and registers MBeans for all the users of the selected servers.

        The request fails if the target server does not belong to the platform.

        Parameters:
        serverId - Unique identifier of the given server.
        Returns:
        An array containing the object name of all users defined on the given server or null if none exists.
        Throws:
        ConnectException - If the connection fails.
        AdminException - If the request fails.

      • createUser

        String createUser​(String name,
                  String password,
                  short serverId,
                  String identityClass)
           throws ConnectException,
                  AdminException
        Creates or retrieves a user on the underlying JORAM server.
        Parameters:
        name - The login name of the user.
        password - The password of the user.
        serverId - The unique identifier of the Joram server.
        identityClass - The identity class used for authentication.
        Returns:
        The object name of created user.
        Throws:
        AdminException - If the creation fails.
        ConnectException - If the connection fails.

      • createCF

        void createCF​(String name)
       throws Exception
        Creates a non managed connection factory and binds it to JNDI.
        Parameters:
        name - Name of created connection factory.
        Throws:
        Exception

      • createQueueCF

        void createQueueCF​(String name)
        Creates a non managed PTP connection factory and binds it to JNDI.
        Parameters:
        name - Name of created connection factory.

      • createTopicCF

        void createTopicCF​(String name)
        Creates a non managed PubSub connection factory and binds it to JNDI.
        Parameters:
        name - Name of created connection factory.

      • getPlatformConfigDir

        String getPlatformConfigDir()
        Path to the directory containing JORAM's configuration files (a3servers.xml, a3debug.cfg and admin file), needed when StartJoramServer is set to true.

      • getAdminFileXML

        String getAdminFileXML()
        Path to the XML file containing a description of the administered objects to create and bind.

      • getAdminFileExportXML

        String getAdminFileExportXML()

      • exportRepositoryToFile

        void exportRepositoryToFile​(String exportDir)
                     throws AdminException
        Export the repository content to an XML file with default filename. - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)
        Parameters:
        exportDir - target directory where the export file will be put
        Throws:
        AdminException - if an error occurs

      • exportRepositoryToFile

        void exportRepositoryToFile​(String exportDir,
                            String exportFilename)
                     throws AdminException
        Export the repository content to an XML file - only the destinations objects are retrieved in this version - xml script format of the admin objects (joramAdmin.xml)
        Parameters:
        exportDir - target directory where the export file will be put
        exportFilename - filename of the export file
        Throws:
        AdminException - if an error occurs

      • getStorage

        String getStorage()
        The persistence directory of the JORAM server to start, needed when StartJoramServer is set to true.
        Returns:
        the persistence directory.

      • getJndiName

        String getJndiName()
        The Joram resource adapter jndi name.
        Returns:
        the Joram resource adapter jndi name.

      • getRootName

        String getRootName()
        login name for administrator.

      • getIdentityClass

        String getIdentityClass()
        Identity class needed for authentication

      • getStartJoramServer

        Boolean getStartJoramServer()
        true if the resource adapter start the JoramServer

      • getCollocatedServer

        Boolean getCollocatedServer()
        Deprecated.
        only needed for compatibility with JOnAS 5.2 administration GUI
        Returns true if the server is colocated.
        See Also:
        getCollocatedServer()

      • getServerName

        String getServerName()
        Deprecated.
        only needed for compatibility with JOnAS 5.2 administration GUI
        Returns the server name.
        See Also:
        getServerName()