org.kitteh.irc.client.library.defaults

Class DefaultBuilder

java.lang.Object

org.kitteh.irc.client.library.defaults.DefaultBuilder

All Implemented Interfaces:

Client.Builder

public class DefaultBuilder
extends Object
implements Client.Builder

Default Client.Builder.

Constructor Summary

Constructors

Constructor and Description
DefaultBuilder()

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.
DefaultBuilder	bindHost(String host) Binds the client to a host or IP locally.
DefaultBuilder	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!
DefaultBuilder	capabilityManager(Function<Client.WithManagement,? extends CapabilityManager.WithManagement> supplier) Sets the supplier of the capability manager.
DefaultBuilder	defaultMessageMap(DefaultMessageMap defaultMessageMap) Sets default messages.
Client.Builder	eventManager(Function<Client.WithManagement,? extends EventManager> supplier) Sets the supplier of the event manager.
DefaultBuilder	exceptionListener(Consumer<Exception> listener) Sets a listener for all thrown exceptions on this client.
DefaultBuilder	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.
DefaultBuilder	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.
DefaultBuilder	messageTagManager(Function<Client.WithManagement,? extends MessageTagManager> supplier) Sets the supplier of the message tag manager.
DefaultBuilder	name(String name) Names the client, for internal labeling.
DefaultBuilder	nick(String nick) Sets the client's nick.
DefaultBuilder	outputListener(Consumer<String> listener) Sets a listener for all outgoing messages to the server.
DefaultBuilder	realName(String name) Sets the realname the client uses.
DefaultBuilder	secure(boolean secure) Sets whether the client connects via TLS/SSL.
DefaultBuilder	secureKey(Path keyFile) Sets the private key for SSL connection.
DefaultBuilder	secureKeyCertChain(Path keyCertChainFile) Sets the key for SSL connection.
DefaultBuilder	secureKeyPassword(String password) Sets the private key password for SSL connection.
DefaultBuilder	secureTrustManagerFactory(TrustManagerFactory factory) Sets the TrustManagerFactory for SSL connection.
DefaultBuilder	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.
DefaultBuilder	serverPassword(String password) Sets the server password.
DefaultBuilder	serverPort(int port) Sets the server port to which the client will connect.
DefaultBuilder	stsStorageManager(StsStorageManager storageManager) Sets the storage manager for STS (strict transport security) support.
String	toString()
DefaultBuilder	user(String user) Sets the user the client connects as.
DefaultBuilder	webirc(String password, String user, String host, InetAddress ip) Sets all the information for, and enables, WebIRC.
DefaultBuilder	webircRemove() Removes WEBIRC settings from this builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultBuilder

public DefaultBuilder()

Method Detail

actorTracker

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

Description copied from interface: Client.Builder

Sets the supplier of the actor tracker.

By default, the DefaultActorTracker is used.

Specified by:

actorTracker in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultActorTracker

bindHost

@Nonnull
public DefaultBuilder bindHost(@Nullable
                                         String host)

Description copied from interface: Client.Builder

Binds the client to a host or IP locally.

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

Specified by:

bindHost in interface Client.Builder

Parameters:

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

Returns:

this builder

bindPort

@Nonnull
public DefaultBuilder bindPort(int port)

Description copied from interface: Client.Builder

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

By default, the port is 0.

Specified by:

bindPort in interface Client.Builder

Parameters:

port - port to bind to

Returns:

this builder

defaultMessageMap

@Nonnull
public DefaultBuilder defaultMessageMap(@Nonnull
                                                  DefaultMessageMap defaultMessageMap)

Description copied from interface: Client.Builder

Sets default messages.

Specified by:

defaultMessageMap in interface Client.Builder

Parameters:

defaultMessageMap - default values for messages

Returns:

this builder

See Also:

DefaultMessageMap

exceptionListener

@Nonnull
public DefaultBuilder exceptionListener(@Nullable
                                                  Consumer<Exception> listener)

Description copied from interface: Client.Builder

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.

Specified by:

exceptionListener in interface Client.Builder

Parameters:

listener - catcher of throwable objects or null to not listen

Returns:

this builder

inputListener

@Nonnull
public DefaultBuilder inputListener(@Nullable
                                              Consumer<String> listener)

Description copied from interface: Client.Builder

Sets a listener for all incoming messages from the server.

All messages are passed from a single, separate thread.

Specified by:

inputListener in interface Client.Builder

Parameters:

listener - input listener or null to not listen

Returns:

this builder

outputListener

@Nonnull
public DefaultBuilder outputListener(@Nullable
                                               Consumer<String> listener)

Description copied from interface: Client.Builder

Sets a listener for all outgoing messages to the server.

All messages are passed from a single, separate thread.

Specified by:

outputListener in interface Client.Builder

Parameters:

listener - output listener or null to not listen

Returns:

this builder

messageSendingQueueSupplier

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

Description copied from interface: Client.Builder

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.

Specified by:

messageSendingQueueSupplier in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

MessageSendingQueue

messageTagManager

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

Description copied from interface: Client.Builder

Sets the supplier of the message tag manager.

By default, the DefaultMessageTagManager is used.

Specified by:

messageTagManager in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

MessageTagManager

name

@Nonnull
public DefaultBuilder name(@Nonnull
                                     String name)

Description copied from interface: Client.Builder

Names the client, for internal labeling.

Specified by:

name in interface Client.Builder

Parameters:

name - a name to label the client internally

Returns:

this builder

nick

@Nonnull
public DefaultBuilder nick(@Nonnull
                                     String nick)

Description copied from interface: Client.Builder

Sets the client's nick.

By default, the nick is Kitteh.

Specified by:

nick in interface Client.Builder

Parameters:

nick - nick for the client to use

Returns:

this builder

serverPassword

@Nonnull
public DefaultBuilder serverPassword(@Nullable
                                               String password)

Description copied from interface: Client.Builder

Sets the server password.

If not set, no password is sent

Specified by:

serverPassword in interface Client.Builder

Parameters:

password - server password or null to not send one

Returns:

this builder

realName

@Nonnull
public DefaultBuilder realName(@Nonnull
                                         String name)

Description copied from interface: Client.Builder

Sets the realname the client uses.

By default, the realname is Kitteh.

Specified by:

realName in interface Client.Builder

Parameters:

name - realname to use

Returns:

this builder

secure

@Nonnull
public DefaultBuilder secure(boolean secure)

Description copied from interface: Client.Builder

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 Client.Builder.secureTrustManagerFactory(TrustManagerFactory) to set your own TrustManagerFactory.

Specified by:

secure in interface Client.Builder

Parameters:

secure - true for TLS/SSL

Returns:

this builder

secureKeyCertChain

@Nonnull
public DefaultBuilder secureKeyCertChain(@Nullable
                                                   Path keyCertChainFile)

Description copied from interface: Client.Builder

Sets the key for SSL connection.

Specified by:

secureKeyCertChain in interface Client.Builder

Parameters:

keyCertChainFile - X.509 certificate chain file in PEM format

Returns:

this builder

See Also:

Client.Builder.secure(boolean)

secureKey

@Nonnull
public DefaultBuilder secureKey(@Nullable
                                          Path keyFile)

Description copied from interface: Client.Builder

Sets the private key for SSL connection.

Specified by:

secureKey in interface Client.Builder

Parameters:

keyFile - PKCS#8 private key file in PEM format

Returns:

this builder

See Also:

Client.Builder.secure(boolean)

secureKeyPassword

@Nonnull
public DefaultBuilder secureKeyPassword(@Nullable
                                                  String password)

Description copied from interface: Client.Builder

Sets the private key password for SSL connection.

Specified by:

secureKeyPassword in interface Client.Builder

Parameters:

password - password for private key

Returns:

this builder

See Also:

Client.Builder.secure(boolean)

secureTrustManagerFactory

@Nonnull
public DefaultBuilder secureTrustManagerFactory(@Nullable
                                                          TrustManagerFactory factory)

Description copied from interface: Client.Builder

Sets the TrustManagerFactory for SSL connection.

Specified by:

secureTrustManagerFactory in interface Client.Builder

Parameters:

factory - trust manager supplier

Returns:

this builder

See Also:

Client.Builder.secure(boolean)

serverHost

@Nonnull
public DefaultBuilder serverHost(@Nonnull
                                           String host)

Description copied from interface: Client.Builder

Sets the server host to which the client will connect.

By default, the host is localhost.

Specified by:

serverHost in interface Client.Builder

Parameters:

host - IRC server host

Returns:

this builder

serverPort

@Nonnull
public DefaultBuilder serverPort(int port)

Description copied from interface: Client.Builder

Sets the server port to which the client will connect.

By default, the port is 6667.

Specified by:

serverPort in interface Client.Builder

Parameters:

port - IRC server port

Returns:

this builder

authManager

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

Description copied from interface: Client.Builder

Sets the supplier of the authentication manager.

By default, the DefaultAuthManager is used.

Specified by:

authManager in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultAuthManager

capabilityManager

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

Description copied from interface: Client.Builder

Sets the supplier of the capability manager.

By default, the DefaultCapabilityManager is used.

Specified by:

capabilityManager in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultCapabilityManager

eventManager

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

Description copied from interface: Client.Builder

Sets the supplier of the event manager.

By default, the DefaultEventManager is used.

Specified by:

eventManager in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultEventManager

iSupportManager

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

Description copied from interface: Client.Builder

Sets the supplier of the ISUPPORT manager.

By default, the DefaultISupportManager is used.

Specified by:

iSupportManager in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultEventManager

serverInfo

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

Description copied from interface: Client.Builder

Sets the supplier of the server info.

By default, the DefaultServerInfo is used.

Specified by:

serverInfo in interface Client.Builder

Parameters:

supplier - supplier

Returns:

this builder

See Also:

DefaultServerInfo

user

@Nonnull
public DefaultBuilder user(@Nonnull
                                     String user)

Description copied from interface: Client.Builder

Sets the user the client connects as.

By default, the user is Kitteh.

Specified by:

user in interface Client.Builder

Parameters:

user - user to connect as

Returns:

this builder

webirc

@Nonnull
public DefaultBuilder webirc(@Nonnull
                                       String password,
                                       @Nonnull
                                       String user,
                                       @Nonnull
                                       String host,
                                       @Nonnull
                                       InetAddress ip)

Description copied from interface: Client.Builder

Sets all the information for, and enables, WebIRC.

By default, WebIRC is disabled.

Specified by:

webirc in interface Client.Builder

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

See Also:

Client.Builder.webircRemove()

webircRemove

@Nonnull
public DefaultBuilder webircRemove()

Description copied from interface: Client.Builder

Removes WEBIRC settings from this builder.

Specified by:

webircRemove in interface Client.Builder

Returns:

this builder

See Also:

Client.Builder.webirc(String, String, String, InetAddress)

stsStorageManager

@Nonnull
public DefaultBuilder stsStorageManager(@Nullable
                                                  StsStorageManager storageManager)

Description copied from interface: Client.Builder

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.

Specified by:

stsStorageManager in interface Client.Builder

Parameters:

storageManager - storage system to persist STS information per host

Returns:

this builder

build

@Nonnull
public Client build()

Description copied from interface: Client.Builder

Clientmaker, clientmaker, make me a client!

Specified by:

build in interface Client.Builder

Returns:

a client designed to your liking

buildAndConnect

@Nonnull
public Client buildAndConnect()

Description copied from interface: Client.Builder

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

Specified by:

buildAndConnect in interface Client.Builder

Returns:

a client designed to your liking

toString

@Nonnull
public String toString()

Overrides:

toString in class Object