org.apache.activemq.artemis.protocol.amqp.sasl

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 and Description
ServerSASL	create(ActiveMQServer server, ProtocolManager<AmqpInterceptor,AMQPRedirectHandler> manager, Connection connection, RemotingConnection remotingConnection) creates a new ServerSASL for the provided context
String	getMechanism()
int	getPrecedence() returns the precedence of the given SASL mechanism, the default precedence is zero, where higher means better
boolean	isDefaultPermitted()

Method Detail

getMechanism

String getMechanism()

Returns:

the name of the scheme to offer

create

ServerSASL create(ActiveMQServer server,
                  ProtocolManager<AmqpInterceptor,AMQPRedirectHandler> manager,
                  Connection connection,
                  RemotingConnection remotingConnection)

creates a new ServerSASL for the provided context

Parameters:

server -

manager -

connection -

remotingConnection -

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 this mechanism

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