|
Openfire 3.3.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.openfire.session.ComponentSession.ExternalComponent
public class ComponentSession.ExternalComponent
The ExternalComponent acts as a proxy of the remote connected component. Any Packet that is sent to this component will be delivered to the real component on the other side of the connection.
An ExternalComponent will be added as a route in the RoutingTable for each connected external component. This implies that when the server receives a packet whose domain matches the external component services address then a route to the external component will be used and the packet will be forwarded to the component on the other side of the connection.
Constructor Summary | |
---|---|
ComponentSession.ExternalComponent()
|
Method Summary | |
---|---|
String |
getCategory()
|
String |
getDescription()
Returns the description of this component. |
String |
getInitialSubdomain()
|
String |
getName()
Returns the name of this component. |
Collection<String> |
getSubdomains()
|
String |
getType()
|
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 |
setCategory(String category)
|
void |
setName(String name)
|
void |
setType(String type)
|
void |
shutdown()
Shuts down this component. |
void |
start()
Notification message indicating that the component will start receiving incoming packets. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ComponentSession.ExternalComponent()
Method Detail |
---|
public void processPacket(Packet packet)
Component
processPacket
in interface Component
packet
- the packet.ComponentManager.sendPacket(Component, Packet)
public String getName()
Component
getName
in interface Component
public String getDescription()
Component
getDescription
in interface Component
public void setName(String name)
public String getType()
public void setType(String type)
public String getCategory()
public void setCategory(String category)
public String getInitialSubdomain()
public Collection<String> getSubdomains()
public void initialize(JID jid, ComponentManager componentManager)
Component
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.
initialize
in interface Component
jid
- the XMPP address that this component is available at.componentManager
- the component manager.public void start()
Component
It is likely that most of the component will leave this method empty.
start
in interface Component
public void shutdown()
Component
shutdown
in interface Component
public String toString()
toString
in class Object
|
Openfire 3.3.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |