Package org.cometd.annotation.server

Annotation Type Configure

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface Configure

For server-side services, identifies channel configuration methods that are invoked when a message is processed on server-side. The methods must have the same signature as ConfigurableServerChannel.Initializer.configureChannel(ConfigurableServerChannel)

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    configureIfExists
     
    boolean
    errorIfExists
     

  • Element Details

    • value

      String[] value
      Returns:
      the list of channels which are initialised

    • errorIfExists

      boolean errorIfExists
      Returns:
      if true, then an IllegalStateException is thrown if the channel already exists
      Default:
      true

    • configureIfExists

      boolean configureIfExists
      Returns:
      if true, then the configuration method is called even if it already exists
      Default:
      false