org.apache.pulsar.broker.authentication

Class AuthenticationDataCommand

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationDataCommand

All Implemented Interfaces:

AuthenticationDataSource

public class AuthenticationDataCommand
extends Object
implements AuthenticationDataSource

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authData
protected SocketAddress	remoteAddress
protected SSLSession	sslSession
protected String	subscription

Constructor Summary

Constructors

Constructor and Description
AuthenticationDataCommand(String authData)
AuthenticationDataCommand(String authData, SocketAddress remoteAddress, SSLSession sslSession)
AuthenticationDataCommand(String authData, SocketAddress remoteAddress, SSLSession sslSession, String subscription)
AuthenticationDataCommand(String authData, String subscription)

Method Summary

Modifier and Type	Method and Description
String	getCommandData()
SocketAddress	getPeerAddress()
String	getSubscription() Subscription name can be necessary for consumption
Certificate[]	getTlsCertificates()
boolean	hasDataFromCommand() Check if data from Pulsar protocol are available.
boolean	hasDataFromPeer() Check if data from peer are available.
boolean	hasDataFromTls() Check if data from TLS are available.
boolean	hasSubscription() Check if subscription is defined available.
void	setSubscription(String subscription) Subscription name can be necessary for consumption

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.broker.authentication.AuthenticationDataSource

authenticate, getHttpAuthType, getHttpHeader, hasDataFromHttp

Field Detail

authData

protected final String authData

remoteAddress

protected final SocketAddress remoteAddress

sslSession

protected final SSLSession sslSession

subscription

protected String subscription

Constructor Detail

AuthenticationDataCommand

public AuthenticationDataCommand(String authData)

AuthenticationDataCommand

public AuthenticationDataCommand(String authData,
                                 String subscription)

AuthenticationDataCommand

public AuthenticationDataCommand(String authData,
                                 SocketAddress remoteAddress,
                                 SSLSession sslSession,
                                 String subscription)

AuthenticationDataCommand

public AuthenticationDataCommand(String authData,
                                 SocketAddress remoteAddress,
                                 SSLSession sslSession)

Method Detail

hasDataFromCommand

public boolean hasDataFromCommand()

Description copied from interface: AuthenticationDataSource

Check if data from Pulsar protocol are available.

Specified by:

hasDataFromCommand in interface AuthenticationDataSource

Returns:

true if this authentication data contain data from Pulsar protocol

getCommandData

public String getCommandData()

Specified by:

getCommandData in interface AuthenticationDataSource

Returns:

authentication data which is stored in a command

hasDataFromPeer

public boolean hasDataFromPeer()

Description copied from interface: AuthenticationDataSource

Check if data from peer are available.

Specified by:

hasDataFromPeer in interface AuthenticationDataSource

Returns:

true if this authentication data contain data from peer

getPeerAddress

public SocketAddress getPeerAddress()

Specified by:

getPeerAddress in interface AuthenticationDataSource

Returns:

a String containing the IP address of the client

hasDataFromTls

public boolean hasDataFromTls()

Description copied from interface: AuthenticationDataSource

Check if data from TLS are available.

Specified by:

hasDataFromTls in interface AuthenticationDataSource

Returns:

true if this authentication data contain data from TLS

getTlsCertificates

public Certificate[] getTlsCertificates()

Specified by:

getTlsCertificates in interface AuthenticationDataSource

Returns:

a client certificate chain, or null if the data are not available

hasSubscription

public boolean hasSubscription()

Description copied from interface: AuthenticationDataSource

Check if subscription is defined available.

Specified by:

hasSubscription in interface AuthenticationDataSource

Returns:

true if this authentication data contain subscription

setSubscription

public void setSubscription(String subscription)

Description copied from interface: AuthenticationDataSource

Subscription name can be necessary for consumption

Specified by:

setSubscription in interface AuthenticationDataSource

getSubscription

public String getSubscription()

Description copied from interface: AuthenticationDataSource

Subscription name can be necessary for consumption

Specified by:

getSubscription in interface AuthenticationDataSource

Returns:

a String containing the subscription name