Package org.apache.camel.builder.endpoint.dsl

Interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
IrcEndpointBuilderFactory.IrcEndpointBuilder
Enclosing interface:
IrcEndpointBuilderFactory
public static interface IrcEndpointBuilderFactory.IrcEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the IRC component.

  • Method Details

    • advanced

      default IrcEndpointBuilderFactory.AdvancedIrcEndpointProducerBuilder advanced()

    • autoRejoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder autoRejoin(boolean autoRejoin)
      Whether to auto re-join when being kicked. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      autoRejoin - the value to set
      Returns:
      the dsl builder

    • autoRejoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder autoRejoin(String autoRejoin)
      Whether to auto re-join when being kicked. The option will be converted to a <code>boolean</code> type. Default: true Group: common
      Parameters:
      autoRejoin - the value to set
      Returns:
      the dsl builder

    • channels

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder channels(String channels)
      Comma separated list of IRC channels. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      channels - the value to set
      Returns:
      the dsl builder

    • commandTimeout

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder commandTimeout(long commandTimeout)
      Delay in milliseconds before sending commands after the connection is established. The option is a: <code>long</code> type. Default: 5000 Group: common
      Parameters:
      commandTimeout - the value to set
      Returns:
      the dsl builder

    • commandTimeout

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder commandTimeout(String commandTimeout)
      Delay in milliseconds before sending commands after the connection is established. The option will be converted to a <code>long</code> type. Default: 5000 Group: common
      Parameters:
      commandTimeout - the value to set
      Returns:
      the dsl builder

    • keys

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder keys(String keys)
      Comma separated list of keys for channels. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      keys - the value to set
      Returns:
      the dsl builder

    • namesOnJoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder namesOnJoin(boolean namesOnJoin)
      Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      namesOnJoin - the value to set
      Returns:
      the dsl builder

    • namesOnJoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder namesOnJoin(String namesOnJoin)
      Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      namesOnJoin - the value to set
      Returns:
      the dsl builder

    • nickname

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder nickname(String nickname)
      The nickname used in chat. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      nickname - the value to set
      Returns:
      the dsl builder

    • persistent

      @Deprecated default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder persistent(boolean persistent)
      Deprecated.
      Use persistent messages. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      persistent - the value to set
      Returns:
      the dsl builder

    • persistent

      @Deprecated default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder persistent(String persistent)
      Deprecated.
      Use persistent messages. The option will be converted to a <code>boolean</code> type. Default: true Group: common
      Parameters:
      persistent - the value to set
      Returns:
      the dsl builder

    • realname

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder realname(String realname)
      The IRC user's actual name. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      realname - the value to set
      Returns:
      the dsl builder

    • onJoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onJoin(boolean onJoin)
      Handle user join events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onJoin - the value to set
      Returns:
      the dsl builder

    • onJoin

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onJoin(String onJoin)
      Handle user join events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onJoin - the value to set
      Returns:
      the dsl builder

    • onKick

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onKick(boolean onKick)
      Handle kick events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onKick - the value to set
      Returns:
      the dsl builder

    • onKick

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onKick(String onKick)
      Handle kick events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onKick - the value to set
      Returns:
      the dsl builder

    • onMode

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onMode(boolean onMode)
      Handle mode change events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onMode - the value to set
      Returns:
      the dsl builder

    • onMode

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onMode(String onMode)
      Handle mode change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onMode - the value to set
      Returns:
      the dsl builder

    • onNick

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onNick(boolean onNick)
      Handle nickname change events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onNick - the value to set
      Returns:
      the dsl builder

    • onNick

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onNick(String onNick)
      Handle nickname change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onNick - the value to set
      Returns:
      the dsl builder

    • onPart

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onPart(boolean onPart)
      Handle user part events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onPart - the value to set
      Returns:
      the dsl builder

    • onPart

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onPart(String onPart)
      Handle user part events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onPart - the value to set
      Returns:
      the dsl builder

    • onPrivmsg

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onPrivmsg(boolean onPrivmsg)
      Handle private message events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onPrivmsg - the value to set
      Returns:
      the dsl builder

    • onPrivmsg

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onPrivmsg(String onPrivmsg)
      Handle private message events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onPrivmsg - the value to set
      Returns:
      the dsl builder

    • onQuit

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onQuit(boolean onQuit)
      Handle user quit events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onQuit - the value to set
      Returns:
      the dsl builder

    • onQuit

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onQuit(String onQuit)
      Handle user quit events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onQuit - the value to set
      Returns:
      the dsl builder

    • onReply

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onReply(boolean onReply)
      Whether or not to handle general responses to commands or informational messages. The option is a: <code>boolean</code> type. Default: false Group: filter
      Parameters:
      onReply - the value to set
      Returns:
      the dsl builder

    • onReply

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onReply(String onReply)
      Whether or not to handle general responses to commands or informational messages. The option will be converted to a <code>boolean</code> type. Default: false Group: filter
      Parameters:
      onReply - the value to set
      Returns:
      the dsl builder

    • onTopic

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onTopic(boolean onTopic)
      Handle topic change events. The option is a: <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onTopic - the value to set
      Returns:
      the dsl builder

    • onTopic

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder onTopic(String onTopic)
      Handle topic change events. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
      Parameters:
      onTopic - the value to set
      Returns:
      the dsl builder

    • nickPassword

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder nickPassword(String nickPassword)
      Your IRC server nickname password. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      nickPassword - the value to set
      Returns:
      the dsl builder

    • password

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder password(String password)
      The IRC server password. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder sslContextParameters(String sslContextParameters)
      Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • trustManager

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder trustManager(org.schwering.irc.lib.ssl.SSLTrustManager trustManager)
      The trust manager used to verify the SSL server's certificate. The option is a: <code>org.schwering.irc.lib.ssl.SSLTrustManager</code> type. Group: security
      Parameters:
      trustManager - the value to set
      Returns:
      the dsl builder

    • trustManager

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder trustManager(String trustManager)
      The trust manager used to verify the SSL server's certificate. The option will be converted to a <code>org.schwering.irc.lib.ssl.SSLTrustManager</code> type. Group: security
      Parameters:
      trustManager - the value to set
      Returns:
      the dsl builder

    • username

      default IrcEndpointBuilderFactory.IrcEndpointProducerBuilder username(String username)
      The IRC server user name. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder