Package org.apache.pulsar.broker.authentication

Class AuthenticationDataHttp

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationDataHttp

All Implemented Interfaces:

AuthenticationDataSource

Direct Known Subclasses:

AuthenticationDataHttps

public class AuthenticationDataHttp
extends java.lang.Object
implements AuthenticationDataSource

Field Summary

Fields

Modifier and Type	Field	Description
protected java.net.SocketAddress	remoteAddress
protected javax.servlet.http.HttpServletRequest	request
protected java.lang.String	subscription

Constructor Summary

Constructors

Constructor	Description
AuthenticationDataHttp(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHttpAuthType()
java.lang.String	getHttpHeader(java.lang.String name)
java.net.SocketAddress	getPeerAddress()
java.lang.String	getSubscription()	Subscription name can be necessary for consumption.
boolean	hasDataFromHttp()	Check if data from HTTP are available.
boolean	hasDataFromPeer()	Check if data from peer are available.
boolean	hasSubscription()	Check if subscription is defined available.
void	setSubscription(java.lang.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, getCommandData, getTlsCertificates, hasDataFromCommand, hasDataFromTls

Field Detail

request

protected final javax.servlet.http.HttpServletRequest request

remoteAddress

protected final java.net.SocketAddress remoteAddress

subscription

protected java.lang.String subscription

Constructor Detail

AuthenticationDataHttp

public AuthenticationDataHttp(javax.servlet.http.HttpServletRequest request)

Method Detail

hasDataFromHttp

public boolean hasDataFromHttp()

Description copied from interface: AuthenticationDataSource

Check if data from HTTP are available.

Specified by:

hasDataFromHttp in interface AuthenticationDataSource

Returns:

true if this authentication data contain data from HTTP

getHttpAuthType

public java.lang.String getHttpAuthType()

Specified by:

getHttpAuthType in interface AuthenticationDataSource

Returns:

a authentication scheme, or null if the request is not be authenticated.

getHttpHeader

public java.lang.String getHttpHeader(java.lang.String name)

Specified by:

getHttpHeader in interface AuthenticationDataSource

Returns:

a String containing the value of the specified header, or null if the header does not exist.

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 java.net.SocketAddress getPeerAddress()

Specified by:

getPeerAddress in interface AuthenticationDataSource

Returns:

a String containing the IP address of the client

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(java.lang.String subscription)

Description copied from interface: AuthenticationDataSource

Subscription name can be necessary for consumption.

Specified by:

setSubscription in interface AuthenticationDataSource

getSubscription

public java.lang.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