org.kitteh.irc.client.library

Interface Client.WithManagement

All Superinterfaces:

Client

All Known Implementing Classes:

DefaultClient

Enclosing interface:

Client

public static interface Client.WithManagement
extends Client

A Client with management features.

Nested Class Summary

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.Client

Client.Builder, Client.Commands, Client.WithManagement

Method Summary

Modifier and Type	Method and Description
void	beginMessageSendingImmediate(Consumer<String> consumer) Starts the sending of queued 'immediately' messages.
ActorTracker	getActorTracker() Gets the actor tracker.
InetSocketAddress	getBindAddress() Gets the bind address
CapabilityManager.WithManagement	getCapabilityManager() Gets the capability manager.
Listener<String>	getInputListener() Gets the currently set input listener.
Set<String>	getIntendedChannels() Gets the channels the client intends to join.
Listener<String>	getOutputListener() Gets the currently set output listener.
String	getRequestedNick() Gets the nickname the client has last requested.
Path	getSecureKey() Gets the TLS/SSL key.
Path	getSecureKeyCertChain() Gets the TLS/SSL key certificate chain.
String	getSecureKeyPassword() Gets the TLS/SSL key password.
TrustManagerFactory	getSecureTrustManagerFactory() Gets the trust manager factory.
InetSocketAddress	getServerAddress() Gets the server address
ServerInfo.WithManagement	getServerInfo() Gets information about the server to which the client is currently connected.
void	initialize(String name, InetSocketAddress serverAddress, String serverPassword, InetSocketAddress bindAddress, String nick, String userString, String realName, ActorTracker actorTracker, AuthManager authManager, CapabilityManager.WithManagement capabilityManager, EventManager eventManager, MessageTagManager messageTagManager, ISupportManager iSupportManager, DefaultMessageMap defaultMessageMap, Function<Client.WithManagement,? extends MessageSendingQueue> messageSendingQueue, Function<Client.WithManagement,? extends ServerInfo.WithManagement> serverInfo, Consumer<Exception> exceptionListener, Consumer<String> inputListener, Consumer<String> outputListener, boolean secure, Path secureKeyCertChain, Path secureKey, String secureKeyPassword, TrustManagerFactory trustManagerFactory, StsStorageManager stsStorageManager, String webircHost, InetAddress webircIP, String webircPassword, String webircUser) Initialize with pre-connection information.
boolean	isSecureConnection() Gets if the client is configured for a secure connection.
void	pauseMessageSending() Pauses message sending, waiting for next successful connection.
void	ping() Sends a PING.
void	processLine(String line) Processes a line from the IRC server.
void	sendNickChange(String newNick) Sends a nick change request.
void	setCurrentNick(String nick) Sets the current nickname the client knows it has.
void	setServerAddress(InetSocketAddress address) Sets the server address.
void	setUserModes(ModeStatusList<UserMode> userModes) Sets the client's user modes.
void	startSending() Starts sending queued messages.
void	updateUserModes(ModeStatusList<UserMode> userModes) Updates the client's user modes.

Methods inherited from interface org.kitteh.irc.client.library.Client

addChannel, addKeyProtectedChannel, addKeyProtectedChannel, builder, commands, connect, getAuthManager, getChannel, getChannels, getChannels, getDefaultMessageMap, getEventManager, getExceptionListener, getIntendedNick, getISupportManager, getMessageCutter, getMessageSendingQueueSupplier, getMessageTagManager, getName, getNick, getStsMachine, getUser, getUserModes, isUser, knockChannel, reconnect, reconnect, removeChannel, removeChannel, sendCtcpMessage, sendCtcpMessage, sendCtcpReply, sendCtcpReply, sendMessage, sendMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineMessage, sendMultiLineNotice, sendMultiLineNotice, sendMultiLineNotice, sendMultiLineNotice, sendNotice, sendNotice, sendRawLine, sendRawLineAvoidingDuplication, sendRawLineImmediately, setDefaultMessageMap, setExceptionListener, setInputListener, setMessageCutter, setMessageSendingQueueSupplier, setNick, setOutputListener, shutdown, shutdown

Method Detail

beginMessageSendingImmediate

void beginMessageSendingImmediate(@Nonnull
                                  Consumer<String> consumer)

Starts the sending of queued 'immediately' messages.

Parameters:

consumer - consumer with which to handle this queue

getActorTracker

@Nonnull
ActorTracker getActorTracker()

Gets the actor tracker.

Returns:

actor tracker

getBindAddress

@Nonnull
InetSocketAddress getBindAddress()

Gets the bind address

Returns:

bind address

getCapabilityManager

@Nonnull
CapabilityManager.WithManagement getCapabilityManager()

Description copied from interface: Client

Gets the capability manager.

Specified by:

getCapabilityManager in interface Client

Returns:

the capability manager

getInputListener

@Nonnull
Listener<String> getInputListener()

Gets the currently set input listener.

Returns:

input listener

getIntendedChannels

@Nonnull
Set<String> getIntendedChannels()

Gets the channels the client intends to join.

Returns:

intended channels

getOutputListener

@Nonnull
Listener<String> getOutputListener()

Gets the currently set output listener.

Returns:

output listener

getRequestedNick

@Nonnull
String getRequestedNick()

Gets the nickname the client has last requested.

Returns:

requested nick

getSecureKey

@Nullable
Path getSecureKey()

Gets the TLS/SSL key.

Returns:

key

getSecureKeyCertChain

@Nullable
Path getSecureKeyCertChain()

Gets the TLS/SSL key certificate chain.

Returns:

key cert chain

getSecureKeyPassword

@Nullable
String getSecureKeyPassword()

Gets the TLS/SSL key password.

Returns:

password

getSecureTrustManagerFactory

@Nullable
TrustManagerFactory getSecureTrustManagerFactory()

Gets the trust manager factory.

Returns:

trust manager factory

getServerAddress

@Nonnull
InetSocketAddress getServerAddress()

Gets the server address

Returns:

server address

getServerInfo

@Nonnull
ServerInfo.WithManagement getServerInfo()

Description copied from interface: Client

Gets information about the server to which the client is currently connected. As long as the client remains connected the information returned by this object will update according to information received from the server. A new one can be acquired from ClientNegotiationCompleteEvent

Specified by:

getServerInfo in interface Client

Returns:

the server information object

pauseMessageSending

void pauseMessageSending()

Pauses message sending, waiting for next successful connection.

ping

void ping()

Sends a PING.

processLine

void processLine(@Nonnull
                 String line)

Processes a line from the IRC server.

Parameters:

line - line to process

sendNickChange

void sendNickChange(@Nonnull
                    String newNick)

Sends a nick change request.

Parameters:

newNick - new nickname

setCurrentNick

void setCurrentNick(@Nonnull
                    String nick)

Sets the current nickname the client knows it has.

Parameters:

nick - nickname

setServerAddress

void setServerAddress(@Nonnull
                      InetSocketAddress address)

Sets the server address.

Parameters:

address - server address

initialize

void initialize(@Nonnull
                String name,
                @Nonnull
                InetSocketAddress serverAddress,
                @Nullable
                String serverPassword,
                @Nullable
                InetSocketAddress bindAddress,
                @Nonnull
                String nick,
                @Nonnull
                String userString,
                @Nonnull
                String realName,
                @Nonnull
                ActorTracker actorTracker,
                @Nonnull
                AuthManager authManager,
                @Nonnull
                CapabilityManager.WithManagement capabilityManager,
                @Nonnull
                EventManager eventManager,
                @Nonnull
                MessageTagManager messageTagManager,
                @Nonnull
                ISupportManager iSupportManager,
                @Nullable
                DefaultMessageMap defaultMessageMap,
                @Nonnull
                Function<Client.WithManagement,? extends MessageSendingQueue> messageSendingQueue,
                @Nonnull
                Function<Client.WithManagement,? extends ServerInfo.WithManagement> serverInfo,
                @Nullable
                Consumer<Exception> exceptionListener,
                @Nullable
                Consumer<String> inputListener,
                @Nullable
                Consumer<String> outputListener,
                boolean secure,
                @Nullable
                Path secureKeyCertChain,
                @Nullable
                Path secureKey,
                @Nullable
                String secureKeyPassword,
                @Nullable
                TrustManagerFactory trustManagerFactory,
                @Nullable
                StsStorageManager stsStorageManager,
                @Nullable
                String webircHost,
                @Nullable
                InetAddress webircIP,
                @Nullable
                String webircPassword,
                @Nullable
                String webircUser)

Initialize with pre-connection information.

Parameters:

name - name

serverAddress - serverAddress

serverPassword - serverPassword

bindAddress - bindAddress

nick - nick

userString - userString

realName - realName

actorTracker - actorTracker

authManager - authManager

capabilityManager - capabilityManager

eventManager - eventManager

messageTagManager - messageTagManager

iSupportManager - iSupportManager

defaultMessageMap - defaultMessageMap

messageSendingQueue - messageSendingQueue

serverInfo - serverInfo

exceptionListener - exceptionListener

inputListener - inputListener

outputListener - outputListener

secure - secure

secureKeyCertChain - secureKeyCertChain

secureKey - secureKey

secureKeyPassword - secureKeyPassword

trustManagerFactory - trustManagerFactory

stsStorageManager - stsStorageManager

webircHost - webircHost

webircIP - webircIP

webircPassword - webircPassword

webircUser - webircUser

setUserModes

void setUserModes(@Nonnull
                  ModeStatusList<UserMode> userModes)

Sets the client's user modes.

Parameters:

userModes - user modes to set

startSending

void startSending()

Starts sending queued messages.

updateUserModes

void updateUserModes(@Nonnull
                     ModeStatusList<UserMode> userModes)

Updates the client's user modes.

Parameters:

userModes - mode changes

isSecureConnection

boolean isSecureConnection()

Gets if the client is configured for a secure connection.

Returns:

true if configured for secure