Module org.bzdev.ejws

Package org.bzdev.ejws

Class EjwsSecureBasicAuth.Entry

java.lang.Object

org.bzdev.ejws.EjwsAuthenticator.Entry

org.bzdev.ejws.EjwsBasicAuthenticator.Entry

org.bzdev.ejws.EjwsSecureBasicAuth.Entry

Enclosing class:

EjwsSecureBasicAuth

public static class EjwsSecureBasicAuth.Entry
extends EjwsBasicAuthenticator.Entry

User entry. This object contains a user's password, roles, and public-key operations.

See Also:

• SecureBasicUtilities

Field Summary

Fields inherited from class org.bzdev.ejws.EjwsBasicAuthenticator.Entry

pw

Constructor Summary

Constructors

Constructor	Description
Entry(String pem, String pw, Set<String> roles)	Constructor with a PEM-encoded public-key.
Entry(String pem, String pw, Set<String> roles, boolean sblCompressed, byte[] sbldata)	Constructor with a PEM-encoded public-key and SBL data.
Entry(String pw, Set<String> roles)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getPassword()	Get the password stored in this entry.
String	getPEM()	Get the PEM encoded public key
Set<String>	getRoles()	Get the roles stored in this entry.
SecureBasicUtilities	getSecureBasicUtilities()	Get an instance of an object that provides secure basic authentication operations.

Methods inherited from class org.bzdev.ejws.EjwsAuthenticator.Entry

getSBL, isActive, isSBLCompressed, makeActive, setActive, setSBL, setSBLCompressed

Methods inherited from class java.lang.Object

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

Constructor Details

Entry

public Entry(String pw,
 Set<String> roles)

Constructor.

Parameters:

pw - a password for a user

roles - a set of roles that a user may have

Entry

public Entry(String pem,
 String pw,
 Set<String> roles)

Constructor with a PEM-encoded public-key.

Parameters:

pem - the PEM encoded public key or a certificate containing that public key.

pw - a password for a user

roles - a set of roles that a user may have

Entry

public Entry(String pem,
 String pw,
 Set<String> roles,
 boolean sblCompressed,
 byte[] sbldata)

Constructor with a PEM-encoded public-key and SBL data. The term SBL refers to the file created with the program sbl.

Parameters:

pem - the PEM encoded public key or a certificate containing that public key.

pw - a password for a user

roles - a set of roles that a user may have

sblCompressed - true if the sbldata is compressed, false otherwise

sbldata - the SBL file as a byte array, possibly compressed

Method Details

getPEM

public String getPEM()

Get the PEM encoded public key

Returns:

the PEM encoded key; null if there is none

getPassword

public String getPassword()

Get the password stored in this entry.

Overrides:

getPassword in class EjwsBasicAuthenticator.Entry

Returns:

the password

getRoles

public Set<String> getRoles()

Get the roles stored in this entry.

Overrides:

getRoles in class EjwsAuthenticator.Entry

Returns:

a set of roles; null if not applicable

getSecureBasicUtilities

public SecureBasicUtilities getSecureBasicUtilities()

Get an instance of an object that provides secure basic authentication operations. This object is created by this class's constructors.

Overrides:

getSecureBasicUtilities in class EjwsAuthenticator.Entry

Returns:

the object