com.solace.messaging.config

Class AuthenticationStrategy.Kerberos

java.lang.Object

com.solace.messaging.config.AuthenticationStrategy.Kerberos

All Implemented Interfaces:

AuthenticationStrategy, TypedConfiguration

Enclosing interface:

AuthenticationStrategy

@ProviderType
public static final class AuthenticationStrategy.Kerberos
extends Object
implements AuthenticationStrategy

A class for Kerberos Authentication Strategy. Kerberos is a protocol for authentication between nodes in a computer network over non-secure lines. To use the KerberosAuthenticationProvider file (jaas.conf) as specified in the Configuration instance and also a standard krb5.conf file is required. This API uses Kerberos for client authentication through GSS-API (Generic Security Services Application Program Interface).

Since:

1.0

See Also:

GSS API tutorial

Nested Class Summary

Nested classes/interfaces inherited from interface com.solace.messaging.config.AuthenticationStrategy

AuthenticationStrategy.BasicUserNamePassword, AuthenticationStrategy.ClientCertificateAuthentication, AuthenticationStrategy.Kerberos, AuthenticationStrategy.OAuth2

Method Summary

Modifier and Type	Method and Description
TypedProperties	getAuthenticationConfiguration()
static AuthenticationStrategy.Kerberos	of(String jaasLoginContextName) A factory method that creates a Kerberos instance.
static AuthenticationStrategy.Kerberos	of(String jaasLoginContextName, String kerberosPrincipalInstanceName) A factory method that creates a Kerberos instance.
AuthenticationStrategy.Kerberos	withMutualAuthentication() A factory method to configure mutual authentication when using Kerberos.
AuthenticationStrategy.Kerberos	withReloadableJaasConfiguration() A factory method to configure reloading behavior of a (jaas.conf) file.
AuthenticationStrategy.Kerberos	withUserName(String userName) A factory method to configure non default user name when using Kerberos.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.solace.messaging.config.TypedConfiguration

getConfiguration

Method Detail

getAuthenticationConfiguration

public TypedProperties getAuthenticationConfiguration()

of

public static AuthenticationStrategy.Kerberos of(String jaasLoginContextName)

A factory method that creates a Kerberos instance.

Uses defaults to 'solace' for kerberosPrincipalInstanceName

Parameters:

jaasLoginContextName - the alias used to identify the correct configuration within the jaas.conf file

Returns:

new instance of this class

Since:

1.0

of

public static AuthenticationStrategy.Kerberos of(String jaasLoginContextName,
                                                 String kerberosPrincipalInstanceName)

A factory method that creates a Kerberos instance.

Parameters:

jaasLoginContextName - the alias used to identify the correct configuration within the jaas.conf file; the context name of SolaceGSS is commonly used

kerberosPrincipalInstanceName - the instance part of the Kerberos principal identity, the entire identity to be setup on a KDC (the Key Distribution Center that issues Kerberos tickets) looks like [kerberosPrincipalInstanceName]@[hostname], where the host name is the corresponding host name of an PubSub+ broker

Returns:

a new instance of this class

Since:

1.0

withMutualAuthentication

public AuthenticationStrategy.Kerberos withMutualAuthentication()

A factory method to configure mutual authentication when using Kerberos.

Returns:

an instance of itself

Since:

1.0

withReloadableJaasConfiguration

public AuthenticationStrategy.Kerberos withReloadableJaasConfiguration()

A factory method to configure reloading behavior of a (jaas.conf) file.

Returns:

an instance of itself

Since:

1.0

withUserName

public AuthenticationStrategy.Kerberos withUserName(String userName)

A factory method to configure non default user name when using Kerberos. The broker uses the Kerberos Principal as the client-username for authentication when user name is not set explicitly.

Parameters:

userName - user name

Returns:

an instance of itself

Since:

1.0