Package unlimited.fc.client.api

Class TransferMechanismData.ServletLocationData

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    TransferMechanismData
    public class TransferMechanismData.ServletLocationData
extends java.lang.Object
implements java.io.Serializable
    Data object that contains the current Servlet information.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getServletLocation()
      Returns the currently set servlet URL.
      java.lang.String getServletSessionID()
      Returns the current Servlet session ID.
      java.lang.String getWelcomeMessage()
      Returns the message that the Servlet replies with when a WELCOME command is executed against it
      void setServletLocation​(java.lang.String servletLocation)
      Sets the current servlet location to the value specified.
      void setServletLocation​(java.lang.String servletLocation, java.lang.String servletSessionID, java.lang.String welcomeMessage)
      Sets the current servlet information to the value specified.
      void setServletSessionID​(java.lang.String servletSessionID)
      Sets the current servlet session ID for this data object
      void setWelcomeMessage​(java.lang.String welcomeMessage)
      Sets the welcome message that is displayed by the Servlet

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServletLocationData

        public ServletLocationData()

    • Method Detail

      • getServletLocation

        public java.lang.String getServletLocation()
        Returns the currently set servlet URL. Value is used to connect to the FC Server during HTTP transfers
        Returns:
        URL pointing to the current servlet location

      • getServletSessionID

        public java.lang.String getServletSessionID()
        Returns the current Servlet session ID. Used internally to keep sessions separate from each other.
        Returns:
        Randomly generated ID representing the current Servlet session

      • getWelcomeMessage

        public java.lang.String getWelcomeMessage()
        Returns the message that the Servlet replies with when a WELCOME command is executed against it
        Returns:
        String containing the welcome message of the Servlet

      • setServletLocation

        public void setServletLocation​(java.lang.String servletLocation)
        Sets the current servlet location to the value specified. Value is used to connect to the FC Server during HTTP transfers
        Parameters:
        servletLocation - Servlet URL to set

      • setServletLocation

        public void setServletLocation​(java.lang.String servletLocation,
                               java.lang.String servletSessionID,
                               java.lang.String welcomeMessage)
        Sets the current servlet information to the value specified.
        Parameters:
        servletLocation - Servlet URL to set
        servletSessionID - Current sesssion ID of the Servlet
        welcomeMessage - Welcome message that is displayed by the Servlet

      • setServletSessionID

        public void setServletSessionID​(java.lang.String servletSessionID)
        Sets the current servlet session ID for this data object
        Parameters:
        servletSessionID - Session ID to set

      • setWelcomeMessage

        public void setWelcomeMessage​(java.lang.String welcomeMessage)
        Sets the welcome message that is displayed by the Servlet
        Parameters:
        welcomeMessage - Message to set