Package com.floragunn.searchguard.user

Class AuthCredentials

java.lang.Object

com.floragunn.searchguard.user.AuthCredentials

All Implemented Interfaces:

UserInformation

public final class AuthCredentials
extends Object
implements UserInformation

AuthCredentials are an abstraction to encapsulate credentials like passwords or generic native credentials like GSS tokens.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthCredentials.Builder

Field Summary

Fields inherited from interface com.floragunn.searchguard.user.UserInformation

NONE

Constructor Summary

Constructors

Constructor	Description
AuthCredentials(String username, byte[] password)	Deprecated.
AuthCredentials(String username, Object nativeCredentials)	Deprecated.
AuthCredentials(String username, String... backendRoles)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String name, String value)	Deprecated.
void	clearSecrets()	Wipe password and native credentials
AuthCredentials.Builder	copy()
boolean	equals(Object obj)
static AuthCredentials.Builder	forUser(String username)
Map<String,String>	getAttributes()
String	getAuthDomain()
AuthDomainInfo	getAuthDomainInfo()
Set<String>	getBackendRoles()
Map<String,Object>	getClaims()
String	getName()
Object	getNativeCredentials()
byte[]	getPassword()
Map<String,Object>	getStructuredAttributes()
String	getSubName()
String	getSubUserName()
String	getUsername()
int	hashCode()
boolean	isAuthzComplete()
boolean	isComplete()
AuthCredentials	markComplete()	Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthCredentials

@Deprecated
public AuthCredentials(String username,
                       Object nativeCredentials)

Deprecated.

AuthCredentials

@Deprecated
public AuthCredentials(String username,
                       byte[] password)

Deprecated.

AuthCredentials

@Deprecated
public AuthCredentials(String username,
                       String... backendRoles)

Deprecated.

Method Detail

forUser

public static AuthCredentials.Builder forUser(String username)

clearSecrets

public void clearSecrets()

Wipe password and native credentials

getUsername

public String getUsername()

getSubUserName

public String getSubUserName()

getPassword

public byte[] getPassword()

getNativeCredentials

public Object getNativeCredentials()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getBackendRoles

public Set<String> getBackendRoles()

Returns:

Defensive copy of the roles this user is member of.

isComplete

public boolean isComplete()

isAuthzComplete

public boolean isAuthzComplete()

getAttributes

public Map<String,String> getAttributes()

copy

public AuthCredentials.Builder copy()

markComplete

@Deprecated
public AuthCredentials markComplete()

Deprecated.

addAttribute

@Deprecated
public void addAttribute(String name,
                         String value)

Deprecated.

getStructuredAttributes

public Map<String,Object> getStructuredAttributes()

getClaims

public Map<String,Object> getClaims()

getAuthDomainInfo

public AuthDomainInfo getAuthDomainInfo()

getName

public String getName()

Specified by:

getName in interface UserInformation

getSubName

public String getSubName()

Specified by:

getSubName in interface UserInformation

getAuthDomain

public String getAuthDomain()

Specified by:

getAuthDomain in interface UserInformation