org.kitteh.irc.client.library

Interface Client.WithManagement

All Superinterfaces:

Client, ClientLinked

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(@NonNull Consumer<String> consumer) Starts the sending of queued 'immediately' messages.
@NonNull ActorTracker	getActorTracker() Gets the actor tracker.
@NonNull InetSocketAddress	getBindAddress() Gets the bind address
CapabilityManager.WithManagement	getCapabilityManager() Gets the capability manager.
@NonNull Listener<String>	getInputListener() Gets the currently set input listener.
@NonNull Set<String>	getIntendedChannels() Gets the channels the client intends to join.
@NonNull NetworkHandler	getNetworkHandler() Gets the network handler.
@NonNull Listener<String>	getOutputListener() Gets the currently set output listener.
@NonNull Optional<HostWithPort>	getProxyAddress() Gets the proxy address
@NonNull Optional<ProxyType>	getProxyType() Gets if the client is configured to use a proxy.
@NonNull String	getRequestedNick() Gets the nickname the client has last requested.
@Nullable Path	getSecureKey() Gets the TLS key.
@Nullable Path	getSecureKeyCertChain() Gets the TLS key certificate chain.
@Nullable String	getSecureKeyPassword() Gets the TLS key password.
@Nullable TrustManagerFactory	getSecureTrustManagerFactory() Gets the trust manager factory.
@NonNull HostWithPort	getServerAddress() Gets the server address
ServerInfo.WithManagement	getServerInfo() Gets information about the server to which the client is currently connected.
void	initialize(@NonNull String name, @NonNull NetworkHandler networkHandler, @NonNull HostWithPort serverHostWithPort, @Nullable String serverPassword, @Nullable InetSocketAddress bindAddress, @Nullable HostWithPort proxyAddress, @Nullable ProxyType proxyType, @NonNull String nick, @NonNull String userString, @NonNull String realName, @NonNull ActorTracker actorTracker, @NonNull AuthManager authManager, CapabilityManager.WithManagement capabilityManager, @NonNull EventManager eventManager, @NonNull List<EventListenerSupplier> listenerSuppliers, @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.
boolean	isConnectionAlive() Gets if the connection is alive.
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(@NonNull String line) Processes a line from the IRC server.
void	sendNickChange(@NonNull String newNick) Sends a nick change request.
void	setCurrentNick(@NonNull String nick) Sets the current nickname the client knows it has.
void	setNetworkHandler(@NonNull NetworkHandler networkHandler) Sets the network handler, for the next time a connection is made.
void	setServerAddress(@NonNull HostWithPort address) Sets the server address.
void	setUserModes(@NonNull ModeStatusList<UserMode> userModes) Sets the client's user modes.
void	startSending() Starts sending queued messages.
void	updateUserModes(@NonNull 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, getClient, 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

isConnectionAlive

boolean isConnectionAlive()

Gets if the connection is alive.

Returns:

true if connection is alive

getBindAddress

@NonNull InetSocketAddress getBindAddress()

Gets the bind address

Returns:

bind address

getCapabilityManager

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

getNetworkHandler

@NonNull NetworkHandler getNetworkHandler()

Gets the network handler.

Returns:

network handler

getOutputListener

@NonNull Listener<String> getOutputListener()

Gets the currently set output listener.

Returns:

output listener

getProxyType

@NonNull Optional<ProxyType> getProxyType()

Gets if the client is configured to use a proxy.

Returns:

true if configured for proxy

getProxyAddress

@NonNull Optional<HostWithPort> getProxyAddress()

Gets the proxy address

Returns:

proxy address

getRequestedNick

@NonNull String getRequestedNick()

Gets the nickname the client has last requested.

Returns:

requested nick

getSecureKey

@Nullable Path getSecureKey()

Gets the TLS key.

Returns:

key

getSecureKeyCertChain

@Nullable Path getSecureKeyCertChain()

Gets the TLS key certificate chain.

Returns:

key cert chain

getSecureKeyPassword

@Nullable String getSecureKeyPassword()

Gets the TLS key password.

Returns:

password

getSecureTrustManagerFactory

@Nullable TrustManagerFactory getSecureTrustManagerFactory()

Gets the trust manager factory.

Returns:

trust manager factory

getServerAddress

@NonNull HostWithPort getServerAddress()

Gets the server address

Returns:

server address

getServerInfo

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

setNetworkHandler

void setNetworkHandler(@NonNull NetworkHandler networkHandler)

Sets the network handler, for the next time a connection is made.

Parameters:

networkHandler - new network handler

setServerAddress

void setServerAddress(@NonNull HostWithPort address)

Sets the server address.

Parameters:

address - server address

initialize

void initialize(@NonNull String name,
                @NonNull NetworkHandler networkHandler,
                @NonNull HostWithPort serverHostWithPort,
                @Nullable String serverPassword,
                @Nullable InetSocketAddress bindAddress,
                @Nullable HostWithPort proxyAddress,
                @Nullable ProxyType proxyType,
                @NonNull String nick,
                @NonNull String userString,
                @NonNull String realName,
                @NonNull ActorTracker actorTracker,
                @NonNull AuthManager authManager,
                CapabilityManager.WithManagement capabilityManager,
                @NonNull EventManager eventManager,
                @NonNull List<EventListenerSupplier> listenerSuppliers,
                @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

networkHandler - networkHandler

serverHostWithPort - serverHostWithPort

serverPassword - serverPassword

bindAddress - bindAddress

proxyAddress - proxyAddress

proxyType - proxyType

nick - nick

userString - userString

realName - realName

actorTracker - actorTracker

authManager - authManager

capabilityManager - capabilityManager

eventManager - eventManager

listenerSuppliers - listenerSuppliers

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