ccc.api.core
Class User

java.lang.Object
  ccc.api.core.Res
      ccc.api.core.User

All Implemented Interfaces:

java.io.Serializable

public class User
extends Res

A summary of a user.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	PASSWORD PASSWORD : String.
static java.lang.String	SELF SELF : String.

Constructor Summary

User()
Constructor.

Method Summary

java.lang.String	getEmail() Accessor.
java.util.Set<java.util.UUID>	getGroups() Accessor.
java.util.UUID	getId() Accessor.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Accessor.
java.lang.String	getName() Accessor.
java.lang.String	getPassword() Accessor.
java.util.Set<java.lang.String>	getPermissions() Accessor.
Username	getUsername() Accessor.
boolean	hasPermission(java.lang.String perm) Helper method to check if the user has a specified permission.
java.lang.String	self() Link.
User	setEmail(java.lang.String email) Mutator.
User	setGroups(java.util.Set<java.util.UUID> groups) Mutator.
User	setId(java.util.UUID id) Mutator.
User	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Mutator.
User	setName(java.lang.String name) Mutator.
User	setPassword(java.lang.String password) Mutator.
void	setPermissions(java.util.Collection<java.lang.String> permissions) Mutator.
User	setUsername(Username username) Mutator.
java.lang.String	uriPassword() Link.

Methods inherited from class ccc.api.core.Res

addLink, addLinks, getLink, getLinks

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD

public static final java.lang.String PASSWORD

PASSWORD : String.

See Also:

Constant Field Values

SELF

public static final java.lang.String SELF

SELF : String.

See Also:

Constant Field Values

Constructor Detail

User

public User()

Constructor.

Method Detail

getEmail

public java.lang.String getEmail()

Accessor.

Returns:

Returns the email.

getId

public java.util.UUID getId()

Accessor.

Returns:

Returns the id.

getUsername

public Username getUsername()

Accessor.

Returns:

Returns the username.

getName

public java.lang.String getName()

Accessor.

Returns:

Returns the name.

getGroups

public java.util.Set<java.util.UUID> getGroups()

Accessor.

Returns:

Returns the groups.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Accessor.

Returns:

Returns the metadata.

setMetadata

public User setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Mutator.

Parameters:

metadata - The metadata to set.

Returns:

Returns 'this' reference, to allow method chaining.

setEmail

public User setEmail(java.lang.String email)

Mutator.

Parameters:

email - The email to set.

Returns:

Returns 'this' reference, to allow method chaining.

setId

public User setId(java.util.UUID id)

Mutator.

Parameters:

id - The id to set.

Returns:

Returns 'this' reference, to allow method chaining.

setUsername

public User setUsername(Username username)

Mutator.

Parameters:

username - The username to set.

Returns:

Returns 'this' reference, to allow method chaining.

setName

public User setName(java.lang.String name)

Mutator.

Parameters:

name - The name to set.

Returns:

Returns 'this' reference, to allow method chaining.

setGroups

public User setGroups(java.util.Set<java.util.UUID> groups)

Mutator.

Parameters:

groups - The groups to set.

Returns:

Returns 'this' reference, to allow method chaining.

getPassword

public java.lang.String getPassword()

Accessor.

Returns:

Returns the password.

setPassword

public User setPassword(java.lang.String password)

Mutator.

Parameters:

password - The password to set.

Returns:

Returns 'this' reference, to allow method chaining.

getPermissions

public java.util.Set<java.lang.String> getPermissions()

Accessor.

Returns:

Returns the permissions.

setPermissions

public void setPermissions(java.util.Collection<java.lang.String> permissions)

Mutator.

Parameters:

permissions - The permissions to set.

hasPermission

public boolean hasPermission(java.lang.String perm)

Helper method to check if the user has a specified permission.

Parameters:

perm - The permission to be checked.

Returns:

True if the user has the permission.

self

public java.lang.String self()

Link.

Returns:

A link to this user.

uriPassword

public java.lang.String uriPassword()

Link.

Returns:

A link to this user's password.