Top Description Fields Constructors Methods
org.bouncycastle.est.jcajce

public Class JsseESTServiceBuilder

extends ESTServiceBuilder
Class Inheritance
Imports
java.net.Socket, java.security.NoSuchProviderException, .Provider, .SecureRandom, java.util.Arrays, .HashSet, .Set, javax.net.ssl.KeyManager, .X509TrustManager, org.bouncycastle.est.ESTClientProvider, .ESTService, .ESTServiceBuilder

Build an RFC7030 (EST) service based on the JSSE.

Field Summary

Modifier and TypeField and Description
protected Long
protected ChannelBindingProvider
protected boolean
protected JsseHostnameAuthorizer
protected SSLSocketFactoryCreator
protected SSLSocketFactoryCreatorBuilder
protected Set<String>
protected int
Inherited from org.bouncycastle.est.ESTServiceBuilder:
clientProviderlabelserver

Constructor Summary

AccessConstructor and Description
public
JsseESTServiceBuilder(String
hostName to talk to.
hostName
,
int portNo, SSLSocketFactoryCreator
a custom creator of socket factories.
socketFactoryCreator
)

Create a builder for a client using a custom SSLSocketFactoryCreator.

public
JsseESTServiceBuilder(String
name of the server to talk to (URL format).
server
,
SSLSocketFactoryCreator
a custom creator of socket factories.
socketFactoryCreator
)

Create a builder for a client using a custom SSLSocketFactoryCreator.

public
JsseESTServiceBuilder(String
name of the server to talk to (URL format).
server
)

Create a builder for a client talking to a server that is not yet trusted.

public
JsseESTServiceBuilder(String
name of the server to talk to.
hostName
,
int
port number to connect on.
portNo
,
X509TrustManager
trust manager to be used for validating the connection.
trustManager
)

Create a builder for a client talking to a trusted server.

public
JsseESTServiceBuilder(String
name of the server to talk to (URL format).
server
,
X509TrustManager
trust manager to be used for validating the connection.
trustManager
)

Create a builder for a client talking to a trusted server.

public
JsseESTServiceBuilder(String
name of the server to talk to.
hostName
,
int
port number to connect on.
portNo
,
X509TrustManager[]
trust managers that can be used for validating the connection.
trustManagers
)

Create a builder for a client talking to a trusted server.

public
JsseESTServiceBuilder(String
name of the server to talk to (URL format).
server
,
X509TrustManager[]
trust managers that can be used for validating the connection.
trustManagers
)

Create a builder for a client talking to a trusted server.

Method Summary

Modifier and TypeMethod and Description
public JsseESTServiceBuilder
public JsseESTServiceBuilder
public ESTService
build()

Overrides org.bouncycastle.est.ESTServiceBuilder.build.

Build the service.
public JsseESTServiceBuilder
public JsseESTServiceBuilder
withClientProvider(ESTClientProvider
The client provider.
clientProvider
)

Overrides org.bouncycastle.est.ESTServiceBuilder.withClientProvider.

Set the client provider.
public JsseESTServiceBuilder

Returns:

this;
withFilterCipherSuites
(boolean
true, supplied cipher suites will be filtered with supported before passing to the JSSE provider.
filter
)

Filter cipher suites with supported before passing to JSSE provider.

public JsseESTServiceBuilder
public JsseESTServiceBuilder
public JsseESTServiceBuilder
withKeyManagers(KeyManager[] keyManagers)

public JsseESTServiceBuilder

Returns:

the current builder instance.
withProvider
(String
the name JSSE Provider to use.
tlsProviderName
)

Configure this builder to use the provider with the passed in name.

public JsseESTServiceBuilder

Returns:

the current builder instance.
withProvider
(Provider
the JSSE Provider to use.
tlsProvider
)

Configure this builder to use the passed in provider.

public JsseESTServiceBuilder
withReadLimit(long absoluteLimit)

public JsseESTServiceBuilder
public JsseESTServiceBuilder
withTimeout(int timeoutMillis)

public JsseESTServiceBuilder
withTLSVersion(String tlsVersion)

Inherited from org.bouncycastle.est.ESTServiceBuilder:
withLabel

Field Detail

absoluteLimitback to summary
protected Long absoluteLimit
bindingProviderback to summary
protected ChannelBindingProvider bindingProvider
filterCipherSuitesback to summary
protected boolean filterCipherSuites
hostNameAuthorizerback to summary
protected JsseHostnameAuthorizer hostNameAuthorizer
socketFactoryCreatorback to summary
protected SSLSocketFactoryCreator socketFactoryCreator
sslSocketFactoryCreatorBuilderback to summary
protected SSLSocketFactoryCreatorBuilder sslSocketFactoryCreatorBuilder
supportedSuitesback to summary
protected Set<String> supportedSuites
timeoutMillisback to summary
protected int timeoutMillis

Constructor Detail

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String hostName, int portNo, SSLSocketFactoryCreator socketFactoryCreator)

Create a builder for a client using a custom SSLSocketFactoryCreator.

Parameters
hostName:String

hostName to talk to.

socketFactoryCreator:SSLSocketFactoryCreator

a custom creator of socket factories.

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String server, SSLSocketFactoryCreator socketFactoryCreator)

Create a builder for a client using a custom SSLSocketFactoryCreator.

Parameters
server:String

name of the server to talk to (URL format).

socketFactoryCreator:SSLSocketFactoryCreator

a custom creator of socket factories.

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String server)

Create a builder for a client talking to a server that is not yet trusted.

Parameters
server:String

name of the server to talk to (URL format).

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String hostName, int portNo, X509TrustManager trustManager)

Create a builder for a client talking to a trusted server.

Parameters
hostName:String

name of the server to talk to.

portNo:int

port number to connect on.

trustManager:X509TrustManager

trust manager to be used for validating the connection.

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String server, X509TrustManager trustManager)

Create a builder for a client talking to a trusted server.

Parameters
server:String

name of the server to talk to (URL format).

trustManager:X509TrustManager

trust manager to be used for validating the connection.

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String hostName, int portNo, X509TrustManager[] trustManagers)

Create a builder for a client talking to a trusted server.

Parameters
hostName:String

name of the server to talk to.

portNo:int

port number to connect on.

trustManagers:X509TrustManager[]

trust managers that can be used for validating the connection.

JsseESTServiceBuilderback to summary
public JsseESTServiceBuilder(String server, X509TrustManager[] trustManagers)

Create a builder for a client talking to a trusted server.

Parameters
server:String

name of the server to talk to (URL format).

trustManagers:X509TrustManager[]

trust managers that can be used for validating the connection.

Method Detail

addCipherSuitesback to summary
public JsseESTServiceBuilder addCipherSuites(String name)
addCipherSuitesback to summary
public JsseESTServiceBuilder addCipherSuites(String[] names)
buildback to summary
public ESTService build()

Overrides org.bouncycastle.est.ESTServiceBuilder.build.

Doc from org.bouncycastle.est.ESTServiceBuilder.build.

Build the service.

Returns:ESTService

an ESTService.

withChannelBindingProviderback to summary
public JsseESTServiceBuilder withChannelBindingProvider(ChannelBindingProvider channelBindingProvider)
withClientProviderback to summary
public JsseESTServiceBuilder withClientProvider(ESTClientProvider clientProvider)

Overrides org.bouncycastle.est.ESTServiceBuilder.withClientProvider.

Doc from org.bouncycastle.est.ESTServiceBuilder.withClientProvider.

Set the client provider.

Parameters
clientProvider:ESTClientProvider

The client provider.

withFilterCipherSuitesback to summary
public JsseESTServiceBuilder withFilterCipherSuites(boolean filter)

Filter cipher suites with supported before passing to JSSE provider.

Parameters
filter:boolean

true, supplied cipher suites will be filtered with supported before passing to the JSSE provider.

Returns:JsseESTServiceBuilder

this;

withHostNameAuthorizerback to summary
public JsseESTServiceBuilder withHostNameAuthorizer(JsseHostnameAuthorizer hostNameAuthorizer)
withKeyManagerback to summary
public JsseESTServiceBuilder withKeyManager(KeyManager keyManager)
withKeyManagersback to summary
public JsseESTServiceBuilder withKeyManagers(KeyManager[] keyManagers)
withProviderback to summary
public JsseESTServiceBuilder withProvider(String tlsProviderName) throws NoSuchProviderException

Configure this builder to use the provider with the passed in name.

Parameters
tlsProviderName:String

the name JSSE Provider to use.

Returns:JsseESTServiceBuilder

the current builder instance.

Exceptions
NoSuchProviderException:
if the specified provider does not exist.
withProviderback to summary
public JsseESTServiceBuilder withProvider(Provider tlsProvider)

Configure this builder to use the passed in provider.

Parameters
tlsProvider:Provider

the JSSE Provider to use.

Returns:JsseESTServiceBuilder

the current builder instance.

withReadLimitback to summary
public JsseESTServiceBuilder withReadLimit(long absoluteLimit)
withSecureRandomback to summary
public JsseESTServiceBuilder withSecureRandom(SecureRandom secureRandom)
withTimeoutback to summary
public JsseESTServiceBuilder withTimeout(int timeoutMillis)
withTLSVersionback to summary
public JsseESTServiceBuilder withTLSVersion(String tlsVersion)