org.apache.wicket.protocol.ws.api

Class BaseWebSocketBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.protocol.ws.api.BaseWebSocketBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

WebSocketBehavior

public class BaseWebSocketBehavior
extends Behavior

A behavior that contributes WicketWebSocketJQueryResourceReference

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseWebSocketBehavior() Constructor.
	BaseWebSocketBehavior(String resourceName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected CharSequence	getBaseUrl(WebSocketSettings webSocketSettings)
protected CharSequence	getContextPath(WebSocketSettings webSocketSettings)
protected CharSequence	getFilterPrefix(WebSocketSettings webSocketSettings)
boolean	getStatelessHint(Component component)
void	renderHead(Component component, IHeaderResponse response)

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, beforeRender, bind, canCallListenerInterface, detach, isEnabled, isTemporary, onComponentTag, onConfigure, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWebSocketBehavior

protected BaseWebSocketBehavior()

Constructor. Contributes WebSocket initialization code that will work with WebSocketBehavior

BaseWebSocketBehavior

public BaseWebSocketBehavior(String resourceName)

Constructor. Contributes WebSocket initialization code that will work with WebSocketResource To use WebSocketResource the application have to setup the resource as a shared one in its Application.init() method:

     getSharedResources().add(resourceName, new MyWebSocketResource())
 

Parameters:

resourceName - the name of the shared WebSocketResource

Method Detail

renderHead

public void renderHead(Component component,
              IHeaderResponse response)

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class Behavior

getFilterPrefix

protected CharSequence getFilterPrefix(WebSocketSettings webSocketSettings)

getContextPath

protected CharSequence getContextPath(WebSocketSettings webSocketSettings)

getBaseUrl

protected CharSequence getBaseUrl(WebSocketSettings webSocketSettings)

getStatelessHint

public boolean getStatelessHint(Component component)

Overrides:

getStatelessHint in class Behavior