Package net.webpdf.wsclient.schema.beans

Class User

java.lang.Object

net.webpdf.wsclient.schema.beans.User

All Implemented Interfaces:

Serializable

public class User
extends Object
implements Serializable

An instance of User is intended to wrap and simplify information about a webPDF server user.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
User()

Method Summary

Modifier and Type	Method	Description
@Nullable String[]	getRoles()	Returns all active roles of the user.
@Nullable Limits	getUserLimits()	Returns the Limits for the current user.
@Nullable String	getUserName()	Returns the name of the current user.
boolean	isAdmin()	Returns true, if the user is an administrator.
boolean	isAuthenticated()	Returns true, if the user has been authenticated.
boolean	isUser()	Returns true, if the user is a standard user.
void	setAdmin(boolean admin)	Set to true, if the user is an administrator.
void	setAuthenticated(boolean authenticated)	Set to true, if the user has been authenticated.
void	setRoles(@Nullable String[] roles)	Set all active roles of the user.
void	setUser(boolean user)	Set to true, if the user is a standard user.
void	setUserLimits(@Nullable Limits userLimits)	Sets the user Limits for the current user.
void	setUserName(@Nullable String userName)	Sets the name of the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Method Detail

isAdmin

public boolean isAdmin()

Returns true, if the user is an administrator.

Returns:

true, if the user is an administrator.

setAdmin

public void setAdmin(boolean admin)

Set to true, if the user is an administrator.

Parameters:

admin - true, if the user is an administrator.

isUser

public boolean isUser()

Returns true, if the user is a standard user.

Returns:

true, if the user is a standard user.

setUser

public void setUser(boolean user)

Set to true, if the user is a standard user.

Parameters:

user - true, if the user is a standard user.

isAuthenticated

public boolean isAuthenticated()

Returns true, if the user has been authenticated.

Returns:

true, if the user has been authenticated.

setAuthenticated

public void setAuthenticated(boolean authenticated)

Set to true, if the user has been authenticated.

Parameters:

authenticated - true, if the user has been authenticated.

getRoles

@Nullable
public @Nullable String[] getRoles()

Returns all active roles of the user.

Returns:

All active roles of the user.

setRoles

public void setRoles(@Nullable
                     @Nullable String[] roles)

Set all active roles of the user.

Parameters:

roles - All active roles of the user.

getUserName

@Nullable
public @Nullable String getUserName()

Returns the name of the current user.

Returns:

The name of the current user.

setUserName

public void setUserName(@Nullable
                        @Nullable String userName)

Sets the name of the current user.

Parameters:

userName - The name of the current user.

getUserLimits

@Nullable
public @Nullable Limits getUserLimits()

Returns the Limits for the current user.

Returns:

The Limits for the current user.

setUserLimits

public void setUserLimits(@Nullable
                          @Nullable Limits userLimits)

Sets the user Limits for the current user.

Parameters:

userLimits - The user Limits for the current user.