org.kitteh.irc.client.library

Interface Client.Builder

All Known Implementing Classes:

DefaultBuilder

Enclosing interface:

Client

public static interface Client.Builder

Builds Clients. Create a builder with Client.builder().

The default built client connects securely via port 6697. See secure(boolean) to disable, or the other secure-prefixed methods in this builder to fully utilize the feature. Note that the default TrustManagerFactory relies on your local trust store. The default Oracle trust store does not accept self-signed certificates.

Method Summary

Modifier and Type	Method and Description
Client.Builder	actorTracker(Function<Client.WithManagement,? extends ActorTracker> supplier) Sets the supplier of the actor tracker.
Client.Builder	authManager(Function<Client.WithManagement,? extends AuthManager> supplier) Sets the supplier of the authentication manager.
Client.Builder	bindHost(String host) Binds the client to a host or IP locally.
Client.Builder	bindPort(int port) Binds the client to the specified port.
Client	build() Clientmaker, clientmaker, make me a client!
Client	buildAndConnect() Clientmaker, clientmaker, make me a client, build me the client, begin connection!
Client.Builder	capabilityManager(Function<Client.WithManagement,? extends CapabilityManager.WithManagement> supplier) Sets the supplier of the capability manager.
Client.Builder	defaultMessageMap(DefaultMessageMap defaultMessageMap) Sets default messages.
Client.Builder	eventManager(Function<Client.WithManagement,? extends EventManager> supplier) Sets the supplier of the event manager.
Client.Builder	exceptionListener(Consumer<Exception> listener) Sets a listener for all thrown exceptions on this client.
Client.Builder	inputListener(Consumer<String> listener) Sets a listener for all incoming messages from the server.
Client.Builder	iSupportManager(Function<Client.WithManagement,? extends ISupportManager> supplier) Sets the supplier of the ISUPPORT manager.
Client.Builder	messageSendingQueueSupplier(Function<Client.WithManagement,? extends MessageSendingQueue> supplier) Sets the supplier of message sending queues, which dictate the rate at which messages are sent by the Client to the server.
Client.Builder	messageTagManager(Function<Client.WithManagement,? extends MessageTagManager> supplier) Sets the supplier of the message tag manager.
Client.Builder	name(String name) Names the client, for internal labeling.
Client.Builder	nick(String nick) Sets the client's nick.
Client.Builder	outputListener(Consumer<String> listener) Sets a listener for all outgoing messages to the server.
Client.Builder	realName(String name) Sets the realname the client uses.
Client.Builder	secure(boolean secure) Sets whether the client connects via TLS/SSL.
Client.Builder	secureKey(Path keyFile) Sets the private key for SSL connection.
Client.Builder	secureKeyCertChain(Path keyCertChainFile) Sets the key for SSL connection.
Client.Builder	secureKeyPassword(String password) Sets the private key password for SSL connection.
Client.Builder	secureTrustManagerFactory(TrustManagerFactory factory) Sets the TrustManagerFactory for SSL connection.
Client.Builder	serverHost(String host) Sets the server host to which the client will connect.
Client.Builder	serverInfo(Function<Client.WithManagement,? extends ServerInfo.WithManagement> supplier) Sets the supplier of the server info.
Client.Builder	serverPassword(String password) Sets the server password.
Client.Builder	serverPort(int port) Sets the server port to which the client will connect.
Client.Builder	stsStorageManager(StsStorageManager storageManager) Sets the storage manager for STS (strict transport security) support.
Client.Builder	user(String user) Sets the user the client connects as.
Client.Builder	webirc(String password, String user, String host, InetAddress ip) Sets all the information for, and enables, WebIRC.
Client.Builder	webircRemove() Removes WEBIRC settings from this builder.

Method Detail

actorTracker

@Nonnull
Client.Builder actorTracker(@Nonnull
                                      Function<Client.WithManagement,? extends ActorTracker> supplier)

Sets the supplier of the actor tracker.

By default, the DefaultActorTracker is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultActorTracker

authManager

@Nonnull
Client.Builder authManager(@Nonnull
                                     Function<Client.WithManagement,? extends AuthManager> supplier)

Sets the supplier of the authentication manager.

By default, the DefaultAuthManager is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultAuthManager

bindHost

@Nonnull
Client.Builder bindHost(@Nullable
                                  String host)

Binds the client to a host or IP locally.

By default, the host is not set which results in wildcard binding.

Parameters:

host - host to bind to, or null for wildcard binding

Returns:

this builder

bindPort

@Nonnull
Client.Builder bindPort(int port)

Binds the client to the specified port. Invalid ports are set to 0.

By default, the port is 0.

Parameters:

port - port to bind to

Returns:

this builder

capabilityManager

@Nonnull
Client.Builder capabilityManager(@Nonnull
                                           Function<Client.WithManagement,? extends CapabilityManager.WithManagement> supplier)

Sets the supplier of the capability manager.

By default, the DefaultCapabilityManager is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultCapabilityManager

defaultMessageMap

@Nonnull
Client.Builder defaultMessageMap(@Nonnull
                                           DefaultMessageMap defaultMessageMap)

Sets default messages.

Parameters:

defaultMessageMap - default values for messages

Returns:

this builder

See Also:

DefaultMessageMap

eventManager

@Nonnull
Client.Builder eventManager(@Nonnull
                                      Function<Client.WithManagement,? extends EventManager> supplier)

Sets the supplier of the event manager.

By default, the DefaultEventManager is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultEventManager

exceptionListener

@Nonnull
Client.Builder exceptionListener(@Nullable
                                           Consumer<Exception> listener)

Sets a listener for all thrown exceptions on this client. By default, a consumer exists which calls Throwable#printStackTrace() on all received exceptions.

All exceptions are passed from a single, separate thread.

Parameters:

listener - catcher of throwable objects or null to not listen

Returns:

this builder

inputListener

@Nonnull
Client.Builder inputListener(@Nullable
                                       Consumer<String> listener)

Sets a listener for all incoming messages from the server.

All messages are passed from a single, separate thread.

Parameters:

listener - input listener or null to not listen

Returns:

this builder

iSupportManager

@Nonnull
Client.Builder iSupportManager(@Nonnull
                                         Function<Client.WithManagement,? extends ISupportManager> supplier)

Sets the supplier of the ISUPPORT manager.

By default, the DefaultISupportManager is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultEventManager

messageSendingQueueSupplier

@Nonnull
Client.Builder messageSendingQueueSupplier(@Nonnull
                                                     Function<Client.WithManagement,? extends MessageSendingQueue> supplier)

Sets the supplier of message sending queues, which dictate the rate at which messages are sent by the Client to the server.

By default, the SingleDelaySender is used with a delay set to SingleDelaySender.DEFAULT_MESSAGE_DELAY.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

MessageSendingQueue

messageTagManager

@Nonnull
Client.Builder messageTagManager(@Nonnull
                                           Function<Client.WithManagement,? extends MessageTagManager> supplier)

Sets the supplier of the message tag manager.

By default, the DefaultMessageTagManager is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

MessageTagManager

name

@Nonnull
Client.Builder name(@Nonnull
                              String name)

Names the client, for internal labeling.

Parameters:

name - a name to label the client internally

Returns:

this builder

Throws:

IllegalArgumentException - if name is null

nick

@Nonnull
Client.Builder nick(@Nonnull
                              String nick)

Sets the client's nick.

By default, the nick is Kitteh.

Parameters:

nick - nick for the client to use

Returns:

this builder

Throws:

IllegalArgumentException - if nick is null

outputListener

@Nonnull
Client.Builder outputListener(@Nullable
                                        Consumer<String> listener)

Sets a listener for all outgoing messages to the server.

All messages are passed from a single, separate thread.

Parameters:

listener - output listener or null to not listen

Returns:

this builder

realName

@Nonnull
Client.Builder realName(@Nonnull
                                  String name)

Sets the realname the client uses.

By default, the realname is Kitteh.

Parameters:

name - realname to use

Returns:

this builder

Throws:

IllegalArgumentException - for null realname

serverPassword

@Nonnull
Client.Builder serverPassword(@Nullable
                                        String password)

Sets the server password.

If not set, no password is sent

Parameters:

password - server password or null to not send one

Returns:

this builder

secure

@Nonnull
Client.Builder secure(boolean secure)

Sets whether the client connects via TLS/SSL.

Note that by default the TrustManager used does not accept the certificates of many popular networks. You must use secureTrustManagerFactory(TrustManagerFactory) to set your own TrustManagerFactory.

Parameters:

secure - true for TLS/SSL

Returns:

this builder

secureKeyCertChain

@Nonnull
Client.Builder secureKeyCertChain(@Nullable
                                            Path keyCertChainFile)

Sets the key for SSL connection.

Parameters:

keyCertChainFile - X.509 certificate chain file in PEM format

Returns:

this builder

See Also:

secure(boolean)

secureKey

@Nonnull
Client.Builder secureKey(@Nullable
                                   Path keyFile)

Sets the private key for SSL connection.

Parameters:

keyFile - PKCS#8 private key file in PEM format

Returns:

this builder

See Also:

secure(boolean)

secureKeyPassword

@Nonnull
Client.Builder secureKeyPassword(@Nullable
                                           String password)

Sets the private key password for SSL connection.

Parameters:

password - password for private key

Returns:

this builder

See Also:

secure(boolean)

secureTrustManagerFactory

@Nonnull
Client.Builder secureTrustManagerFactory(@Nullable
                                                   TrustManagerFactory factory)

Sets the TrustManagerFactory for SSL connection.

Parameters:

factory - trust manager supplier

Returns:

this builder

See Also:

secure(boolean)

serverHost

@Nonnull
Client.Builder serverHost(@Nonnull
                                    String host)

Sets the server host to which the client will connect.

By default, the host is localhost.

Parameters:

host - IRC server host

Returns:

this builder

Throws:

IllegalArgumentException - for null host

serverPort

@Nonnull
Client.Builder serverPort(int port)

Sets the server port to which the client will connect.

By default, the port is 6667.

Parameters:

port - IRC server port

Returns:

this builder

serverInfo

@Nonnull
Client.Builder serverInfo(@Nonnull
                                    Function<Client.WithManagement,? extends ServerInfo.WithManagement> supplier)

Sets the supplier of the server info.

By default, the DefaultServerInfo is used.

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultServerInfo

user

@Nonnull
Client.Builder user(@Nonnull
                              String user)

Sets the user the client connects as.

By default, the user is Kitteh.

Parameters:

user - user to connect as

Returns:

this builder

Throws:

IllegalArgumentException - for null user

webirc

@Nonnull
Client.Builder webirc(@Nonnull
                                String password,
                                @Nonnull
                                String user,
                                @Nonnull
                                String host,
                                @Nonnull
                                InetAddress ip)

Sets all the information for, and enables, WebIRC.

By default, WebIRC is disabled.

Parameters:

password - password as defined in the IRCd config

user - username part of the client's address

host - hostname part of the client's address

ip - client's IP address

Returns:

this builder

Throws:

IllegalArgumentException - for any null parameters

See Also:

webircRemove()

webircRemove

@Nonnull
Client.Builder webircRemove()

Removes WEBIRC settings from this builder.

Returns:

this builder

See Also:

webirc(String, String, String, InetAddress)

stsStorageManager

@Nonnull
Client.Builder stsStorageManager(@Nullable
                                           StsStorageManager storageManager)

Sets the storage manager for STS (strict transport security) support.

By default, this is null and thus STS support is disabled. If you elect to enable STS, you are not permitted to use an insecure trust manager factory.

Parameters:

storageManager - storage system to persist STS information per host

Returns:

this builder

build

@Nonnull
Client build()

Clientmaker, clientmaker, make me a client!

Returns:

a client designed to your liking

buildAndConnect

@Nonnull
Client buildAndConnect()

Clientmaker, clientmaker, make me a client, build me the client, begin connection!

Returns:

a client designed to your liking