|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Component
Components enhance the functionality of an XMPP server. Components receive all packets addressed to a particular sub-domain. For example, test_component.example.com. So, a packet sent to joe@test_component.example.com would be delivered to the component. Note that the sub-domains defined as components are unrelated to DNS entries for sub-domains. All XMPP routing at the socket level is done using the primary server domain (example.com in the example above); sub-domains are only used for routing within the XMPP server.
Method Summary | |
---|---|
java.lang.String |
getDescription()
Returns the description of this component. |
java.lang.String |
getName()
Returns the name of this component. |
void |
initialize(JID jid,
ComponentManager componentManager)
Initializes this component with a ComponentManager and the JID that this component is available at (e.g. |
void |
processPacket(Packet packet)
Processes a packet sent to this Component. |
void |
shutdown()
Shuts down this component. |
void |
start()
Notification message indicating that the component will start receiving incoming packets. |
Method Detail |
---|
java.lang.String getName()
java.lang.String getDescription()
void processPacket(Packet packet)
packet
- the packet.ComponentManager.sendPacket(Component, Packet)
void initialize(JID jid, ComponentManager componentManager) throws ComponentException
The initialization code must not rely on receiving packets from the server since the component has not been fully initialized yet. This means that at this point the component must not rely on information that is obtained from the server such us discovered items.
jid
- the XMPP address that this component is available at.componentManager
- the component manager.
ComponentException
- if an error occured while initializing the component.void start()
It is likely that most of the component will leave this method empty.
void shutdown()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |