/**
* Copyright 2016 Yahoo Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.yahoo.pulsar.broker.authentication;
import java.net.SocketAddress;
import java.security.cert.Certificate;
/**
* Interface for accessing data which are used in variety of authentication schemes on server side
*/
public interface AuthenticationDataSource {
/*
* TLS
*/
/**
* Check if data from TLS are available.
*
* @return true if this authentication data contain data from TLS
*/
default boolean hasDataFromTls() {
return false;
}
/**
*
* @return a client certificate chain, or null if the data are not available
*/
default Certificate[] getTlsCertificates() {
return null;
}
/*
* HTTP
*/
/**
* Check if data from HTTP are available.
*
* @return true if this authentication data contain data from HTTP
*/
default boolean hasDataFromHttp() {
return false;
}
/**
*
* @return a authentication scheme, or <code>null<c/ode> if the request is not be authenticated
*/
default String getHttpAuthType() {
return null;
}
/**
*
* @return a <code>String</code> containing the value of the specified header, or <code>null</code> if the header
* does not exist.
*/
default String getHttpHeader(String name) {
return null;
}
/*
* Command
*/
/**
* Check if data from Pulsar protocol are available.
*
* @return true if this authentication data contain data from Pulsar protocol
*/
default boolean hasDataFromCommand() {
return false;
}
/**
*
* @return authentication data which is stored in a command
*/
default String getCommandData() {
return null;
}
/*
* Peer
*/
/**
* Check if data from peer are available.
*
* @return true if this authentication data contain data from peer
*/
default boolean hasDataFromPeer() {
return false;
}
/**
*
* @return a <code>String</code> containing the IP address of the client
*/
default SocketAddress getPeerAddress() {
return null;
}
}