Package org.apache.activemq.web

Class WebClient

java.lang.Object

org.apache.activemq.web.WebClient

All Implemented Interfaces:

jakarta.servlet.http.HttpSessionActivationListener, jakarta.servlet.http.HttpSessionBindingListener, Externalizable, Serializable, EventListener

Direct Known Subclasses:

AjaxWebClient

public class WebClient
extends Object
implements jakarta.servlet.http.HttpSessionActivationListener, jakarta.servlet.http.HttpSessionBindingListener, Externalizable

Represents a messaging client used from inside a web container typically stored inside a HttpSession TODO controls to prevent DOS attacks with users requesting many consumers TODO configure consumers with small prefetch.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROKER_URL_INIT_PARAM
static final String	CONNECTION_FACTORY_ATTRIBUTE
static final String	CONNECTION_FACTORY_OPTIMIZE_ACK_PARAM
static final String	CONNECTION_FACTORY_PREFETCH_PARAM
static final String	PASSWORD_INIT_PARAM
static final String	SELECTOR_NAME
static String	selectorName
static final String	USERNAME_INIT_PARAM
static final String	WEB_CLIENT_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
WebClient()

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeConsumer(jakarta.jms.Destination destination)
void	closeConsumers()
protected jakarta.jms.Session	createSession()
protected static WebClient	createWebClient(jakarta.servlet.http.HttpServletRequest request)
jakarta.jms.Connection	getConnection()
jakarta.jms.MessageConsumer	getConsumer(jakarta.jms.Destination destination, String selector)
jakarta.jms.MessageConsumer	getConsumer(jakarta.jms.Destination destination, String selector, boolean create)
List<jakarta.jms.MessageConsumer>	getConsumers()
int	getDeliveryMode()
String	getPassword()
jakarta.jms.MessageProducer	getProducer()
Semaphore	getSemaphore()
jakarta.jms.Session	getSession()
String	getUsername()
static WebClient	getWebClient(jakarta.servlet.http.HttpServletRequest request)	Helper method to get the client for the current session, lazily creating a client if there is none currently
static WebClient	getWebClient(jakarta.servlet.http.HttpSession session)
protected static void	initConnectionFactory(jakarta.servlet.ServletContext servletContext)
static void	initContext(jakarta.servlet.ServletContext context)
boolean	isClosed()
void	readExternal(ObjectInput in)
void	send(jakarta.jms.Destination destination, jakarta.jms.Message message)
void	send(jakarta.jms.Destination destination, jakarta.jms.Message message, boolean persistent, int priority, long timeToLive)
void	sessionDidActivate(jakarta.servlet.http.HttpSessionEvent event)
void	sessionWillPassivate(jakarta.servlet.http.HttpSessionEvent event)
void	setDeliveryMode(int deliveryMode)
void	setPassword(String password)
void	setProducer(jakarta.jms.MessageProducer producer)
void	setUsername(String username)
void	valueBound(jakarta.servlet.http.HttpSessionBindingEvent event)
void	valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent event)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Details

WEB_CLIENT_ATTRIBUTE

public static final String WEB_CLIENT_ATTRIBUTE

See Also:

• Constant Field Values

CONNECTION_FACTORY_ATTRIBUTE

public static final String CONNECTION_FACTORY_ATTRIBUTE

See Also:

• Constant Field Values

CONNECTION_FACTORY_PREFETCH_PARAM

public static final String CONNECTION_FACTORY_PREFETCH_PARAM

See Also:

• Constant Field Values

CONNECTION_FACTORY_OPTIMIZE_ACK_PARAM

public static final String CONNECTION_FACTORY_OPTIMIZE_ACK_PARAM

See Also:

• Constant Field Values

BROKER_URL_INIT_PARAM

public static final String BROKER_URL_INIT_PARAM

See Also:

• Constant Field Values

USERNAME_INIT_PARAM

public static final String USERNAME_INIT_PARAM

See Also:

• Constant Field Values

PASSWORD_INIT_PARAM

public static final String PASSWORD_INIT_PARAM

See Also:

• Constant Field Values

SELECTOR_NAME

public static final String SELECTOR_NAME

See Also:

• Constant Field Values

selectorName

public static String selectorName

Constructor Details

WebClient

public WebClient()

Method Details

getWebClient

public static WebClient getWebClient(jakarta.servlet.http.HttpServletRequest request)

Helper method to get the client for the current session, lazily creating a client if there is none currently

Parameters:

request - is the current HTTP request

Returns:

the current client or a newly creates

getWebClient

public static WebClient getWebClient(jakarta.servlet.http.HttpSession session)

Returns:

the web client for the current HTTP session or null if there is not a web client created yet

initContext

public static void initContext(jakarta.servlet.ServletContext context)

getDeliveryMode

public int getDeliveryMode()

setDeliveryMode

public void setDeliveryMode(int deliveryMode)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

closeConsumers

public void closeConsumers()

close

public void close()

isClosed

public boolean isClosed()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

send

public void send(jakarta.jms.Destination destination,
 jakarta.jms.Message message)
          throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

send

public void send(jakarta.jms.Destination destination,
 jakarta.jms.Message message,
 boolean persistent,
 int priority,
 long timeToLive)
          throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getSession

public jakarta.jms.Session getSession()
                               throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getConnection

public jakarta.jms.Connection getConnection()
                                     throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

initConnectionFactory

protected static void initConnectionFactory(jakarta.servlet.ServletContext servletContext)

getProducer

public jakarta.jms.MessageProducer getProducer()
                                        throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

setProducer

public void setProducer(jakarta.jms.MessageProducer producer)

getConsumer

public jakarta.jms.MessageConsumer getConsumer(jakarta.jms.Destination destination,
 String selector)
                                        throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getConsumer

public jakarta.jms.MessageConsumer getConsumer(jakarta.jms.Destination destination,
 String selector,
 boolean create)
                                        throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

closeConsumer

public void closeConsumer(jakarta.jms.Destination destination)
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getConsumers

public List<jakarta.jms.MessageConsumer> getConsumers()

createSession

protected jakarta.jms.Session createSession()
                                     throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getSemaphore

public Semaphore getSemaphore()

sessionWillPassivate

public void sessionWillPassivate(jakarta.servlet.http.HttpSessionEvent event)

Specified by:

sessionWillPassivate in interface jakarta.servlet.http.HttpSessionActivationListener

sessionDidActivate

public void sessionDidActivate(jakarta.servlet.http.HttpSessionEvent event)

Specified by:

sessionDidActivate in interface jakarta.servlet.http.HttpSessionActivationListener

valueBound

public void valueBound(jakarta.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueBound in interface jakarta.servlet.http.HttpSessionBindingListener

valueUnbound

public void valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent event)

Specified by:

valueUnbound in interface jakarta.servlet.http.HttpSessionBindingListener

createWebClient

protected static WebClient createWebClient(jakarta.servlet.http.HttpServletRequest request)