Package org.objectweb.joram.tools.rest.admin

Class AdminHelper

java.lang.Object

org.objectweb.joram.tools.rest.admin.AdminHelper

public final class AdminHelper
extends Object

Creates a JMS administration point through Rest API. Be careful, currently only the local broker can be administered. this could be easily changed by specifying a connection factory.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUNDLE_JMS_PASS
static String	BUNDLE_JMS_USER
static String	BUNDLE_JNDI_FACTORY_HOST_PROP
static String	BUNDLE_JNDI_FACTORY_INITIAL_PROP
static String	BUNDLE_JNDI_FACTORY_PORT_PROP
static String	BUNDLE_REST_ADMIN_IP_ALLOWED
static String	BUNDLE_REST_ADMIN_PASS
static String	BUNDLE_REST_ADMIN_ROOT
private org.osgi.framework.BundleContext	bundleContext
private jakarta.jms.Connection	cnx
private static boolean	DEBUG
private static AdminHelper	helper
private InitialContext	ictx
private IPFilter	ipfilter
(package private) String	jmsRootPassword
(package private) String	jmsRootUser
private Properties	jndiProps
private JoramAdmin	joramAdmin
private static Logger	logger
private String	restAdminIPAllowed
private String	restAdminPass
private String	restAdminRoot

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AdminHelper()

Method Summary

Modifier and Type	Method	Description
boolean	authenticationRequired()
boolean	checkIpAllowed(String addr)	Check if the addr is authorized (all local address is authorized).
jakarta.jms.ConnectionFactory	createlocalConnectionFactory()
Destination	createQueue(int serverId, String name)
Destination	createQueue(int serverId, String name, String className, Properties props)
Destination	createQueue(String name)
jakarta.jms.ConnectionFactory	createTcpConnectionFactory()
jakarta.jms.ConnectionFactory	createTcpConnectionFactory(String host, int port, String reliableClass)
Destination	createTopic(int serverId, String name)
Destination	createTopic(int serverId, String name, String className, Properties props)
Destination	createTopic(String name)
User	createUser(String name, String password)
User	createUser(String name, String password, int serverId, String identityClassName, Properties props)
void	deleteQueue(int serverId, String name)
void	deleteTopic(int serverId, String name)
void	deleteUser(String name, String password, int serverId)
static AdminHelper	getInstance()
JoramAdmin	getJoramAdmin()
int	getLocalServerId()
ArrayList<Destination>	getQueueNames(int serverId)
String	getRestAdminIPAllowed()
String	getRestAdminPass()
String	getRestAdminRoot()
ArrayList<Destination>	getTopicNames(int serverId)
void	init(org.osgi.framework.BundleContext bundleContext)
void	rebind(String name, jakarta.jms.ConnectionFactory cf)
void	rebind(String name, Destination dest)
void	startJoramAdmin(String name)
void	stopJoramAdmin()
void	unbind(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

BUNDLE_JNDI_FACTORY_INITIAL_PROP

public static final String BUNDLE_JNDI_FACTORY_INITIAL_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_HOST_PROP

public static final String BUNDLE_JNDI_FACTORY_HOST_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_PORT_PROP

public static final String BUNDLE_JNDI_FACTORY_PORT_PROP

See Also:

Constant Field Values

BUNDLE_REST_ADMIN_ROOT

public static final String BUNDLE_REST_ADMIN_ROOT

See Also:

Constant Field Values

BUNDLE_REST_ADMIN_PASS

public static final String BUNDLE_REST_ADMIN_PASS

See Also:

Constant Field Values

BUNDLE_REST_ADMIN_IP_ALLOWED

public static final String BUNDLE_REST_ADMIN_IP_ALLOWED

See Also:

Constant Field Values

BUNDLE_JMS_USER

public static final String BUNDLE_JMS_USER

See Also:

Constant Field Values

BUNDLE_JMS_PASS

public static final String BUNDLE_JMS_PASS

See Also:

Constant Field Values

helper

private static AdminHelper helper

ictx

private InitialContext ictx

bundleContext

private org.osgi.framework.BundleContext bundleContext

jndiProps

private Properties jndiProps

joramAdmin

private JoramAdmin joramAdmin

cnx

private jakarta.jms.Connection cnx

restAdminRoot

private String restAdminRoot

restAdminPass

private String restAdminPass

restAdminIPAllowed

private String restAdminIPAllowed

ipfilter

private IPFilter ipfilter

jmsRootUser

String jmsRootUser

jmsRootPassword

String jmsRootPassword

Constructor Detail

AdminHelper

private AdminHelper()

Method Detail

getInstance

public static AdminHelper getInstance()

getRestAdminRoot

public String getRestAdminRoot()

Returns:

the restAdminRoot

getRestAdminPass

public String getRestAdminPass()

Returns:

the restAdminPass

getRestAdminIPAllowed

public String getRestAdminIPAllowed()

Returns:

the restAdminIPAllowed

checkIpAllowed

public boolean checkIpAllowed(String addr)

Check if the addr is authorized (all local address is authorized).

Parameters:

addr - The ip address to check

Returns:

true if authorized

Throws:

UnknownHostException

SocketException

authenticationRequired

public boolean authenticationRequired()

startJoramAdmin

public void startJoramAdmin(String name)
                     throws ConnectException,
                            AdminException,
                            jakarta.jms.JMSException

Throws:

ConnectException

AdminException

jakarta.jms.JMSException

stopJoramAdmin

public void stopJoramAdmin()

getJoramAdmin

public JoramAdmin getJoramAdmin()

init

public void init(org.osgi.framework.BundleContext bundleContext)
          throws Exception

Throws:

Exception

getQueueNames

public ArrayList<Destination> getQueueNames(int serverId)
                                     throws ConnectException,
                                            AdminException

Throws:

ConnectException

AdminException

createQueue

public Destination createQueue(String name)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

createQueue

public Destination createQueue(int serverId,
                               String name)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

createQueue

public Destination createQueue(int serverId,
                               String name,
                               String className,
                               Properties props)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

deleteQueue

public void deleteQueue(int serverId,
                        String name)
                 throws ConnectException,
                        AdminException,
                        jakarta.jms.JMSException

Throws:

ConnectException

AdminException

jakarta.jms.JMSException

getTopicNames

public ArrayList<Destination> getTopicNames(int serverId)
                                     throws ConnectException,
                                            AdminException

Throws:

ConnectException

AdminException

createTopic

public Destination createTopic(String name)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

createTopic

public Destination createTopic(int serverId,
                               String name)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

createTopic

public Destination createTopic(int serverId,
                               String name,
                               String className,
                               Properties props)
                        throws ConnectException,
                               AdminException

Throws:

ConnectException

AdminException

deleteTopic

public void deleteTopic(int serverId,
                        String name)
                 throws ConnectException,
                        AdminException,
                        jakarta.jms.JMSException

Throws:

ConnectException

AdminException

jakarta.jms.JMSException

createUser

public User createUser(String name,
                       String password)
                throws ConnectException,
                       AdminException

Throws:

ConnectException

AdminException

createUser

public User createUser(String name,
                       String password,
                       int serverId,
                       String identityClassName,
                       Properties props)
                throws ConnectException,
                       AdminException

Throws:

ConnectException

AdminException

deleteUser

public void deleteUser(String name,
                       String password,
                       int serverId)
                throws ConnectException,
                       AdminException

Throws:

ConnectException

AdminException

createTcpConnectionFactory

public jakarta.jms.ConnectionFactory createTcpConnectionFactory()

createTcpConnectionFactory

public jakarta.jms.ConnectionFactory createTcpConnectionFactory(String host,
                                                                int port,
                                                                String reliableClass)

createlocalConnectionFactory

public jakarta.jms.ConnectionFactory createlocalConnectionFactory()

rebind

public void rebind(String name,
                   Destination dest)
            throws NamingException

Throws:

NamingException

rebind

public void rebind(String name,
                   jakarta.jms.ConnectionFactory cf)
            throws NamingException

Throws:

NamingException

unbind

public void unbind(String name)
            throws NamingException

Throws:

NamingException

getLocalServerId

public int getLocalServerId()
                     throws ConnectException,
                            AdminException

Throws:

ConnectException

AdminException