Package org.apache.camel.component.irc

Class IrcConfiguration

    • Constructor Detail

      • IrcConfiguration

        public IrcConfiguration()

      • IrcConfiguration

        public IrcConfiguration​(String hostname,
                        String nickname,
                        String displayname,
                        String channels)

    • Method Detail

      • getCacheKey

        public String getCacheKey()

      • getSpaceSeparatedChannelNames

        public String getSpaceSeparatedChannelNames()

      • setTrustManager

        public void setTrustManager​(org.schwering.irc.lib.ssl.SSLTrustManager trustManager)
        The trust manager used to verify the SSL server's certificate.

      • getTrustManager

        public org.schwering.irc.lib.ssl.SSLTrustManager getTrustManager()

      • getUsingSSL

        public boolean getUsingSSL()

      • getHostname

        public String getHostname()

      • setHostname

        public void setHostname​(String hostname)
        Hostname for the IRC chat server

      • getPassword

        public String getPassword()

      • setPassword

        public void setPassword​(String password)
        The IRC server password.

      • getNickname

        public String getNickname()

      • setNickname

        public void setNickname​(String nickname)
        The nickname used in chat.

      • getRealname

        public String getRealname()

      • setRealname

        public void setRealname​(String realname)
        The IRC user's actual name.

      • getUsername

        public String getUsername()

      • getChannels

        public String getChannels()
        Comma separated list of IRC channels.

      • setChannels

        public void setChannels​(String channels)

      • getKeys

        public String getKeys()
        Comma separated list of keys for channels.

      • setKeys

        public void setKeys​(String keys)

      • setUsername

        public void setUsername​(String username)
        The IRC server user name.

      • getPorts

        public int[] getPorts()

      • setPorts

        public void setPorts​(int[] ports)
        Port numbers for the IRC chat server

      • getPort

        public int getPort()

      • setPort

        public void setPort​(int port)
        Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used.

      • isPersistent

        public boolean isPersistent()

      • setPersistent

        @Deprecated
public void setPersistent​(boolean persistent)
        Deprecated.
        not in use
        Use persistent messages.

      • isColors

        public boolean isColors()

      • setColors

        public void setColors​(boolean colors)
        Whether or not the server supports color codes.

      • isOnNick

        public boolean isOnNick()

      • setOnNick

        public void setOnNick​(boolean onNick)
        Handle nickname change events.

      • isOnQuit

        public boolean isOnQuit()

      • setOnQuit

        public void setOnQuit​(boolean onQuit)
        Handle user quit events.

      • isOnJoin

        public boolean isOnJoin()

      • setOnJoin

        public void setOnJoin​(boolean onJoin)
        Handle user join events.

      • isOnKick

        public boolean isOnKick()

      • setOnKick

        public void setOnKick​(boolean onKick)
        Handle kick events.

      • isOnMode

        public boolean isOnMode()

      • setOnMode

        public void setOnMode​(boolean onMode)
        Handle mode change events.

      • isOnPart

        public boolean isOnPart()

      • setOnPart

        public void setOnPart​(boolean onPart)
        Handle user part events.

      • isOnReply

        public boolean isOnReply()

      • setOnReply

        public void setOnReply​(boolean onReply)
        Whether or not to handle general responses to commands or informational messages.

      • isOnTopic

        public boolean isOnTopic()

      • setOnTopic

        public void setOnTopic​(boolean onTopic)
        Handle topic change events.

      • isOnPrivmsg

        public boolean isOnPrivmsg()

      • setOnPrivmsg

        public void setOnPrivmsg​(boolean onPrivmsg)
        Handle private message events.

      • isAutoRejoin

        public boolean isAutoRejoin()

      • setAutoRejoin

        public void setAutoRejoin​(boolean autoRejoin)
        Whether to auto re-join when being kicked

      • getSslContextParameters

        public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()

      • setSslContextParameters

        public void setSslContextParameters​(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.

      • getNickPassword

        public String getNickPassword()
        Your IRC server nickname password.

      • setNickPassword

        public void setNickPassword​(String nickPassword)

      • setCommandTimeout

        public void setCommandTimeout​(long timeout)
        Delay in milliseconds before sending commands after the connection is established.
        Parameters:
        timeout - timeout value in milliseconds

      • getCommandTimeout

        public long getCommandTimeout()

      • isNamesOnJoin

        public boolean isNamesOnJoin()

      • setNamesOnJoin

        public void setNamesOnJoin​(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'.