team.unnamed.creative.server

Interface ResourcePackServer.Builder

Enclosing interface:

ResourcePackServer

public static interface ResourcePackServer.Builder

A builder for ResourcePackServer instances

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default @NotNull ResourcePackServer.Builder	address(@NotNull java.net.InetAddress address, int port) Sets the server's bound address, required.
@NotNull ResourcePackServer.Builder	address(@NotNull java.net.InetSocketAddress address) Sets the server's bound address, required.
default @NotNull ResourcePackServer.Builder	address(int port) Sets the server's bound address, required.
default @NotNull ResourcePackServer.Builder	address(@NotNull java.lang.String hostname, int port) Sets the server's bound address, required.
@NotNull ResourcePackServer.Builder	backlog(int backlog) Sets the socket backlog, specifies the number of pending connections the connection queue will hold
@NotNull ResourcePackServer	build() Builds the ResourcePackServer instance.
@NotNull ResourcePackServer.Builder	executor(@Nullable java.util.concurrent.Executor executor) Sets the server's executor, optional.
@NotNull ResourcePackServer.Builder	handler(@NotNull ResourcePackRequestHandler handler) Sets the server's request handler, required, may also be set by using pack(team.unnamed.creative.BuiltResourcePack, boolean).
default @NotNull ResourcePackServer.Builder	handler(ResourcePackRequestHandler handler) Deprecated. Use handler(ResourcePackRequestHandler) instead
default @NotNull ResourcePackServer.Builder	pack(@NotNull team.unnamed.creative.BuiltResourcePack pack) Sets a request handler that will always return the given pack.
default @NotNull ResourcePackServer.Builder	pack(@NotNull team.unnamed.creative.BuiltResourcePack pack, boolean validOnly) Sets a request handler that will always return the given pack.
@NotNull ResourcePackServer.Builder	path(@NotNull java.lang.String path) Sets the base path for the set handler, optional, defaults to "/".
@NotNull ResourcePackServer.Builder	secure(@NotNull com.sun.net.httpserver.HttpsConfigurator httpsConfigurator) Sets the server's HTTPS configurator, optional.
default @NotNull ResourcePackServer.Builder	secure(@NotNull javax.net.ssl.SSLContext sslContext) Sets the server's HTTPS SSL context, optional.
default @NotNull ResourcePackServer.Builder	secure(@NotNull javax.net.ssl.SSLContext sslContext, @NotNull java.util.function.Consumer<com.sun.net.httpserver.HttpsParameters> configurator) Sets the server's HTTPS configurator, optional.

Method Detail

address

@Contract(value="_ -> this")
 @NotNull
@NotNull ResourcePackServer.Builder address(@NotNull
                                                                                     @NotNull java.net.InetSocketAddress address)

Sets the server's bound address, required.

Parameters:

address - The server's bound address

Returns:

This builder

Since:

1.0.0

address

@Contract(value="_, _ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder address(@NotNull
                                                                                                @NotNull java.lang.String hostname,
                                                                                                int port)

Sets the server's bound address, required.

Parameters:

hostname - The server's bound hostname

port - The server's bound port

Returns:

This builder

Since:

1.0.0

address

@Contract(value="_, _ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder address(@NotNull
                                                                                                @NotNull java.net.InetAddress address,
                                                                                                int port)

Sets the server's bound address, required.

Parameters:

address - The server's bound address

port - The server's bound port

Returns:

This builder

Since:

1.0.0

address

@Contract(value="_ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder address(int port)

Sets the server's bound address, required.

Parameters:

port - The server's bound port

Returns:

This builder

Since:

1.0.0

executor

@Contract(value="_ -> this")
 @NotNull
@NotNull ResourcePackServer.Builder executor(@Nullable
                                                                                      @Nullable java.util.concurrent.Executor executor)

Sets the server's executor, optional.

All requests are handled in tasks given to the executor. if the executor is not specified or if it's set to null, then a default implementation is used, which uses the thread which was created by the ResourcePackServer.start() method.

Parameters:

executor - The server's executor

Returns:

This builder

Since:

1.5.0

secure

@Contract(value="_ -> this")
 @NotNull
@NotNull ResourcePackServer.Builder secure(@NotNull
                                                                                    @NotNull com.sun.net.httpserver.HttpsConfigurator httpsConfigurator)

Sets the server's HTTPS configurator, optional. If not set, the server will default to a HTTP implementation.

Parameters:

httpsConfigurator - The server's HTTPS configurator

Returns:

This builder

Since:

1.0.0

secure

@Contract(value="_, _ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder secure(@NotNull
                                                                                               @NotNull javax.net.ssl.SSLContext sslContext,
                                                                                               @NotNull
                                                                                               @NotNull java.util.function.Consumer<com.sun.net.httpserver.HttpsParameters> configurator)

Sets the server's HTTPS configurator, optional. If not set, the server will default to a HTTP implementation.

Parameters:

sslContext - The server's SSL context

configurator - The server's HTTPS configurator

Returns:

This builder

Since:

1.0.0

secure

@Contract(value="_ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder secure(@NotNull
                                                                                            @NotNull javax.net.ssl.SSLContext sslContext)

Sets the server's HTTPS SSL context, optional. If not set, the server will default to a HTTP implementation.

Parameters:

sslContext - The server's SSL context

Returns:

This builder

Since:

1.0.0

backlog

@Contract(value="_ -> this")
 @NotNull
@NotNull ResourcePackServer.Builder backlog(int backlog)

Sets the socket backlog, specifies the number of pending connections the connection queue will hold

If the given value is less than or equal to zero, then a system default value is used

Parameters:

backlog - The socket backlog

Returns:

This builder, for chaining

Since:

1.0.0

handler

@NotNull
@NotNull ResourcePackServer.Builder handler(@NotNull
                                                      @NotNull ResourcePackRequestHandler handler)

Sets the server's request handler, required, may also be set by using pack(team.unnamed.creative.BuiltResourcePack, boolean).

Parameters:

handler - The server's request handler

Returns:

This builder

Since:

1.2.0

handler

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder handler(@NotNull
                                                                                                                                                               ResourcePackRequestHandler handler)

Deprecated. Use handler(ResourcePackRequestHandler) instead

Sets the server's request handler, required, may also be set by using pack(team.unnamed.creative.BuiltResourcePack, boolean).

Parameters:

handler - The server's request handler

Returns:

This builder

Since:

1.0.0

pack

@Contract(value="_, _ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder pack(@NotNull
                                                                                             @NotNull team.unnamed.creative.BuiltResourcePack pack,
                                                                                             boolean validOnly)

Sets a request handler that will always return the given pack.

Parameters:

pack - The served resource pack

validOnly - Whether to only serve the pack if the request was made from a Minecraft client

Returns:

This builder

Since:

1.0.0

pack

@Contract(value="_ -> this")
 @NotNull
default @NotNull ResourcePackServer.Builder pack(@NotNull
                                                                                          @NotNull team.unnamed.creative.BuiltResourcePack pack)

Sets a request handler that will always return the given pack.

Parameters:

pack - The served resource pack

Returns:

This builder

Since:

1.0.0

path

@Contract(value="_ -> this")
 @NotNull
@NotNull ResourcePackServer.Builder path(@NotNull
                                                                                  @NotNull java.lang.String path)

Sets the base path for the set handler, optional, defaults to "/".

Parameters:

path - The base path for the set handler

Returns:

This builder

Since:

1.0.0

build

@Contract(value="-> new")
 @NotNull
@NotNull ResourcePackServer build()
                                                                 throws java.io.IOException

Builds the ResourcePackServer instance.

Note that this method will NOT automatically start the server, you must use the ResourcePackServer.start() method to do that.

Returns:

The built ResourcePackServer instance

Throws:

java.io.IOException - If bind fails

Since:

1.0.0