Package net.webpdf.wsclient.openapi

Class AuthUserCredentials

java.lang.Object

net.webpdf.wsclient.openapi.AuthUserCredentials

public class AuthUserCredentials
extends Object

Returns details about a user in a session

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_IS_ADMIN
static String	JSON_PROPERTY_IS_USER
static String	JSON_PROPERTY_ROLES
static String	JSON_PROPERTY_UNIQUE_ID
static String	JSON_PROPERTY_USER_LIMITS
static String	JSON_PROPERTY_USER_NAME

Constructor Summary

Constructors

Constructor	Description
AuthUserCredentials()
AuthUserCredentials(Boolean isAdmin, Boolean isUser, List<String> roles, String uniqueId, String userName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull Boolean	getIsAdmin()	true = An administration user
@NotNull Boolean	getIsUser()	true = A standard user
@NotNull List<String>	getRoles()	Roles assigned to the user
@NotNull String	getUniqueId()	Unique ID for the user
@NotNull AuthLimits	getUserLimits()	Get userLimits
@NotNull String	getUserName()	Name of the user
int	hashCode()
void	setUserLimits(AuthLimits userLimits)
String	toString()
AuthUserCredentials	userLimits(AuthLimits userLimits)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_IS_ADMIN

public static final String JSON_PROPERTY_IS_ADMIN

See Also:

Constant Field Values

JSON_PROPERTY_IS_USER

public static final String JSON_PROPERTY_IS_USER

See Also:

Constant Field Values

JSON_PROPERTY_ROLES

public static final String JSON_PROPERTY_ROLES

See Also:

Constant Field Values

JSON_PROPERTY_UNIQUE_ID

public static final String JSON_PROPERTY_UNIQUE_ID

See Also:

Constant Field Values

JSON_PROPERTY_USER_LIMITS

public static final String JSON_PROPERTY_USER_LIMITS

See Also:

Constant Field Values

JSON_PROPERTY_USER_NAME

public static final String JSON_PROPERTY_USER_NAME

See Also:

Constant Field Values

Constructor Detail

AuthUserCredentials

public AuthUserCredentials()

AuthUserCredentials

public AuthUserCredentials(Boolean isAdmin,
                           Boolean isUser,
                           List<String> roles,
                           String uniqueId,
                           String userName)

Method Detail

getIsAdmin

@NotNull
public @NotNull Boolean getIsAdmin()

true = An administration user

Returns:

isAdmin

getIsUser

@NotNull
public @NotNull Boolean getIsUser()

true = A standard user

Returns:

isUser

getRoles

@NotNull
public @NotNull List<String> getRoles()

Roles assigned to the user

Returns:

roles

getUniqueId

@NotNull
public @NotNull String getUniqueId()

Unique ID for the user

Returns:

uniqueId

userLimits

public AuthUserCredentials userLimits(AuthLimits userLimits)

getUserLimits

@NotNull
public @NotNull AuthLimits getUserLimits()

Get userLimits

Returns:

userLimits

setUserLimits

public void setUserLimits(AuthLimits userLimits)

getUserName

@NotNull
public @NotNull String getUserName()

Name of the user

Returns:

userName

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object