Interface ServerSASLFactory

All Known Implementing Classes:

AnonymousServerSASLFactory, ExternalServerSASLFactory, GSSAPIServerSASLFactory, PlainServerSASLFactory, SCRAMServerSASLFactory, SHA256SCRAMServerSASLFactory, SHA512SCRAMServerSASLFactory

public interface ServerSASLFactory

A ServerSASLFactory is responsible for instantiating a given SASL mechanism

Method Summary

Modifier and Type	Method	Description
ServerSASL	create(org.apache.activemq.artemis.core.server.ActiveMQServer server, ProtocolManager<AmqpInterceptor, AMQPRoutingHandler> manager, Connection connection, RemotingConnection remotingConnection)	creates a new ServerSASL for the provided context
String	getMechanism()	Returns the name of the scheme to offer.
int	getPrecedence()	Returns the precedence of the given SASL mechanism, the default precedence is zero, where higher means better.
boolean	isDefaultPermitted()	Returns true if this mechanism should be part of the servers default permitted protocols or false if it must be explicitly configured.

Method Details

getMechanism

String getMechanism()

Returns the name of the scheme to offer.

Returns:

the name of the scheme to offer

create

ServerSASL create(org.apache.activemq.artemis.core.server.ActiveMQServer server,
 ProtocolManager<AmqpInterceptor, AMQPRoutingHandler> manager,
 Connection connection,
 RemotingConnection remotingConnection)

creates a new ServerSASL for the provided context

Returns:

a new instance of ServerSASL that implements the provided mechanism

getPrecedence

int getPrecedence()

Returns the precedence of the given SASL mechanism, the default precedence is zero, where higher means better.

Returns:

the precedence of the given SASL mechanism, the default precedence is zero, where higher means better

isDefaultPermitted

boolean isDefaultPermitted()

Returns true if this mechanism should be part of the servers default permitted protocols or false if it must be explicitly configured.

Returns:

true if this mechanism should be part of the servers default permitted protocols or false if it must be explicitly configured