org.kitteh.irc.client.library

Interface Client.Builder.Server

Enclosing interface:

Client.Builder

public static interface Client.Builder.Server

Server builder methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Client.Builder.Server.SecurityType The security type, TLS or no.

Method Summary

Modifier and Type	Method and Description
@NonNull Client.Builder.Server	address(@NonNull HostWithPort hostWithPort) Sets the server host and port to which the client will connect.
@NonNull Client.Builder.Server	host(@NonNull String host) Sets the server host to which the client will connect.
@NonNull Client.Builder.Server	password(@Nullable String password) Sets the server password.
@NonNull Client.Builder.Server	port(int port) Deprecated. use port(int, SecurityType) instead
@NonNull Client.Builder.Server	port(int port, @NonNull Client.Builder.Server.SecurityType security) Sets the server port to which the client will connect and determines TLS setting.
@NonNull Client.Builder.Server	secure(boolean secure) Deprecated. use port(int, SecurityType) instead
@NonNull Client.Builder.Server	secureKey(@Nullable Path keyFile) Sets the private key for TLS connection.
@NonNull Client.Builder.Server	secureKeyCertChain(@Nullable Path keyCertChainFile) Sets the key for TLS connection.
@NonNull Client.Builder.Server	secureKeyPassword(@Nullable String password) Sets the private key password for TLS connection.
@NonNull Client.Builder.Server	secureTrustManagerFactory(@Nullable TrustManagerFactory factory) Sets the TrustManagerFactory for TLS connection.
@NonNull Client.Builder	then() Returns to the root builder.

Method Detail

address

@NonNull Client.Builder.Server address(@NonNull HostWithPort hostWithPort)

Sets the server host and port to which the client will connect.

By default, the host is localhost and port is 6697.

Parameters:

hostWithPort - IRC server host and port

Returns:

this builder

Throws:

IllegalArgumentException - for null parameter

host

@NonNull Client.Builder.Server host(@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

port

@Deprecated
@NonNull Client.Builder.Server port(int port)

Deprecated. use port(int, SecurityType) instead

Sets the server port to which the client will connect.

By default, the port is 6697.

Parameters:

port - IRC server port

Returns:

this builder

port

@NonNull Client.Builder.Server port(int port,
                                    @NonNull Client.Builder.Server.SecurityType security)

Sets the server port to which the client will connect and determines TLS setting. By default, the port is 6697 and the TLS setting is Client.Builder.Server.SecurityType.SECURE.

Parameters:

port - IRC server port

security - TLS security setting

Returns:

this builder

password

@NonNull Client.Builder.Server password(@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

@Deprecated
@NonNull Client.Builder.Server secure(boolean secure)

Deprecated. use port(int, SecurityType) instead

Sets whether the client connects via TLS.

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

Returns:

this builder

secureKeyCertChain

@NonNull Client.Builder.Server secureKeyCertChain(@Nullable Path keyCertChainFile)

Sets the key for TLS connection.

Parameters:

keyCertChainFile - X.509 certificate chain file in PEM format

Returns:

this builder

See Also:

secure(boolean)

secureKey

@NonNull Client.Builder.Server secureKey(@Nullable Path keyFile)

Sets the private key for TLS connection.

Parameters:

keyFile - PKCS#8 private key file in PEM format

Returns:

this builder

See Also:

secure(boolean)

secureKeyPassword

@NonNull Client.Builder.Server secureKeyPassword(@Nullable String password)

Sets the private key password for TLS connection.

Parameters:

password - password for private key

Returns:

this builder

See Also:

secure(boolean)

secureTrustManagerFactory

@NonNull Client.Builder.Server secureTrustManagerFactory(@Nullable TrustManagerFactory factory)

Sets the TrustManagerFactory for TLS connection.

Parameters:

factory - trust manager supplier

Returns:

this builder

See Also:

secure(boolean)

then

@NonNull Client.Builder then()

Returns to the root builder.

Returns:

the root builder