Class AbstractTransport

java.lang.Object
org.cometd.common.AbstractTransport
All Implemented Interfaces:
Transport
Direct Known Subclasses:
AbstractServerTransport, ClientTransport

public class AbstractTransport extends Object implements Transport
  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface Transport
      Returns:
      The well known name of this transport, used in transport negotiations
      See Also:
      Bayeux.getAllowedTransports()
    • getOption

      public Object getOption(String name)
      Returns an option value for the given option name, searching the option name tree. The option map is searched for the option name with the most specific prefix. If this transport was initialized with a call to:
         setOptionPrefix("long-polling.jsonp");
       
      then a call to getOption("foobar") will look for the most specific value with names:
         long-polling.json.foobar
         long-polling.foobar
         foobar
       
      Specified by:
      getOption in interface Transport
      Parameters:
      name - the option name to return the value for.
      Returns:
      the configuration option with the given qualifiedName
      See Also:
      Transport.getOptionNames()
    • setOption

      public void setOption(String name, Object value)
      Sets the option value with the given name. The option name is inspected to see whether it starts with the option prefix; if it does not, the option prefix is prepended to the given name.
      Parameters:
      name - the option name to set the value for.
      value - the value of the option.
    • getOptionPrefix

      public String getOptionPrefix()
      Description copied from interface: Transport
      Specifies an option prefix made of string segments separated by the "." character, used to override more generic configuration entries.
      Specified by:
      getOptionPrefix in interface Transport
      Returns:
      the option prefix for this transport.
    • setOptionPrefix

      public void setOptionPrefix(String prefix)
      Set the option name prefix segment.

      Normally this is called by the super class constructors to establish a naming hierarchy for options and iteracts with the setOption(String, Object) method to create a naming hierarchy for options. For example the following sequence of calls:

         setOption("foo","x");
         setOption("bar","y");
         setOptionPrefix("long-polling");
         setOption("foo","z");
         setOption("whiz","p");
         setOptionPrefix("long-polling.jsonp");
         setOption("bang","q");
         setOption("bar","r");
       
      will establish the following option names and values:
         foo: x
         bar: y
         long-polling.foo: z
         long-polling.whiz: p
         long-polling.jsonp.bang: q
         long-polling.jsonp.bar: r
       
      The various getOption(String) methods will search this name tree for the most specific match.
      Parameters:
      prefix - the prefix name
      Throws:
      IllegalArgumentException - if the new prefix is not prefixed by the old prefix.
    • getOptionNames

      public Set<String> getOptionNames()
      Specified by:
      getOptionNames in interface Transport
      Returns:
      the set of configuration options
      See Also:
      Transport.getOption(String)
    • getOption

      public String getOption(String option, String dftValue)
      Get option or default value.
      Parameters:
      option - The option name.
      dftValue - The default value.
      Returns:
      option or default value
      See Also:
      getOption(String)
    • getOption

      public long getOption(String option, long dftValue)
      Get option or default value.
      Parameters:
      option - The option name.
      dftValue - The default value.
      Returns:
      option or default value
      See Also:
      getOption(String)
    • getOption

      public int getOption(String option, int dftValue)
      Get option or default value.
      Parameters:
      option - The option name.
      dftValue - The default value.
      Returns:
      option or default value
      See Also:
      getOption(String)
    • getOption

      public boolean getOption(String option, boolean dftValue)
      Get option or default value.
      Parameters:
      option - The option name.
      dftValue - The default value.
      Returns:
      option or default value
      See Also:
      getOption(String)