Package com.tangosol.net

Class InputStreamPasswordProvider

java.lang.Object

com.tangosol.net.InputStreamPasswordProvider

All Implemented Interfaces:

PasswordProvider

Direct Known Subclasses:

URLPasswordProvider

public abstract class InputStreamPasswordProvider
extends Object
implements PasswordProvider

A base class for PasswordProvider implementations that read the contents of an InputStream to obtain a password.

Since:

22.06

Author:

Jonathan Knight 2020.01.25

Field Summary

Fields inherited from interface com.tangosol.net.PasswordProvider

NullImplementation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputStreamPasswordProvider()	Create an InputStreamPasswordProvider.
protected	InputStreamPasswordProvider(boolean fFirstLineOnly)	Create an InputStreamPasswordProvider.

Method Summary

Modifier and Type	Method	Description
char[]	get()	Returns the password to be used in clear format.
protected abstract InputStream	getInputStream()	Returns the InputStream to read the password from.
boolean	isFirstLineOnly()	Returns true to only treat the first line of the data returned by the InputStream as the password.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamPasswordProvider

protected InputStreamPasswordProvider()

Create an InputStreamPasswordProvider.

InputStreamPasswordProvider

protected InputStreamPasswordProvider(boolean fFirstLineOnly)

Create an InputStreamPasswordProvider.

Parameters:

fFirstLineOnly - true to only treat the first line of the data returned by the InputStream as the password

Method Detail

isFirstLineOnly

public boolean isFirstLineOnly()

Returns true to only treat the first line of the data returned by the InputStream as the password.

Returns:

true to only treat the first line of the data returned by the InputStream as the password

get

public char[] get()

Description copied from interface: PasswordProvider

Returns the password to be used in clear format. The char[] returned from the get() method is not retained by the provider, and it is expected that the consumer zero's out the array once it is done with the password.

Specified by:

get in interface PasswordProvider

Returns:

password as char[]

getInputStream

protected abstract InputStream getInputStream()
                                       throws IOException

Returns the InputStream to read the password from.

Returns:

the InputStream to read the password from

Throws:

IOException - if there is an error opening the InputStream