Class SCRAMServerSASLFactory

java.lang.Object

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

All Implemented Interfaces:

ServerSASLFactory

Direct Known Subclasses:

SHA256SCRAMServerSASLFactory, SHA512SCRAMServerSASLFactory

public abstract class SCRAMServerSASLFactory
extends Object
implements ServerSASLFactory

abstract class that implements the SASL-SCRAM authentication scheme, concrete implementations must supply the SCRAM type to use and be register via SPI

Constructor Summary

Constructors

Constructor	Description
SCRAMServerSASLFactory(SCRAM scram, org.slf4j.Logger logger)

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.
boolean	isDefaultPermitted()	Returns true if this mechanism should be part of the servers default permitted protocols or false if it must be explicitly configured.

Methods inherited from class Object

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

Methods inherited from interface ServerSASLFactory

getPrecedence

Constructor Details

SCRAMServerSASLFactory

public SCRAMServerSASLFactory(SCRAM scram,
 org.slf4j.Logger logger)

Method Details

getMechanism

public String getMechanism()

Description copied from interface: ServerSASLFactory

Returns the name of the scheme to offer.

Specified by:

getMechanism in interface ServerSASLFactory

Returns:

the name of the scheme to offer

isDefaultPermitted

public boolean isDefaultPermitted()

Description copied from interface: ServerSASLFactory

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

Specified by:

isDefaultPermitted in interface ServerSASLFactory

Returns:

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

create

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

Description copied from interface: ServerSASLFactory

creates a new ServerSASL for the provided context

Specified by:

create in interface ServerSASLFactory

Returns:

a new instance of ServerSASL that implements the provided mechanism