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

Interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    IrcEndpointBuilderFactory.IrcEndpointBuilder
    Enclosing interface:
    IrcEndpointBuilderFactory
    public static interface IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the IRC component.

    • Method Detail

      • autoRejoin

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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

      • commandTimeout

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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

      • namesOnJoin

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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

      • bridgeErrorHandler

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • onMode

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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

      • onNick

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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

      • onPrivmsg

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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

      • onReply

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder 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

      • sslContextParameters

        default IrcEndpointBuilderFactory.IrcEndpointConsumerBuilder sslContextParameters​(Object 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.IrcEndpointConsumerBuilder 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.IrcEndpointConsumerBuilder trustManager​(Object 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.IrcEndpointConsumerBuilder 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