SCRAMServerSASLFactory (ActiveMQ Artemis AMQP Protocol 2.26.0 API)

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 java.lang.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(org.apache.activemq.artemis.spi.core.security.scram.SCRAM scram)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ServerSASL`	`create(org.apache.activemq.artemis.core.server.ActiveMQServer server, org.apache.activemq.artemis.spi.core.protocol.ProtocolManager<AmqpInterceptor,AMQPRoutingHandler> manager, org.apache.activemq.artemis.spi.core.remoting.Connection connection, org.apache.activemq.artemis.spi.core.protocol.RemotingConnection remotingConnection)`	creates a new `ServerSASL` for the provided context
`java.lang.String`	`getMechanism()`
`boolean`	`isDefaultPermitted()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.protocol.amqp.sasl.ServerSASLFactory
getPrecedence

Constructor Detail

SCRAMServerSASLFactory

public SCRAMServerSASLFactory(org.apache.activemq.artemis.spi.core.security.scram.SCRAM scram)

Method Detail
- getMechanism
```
public java.lang.String getMechanism()
```
  Specified by:
  
  getMechanism in interface ServerSASLFactory
  
  Returns:
  
  the name of the scheme to offer
- isDefaultPermitted
```
public boolean isDefaultPermitted()
```
  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,
                         org.apache.activemq.artemis.spi.core.protocol.ProtocolManager<AmqpInterceptor,AMQPRoutingHandler> manager,
                         org.apache.activemq.artemis.spi.core.remoting.Connection connection,
                         org.apache.activemq.artemis.spi.core.protocol.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