Package org.apache.camel.component.irc

Class IrcEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.irc.IrcEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="1.1.0",
             scheme="irc",
             title="IRC",
             syntax="irc:hostname:port",
             alternativeSyntax="irc:username:password@hostname:port",
             category=CHAT)
public class IrcEndpoint
extends org.apache.camel.support.DefaultEndpoint

Send and receive messages to/from and IRC chat.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILDED, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
IrcEndpoint(String endpointUri, IrcComponent component, IrcConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
IrcConsumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(org.apache.camel.ExchangePattern pattern)
org.apache.camel.Exchange	createOnJoinExchange(String channel, org.schwering.irc.lib.IRCUser user)
org.apache.camel.Exchange	createOnKickExchange(String channel, org.schwering.irc.lib.IRCUser user, String whoWasKickedNick, String msg)
org.apache.camel.Exchange	createOnModeExchange(String channel, org.schwering.irc.lib.IRCUser user, org.schwering.irc.lib.IRCModeParser modeParser)
org.apache.camel.Exchange	createOnNickExchange(org.schwering.irc.lib.IRCUser user, String newNick)
org.apache.camel.Exchange	createOnPartExchange(String channel, org.schwering.irc.lib.IRCUser user, String msg)
org.apache.camel.Exchange	createOnPrivmsgExchange(String target, org.schwering.irc.lib.IRCUser user, String msg)
org.apache.camel.Exchange	createOnQuitExchange(org.schwering.irc.lib.IRCUser user, String msg)
org.apache.camel.Exchange	createOnReplyExchange(int num, String value, String msg)
org.apache.camel.Exchange	createOnTopicExchange(String channel, org.schwering.irc.lib.IRCUser user, String topic)
IrcProducer	createProducer()
IrcBinding	getBinding()
IrcComponent	getComponent()
IrcConfiguration	getConfiguration()
void	handleIrcError(int num, String msg)
void	joinChannel(String name)
void	joinChannel(IrcChannel channel)
void	joinChannels()
void	setBinding(IrcBinding binding)
void	setComponent(IrcComponent component)
void	setConfiguration(IrcConfiguration configuration)

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Detail

IrcEndpoint

public IrcEndpoint(String endpointUri,
                   IrcComponent component,
                   IrcConfiguration configuration)

Method Detail

createExchange

public org.apache.camel.Exchange createExchange(org.apache.camel.ExchangePattern pattern)

Specified by:

createExchange in interface org.apache.camel.Endpoint

Overrides:

createExchange in class org.apache.camel.support.DefaultEndpoint

createOnPrivmsgExchange

public org.apache.camel.Exchange createOnPrivmsgExchange(String target,
                                                         org.schwering.irc.lib.IRCUser user,
                                                         String msg)

createOnNickExchange

public org.apache.camel.Exchange createOnNickExchange(org.schwering.irc.lib.IRCUser user,
                                                      String newNick)

createOnQuitExchange

public org.apache.camel.Exchange createOnQuitExchange(org.schwering.irc.lib.IRCUser user,
                                                      String msg)

createOnJoinExchange

public org.apache.camel.Exchange createOnJoinExchange(String channel,
                                                      org.schwering.irc.lib.IRCUser user)

createOnKickExchange

public org.apache.camel.Exchange createOnKickExchange(String channel,
                                                      org.schwering.irc.lib.IRCUser user,
                                                      String whoWasKickedNick,
                                                      String msg)

createOnModeExchange

public org.apache.camel.Exchange createOnModeExchange(String channel,
                                                      org.schwering.irc.lib.IRCUser user,
                                                      org.schwering.irc.lib.IRCModeParser modeParser)

createOnPartExchange

public org.apache.camel.Exchange createOnPartExchange(String channel,
                                                      org.schwering.irc.lib.IRCUser user,
                                                      String msg)

createOnReplyExchange

public org.apache.camel.Exchange createOnReplyExchange(int num,
                                                       String value,
                                                       String msg)

createOnTopicExchange

public org.apache.camel.Exchange createOnTopicExchange(String channel,
                                                       org.schwering.irc.lib.IRCUser user,
                                                       String topic)

createProducer

public IrcProducer createProducer()
                           throws Exception

Throws:

Exception

createConsumer

public IrcConsumer createConsumer(org.apache.camel.Processor processor)
                           throws Exception

Throws:

Exception

getComponent

public IrcComponent getComponent()

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

setComponent

public void setComponent(IrcComponent component)

getBinding

public IrcBinding getBinding()

setBinding

public void setBinding(IrcBinding binding)

getConfiguration

public IrcConfiguration getConfiguration()

setConfiguration

public void setConfiguration(IrcConfiguration configuration)

handleIrcError

public void handleIrcError(int num,
                           String msg)

joinChannels

public void joinChannels()

joinChannel

public void joinChannel(String name)

joinChannel

public void joinChannel(IrcChannel channel)