org.jenkinsci.remoting.protocol

Class ProtocolStack.Builder

java.lang.Object

org.jenkinsci.remoting.protocol.ProtocolStack.Builder

Enclosing class:

ProtocolStack<T>

@NotThreadSafe
public static class ProtocolStack.Builder
extends Object

Builder for ProtocolStack instances.

Method Summary

Modifier and Type	Method and Description
<T> ProtocolStack<T>	build(ApplicationLayer<T> application) Create the ProtocolStack.
ProtocolStack.Builder	filter(FilterLayer filter) Adds the supplied filter into the ProtocolStack.
ProtocolStack.Builder	listener(ProtocolStack.Listener listener) Register a ProtocolStack.Listener for the ProtocolStack.
ProtocolStack.Builder	named(String name) Provide a custom name for the ProtocolStack.

Methods inherited from class java.lang.Object

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

Method Detail

filter

public ProtocolStack.Builder filter(@CheckForNull
                                    FilterLayer filter)

Adds the supplied filter into the ProtocolStack.

Parameters:

filter - the filter to add, if null then it will be ignored (useful for conditionally adding filters)

Returns:

this.

named

public ProtocolStack.Builder named(String name)

Provide a custom name for the ProtocolStack.

Parameters:

name - the custom name.

Returns:

this

listener

public ProtocolStack.Builder listener(ProtocolStack.Listener listener)

Register a ProtocolStack.Listener for the ProtocolStack.

Parameters:

listener - the listener.

Returns:

this

build

public <T> ProtocolStack<T> build(ApplicationLayer<T> application)
                           throws IOException

Create the ProtocolStack.

Type Parameters:

T - the application specific API.

Parameters:

application - the ApplicationLayer to use.

Returns:

the ProtocolStack.

Throws:

IOException - if the ProtocolStack could not be started.