Package org.jivesoftware.openfire.filetransfer.proxy

Class FileTransferProxy

java.lang.Object
org.jivesoftware.openfire.container.BasicModule
org.jivesoftware.openfire.filetransfer.proxy.FileTransferProxy
All Implemented Interfaces:
ChannelHandler<org.xmpp.packet.Packet>, Module, DiscoInfoProvider, DiscoItemsProvider, ServerItemsProvider, RoutableChannelHandler
public class FileTransferProxy extends BasicModule implements ServerItemsProvider, DiscoInfoProvider, DiscoItemsProvider, RoutableChannelHandler
Manages the transferring of files between two remote entities on the jabber network. This class acts independently as a Jabber component from the rest of the server, according to the Jabber SOCKS5 bytestreams protocol.
Author:
Alexander Wenckus

  • Field Details

    • JIVEPROPERTY_PROXY_ENABLED

      public static final String JIVEPROPERTY_PROXY_ENABLED
      The JiveProperty relating to whether or not the file transfer proxy is enabled.
      See Also:

    • JIVEPROPERTY_PORT

      public static final String JIVEPROPERTY_PORT
      The JiveProperty relating to the port the proxy is operating on. Changing this value requires a restart of the proxy.
      See Also:

    • PROPERTY_EXTERNALIP

      public static final String PROPERTY_EXTERNALIP
      Name of the property that hardcodes the external IP that is being listened on.
      See Also:

    • DEFAULT_IS_PROXY_ENABLED

      public static final boolean DEFAULT_IS_PROXY_ENABLED
      Whether or not the file transfer proxy is enabled by default.
      See Also:

    • DEFAULT_PORT

      public static final int DEFAULT_PORT
      The default port of the file transfer proxy
      See Also:

  • Constructor Details

    • FileTransferProxy

      public FileTransferProxy()

  • Method Details

    • handleIQ

      public boolean handleIQ(org.xmpp.packet.IQ packet) throws UnauthorizedException
      Throws:
      UnauthorizedException

    • getInfo

      public IQHandlerInfo getInfo()

    • initialize

      public void initialize(XMPPServer server)
      Description copied from class: BasicModule

      Initializes the basic module.

      Inheriting classes that choose to override this method MUST call this initialize() method before accessing BasicModule resources.

      Specified by:
      initialize in interface Module
      Overrides:
      initialize in class BasicModule
      Parameters:
      server - the server hosting this module.

    • start

      public void start()
      Description copied from class: BasicModule

      Starts the basic module.

      Inheriting classes that choose to override this method MUST call this start() method before accessing BasicModule resources.

      Specified by:
      start in interface Module
      Overrides:
      start in class BasicModule

    • stop

      public void stop()
      Description copied from class: BasicModule

      Stops the basic module.

      Inheriting classes that choose to override this method MUST call this stop() method before accessing BasicModule resources.

      Specified by:
      stop in interface Module
      Overrides:
      stop in class BasicModule

    • destroy

      public void destroy()
      Description copied from class: BasicModule

      Destroys the module.

      Does nothing in the basic module.

      Specified by:
      destroy in interface Module
      Overrides:
      destroy in class BasicModule

    • enableFileTransferProxy

      public void enableFileTransferProxy(boolean isEnabled)

    • isProxyEnabled

      public boolean isProxyEnabled()
      Returns true if the file transfer proxy is currently enabled and false if it is not.
      Returns:
      Returns true if the file transfer proxy is currently enabled and false if it is not.

    • setProxyPort

      public void setProxyPort(int port)
      Sets the port that the proxy operates on. This requires a restart of the file transfer proxy.
      Parameters:
      port - The port.

    • getProxyPort

      public int getProxyPort()
      Returns the port that the file transfer proxy is opertating on.
      Returns:
      Returns the port that the file transfer proxy is opertating on.

    • getServiceDomain

      public String getServiceDomain()
      Returns the fully-qualifed domain name of this chat service. The domain is composed by the service name and the name of the XMPP server where the service is running.
      Returns:
      the file transfer server domain (service name + host name).

    • getAddress

      public org.xmpp.packet.JID getAddress()
      Description copied from interface: RoutableChannelHandler
      Returns the XMPP address. The address is used by services like the core server packet router to determine if a packet should be sent to the handler. Handlers that are working on behalf of the server should use the generic server hostname address (e.g. server.com).
      Specified by:
      getAddress in interface RoutableChannelHandler
      Returns:
      the XMPP address.

    • getItems

      public Iterator<DiscoServerItem> getItems()
      Description copied from interface: ServerItemsProvider
      Returns an Iterator (of DiscoServerItem) with the items associated with the server or null if none.
      Specified by:
      getItems in interface ServerItemsProvider
      Returns:
      an Iterator (of DiscoServerItem) with the items associated with the server or null if none.

    • getIdentities

      public Iterator<org.dom4j.Element> getIdentities(String name, String node, org.xmpp.packet.JID senderJID)
      Description copied from interface: DiscoInfoProvider
      Returns an Iterator (of Element) with the target entity's identities. Each Element must include the category, type and name attributes of the entity.
      Specified by:
      getIdentities in interface DiscoInfoProvider
      Parameters:
      name - the recipient JID's name.
      node - the requested disco node.
      senderJID - the XMPPAddress of user that sent the disco info request.
      Returns:
      an Iterator (of Element) with the target entity's identities.

    • getFeatures

      public Iterator<String> getFeatures(String name, String node, org.xmpp.packet.JID senderJID)
      Description copied from interface: DiscoInfoProvider
      Returns an Iterator (of String) with the supported features. The features to include are the features offered and supported protocols by the target entity identified by the requested name and node.
      Specified by:
      getFeatures in interface DiscoInfoProvider
      Parameters:
      name - the recipient JID's name.
      node - the requested disco node.
      senderJID - the XMPPAddress of user that sent the disco info request.
      Returns:
      an Iterator (of String) with the supported features.

    • getExtendedInfos

      public Set<org.xmpp.forms.DataForm> getExtendedInfos(String name, String node, org.xmpp.packet.JID senderJID)
      Description copied from interface: DiscoInfoProvider
      Returns a collection of XDataForm with the extended information about the entity or an empty collection if none. Each bit of information about the entity must be included as a value of a field of the form.
      Specified by:
      getExtendedInfos in interface DiscoInfoProvider
      Parameters:
      name - the recipient JID's name.
      node - the requested disco node.
      senderJID - the XMPPAddress of user that sent the disco info request.
      Returns:
      A collection of XDataForms with the extended information about the entity or an empty collection if none.

    • hasInfo

      public boolean hasInfo(String name, String node, org.xmpp.packet.JID senderJID)
      Description copied from interface: DiscoInfoProvider
      Returns true if we can provide information related to the requested name and node. For example, if the requested name refers to a non-existent MUC room then the answer will be false. In case that the sender of the disco request is not authorized to discover this information an UnauthorizedException will be thrown.
      Specified by:
      hasInfo in interface DiscoInfoProvider
      Parameters:
      name - the recipient JID's name.
      node - the requested disco node.
      senderJID - the XMPPAddress of user that sent the disco info request.
      Returns:
      true if we can provide information related to the requested name and node.

    • getItems

      public Iterator<DiscoItem> getItems(String name, String node, org.xmpp.packet.JID senderJID)
      Description copied from interface: DiscoItemsProvider
      Returns an Iterator (of DiscoItem) with the target entity's items or null if none. Each DiscoItem must include a JID attribute and may include the name and node attributes of the entity. In case that the sender of the disco request is not authorized to discover items an UnauthorizedException will be thrown.
      Specified by:
      getItems in interface DiscoItemsProvider
      Parameters:
      name - the recipient JID's name.
      node - the requested disco node.
      senderJID - the XMPPAddress of user that sent the disco items request.
      Returns:
      an Iterator (of DiscoItem) with the target entity's items or null if none.

    • process

      public void process(org.xmpp.packet.Packet packet) throws UnauthorizedException, PacketException
      Description copied from interface: ChannelHandler
      Process an XMPP packet.
      Specified by:
      process in interface ChannelHandler<org.xmpp.packet.Packet>
      Parameters:
      packet - a packet to process.
      Throws:
      UnauthorizedException - if not allowed to process the packet.
      PacketException - thrown if the packet is malformed (results in the sender's session being shutdown).