com.attivio.sdk.security

Class AttivioRole

java.lang.Object

com.attivio.sdk.security.AttivioRole

All Implemented Interfaces:

Serializable, Cloneable

public class AttivioRole
extends Object
implements Serializable, Cloneable

An AttivioRole represents role authorization permissions on client APIs.

It has a required name representing the role name, and an optional subgroup/resource for partitioning of the role.

For example, a module might have an administrative role like:

  AttivioUserRole('ROLE_MODULE_ADMIN')
 

And it might have collection specific roles like:

  AttivioUserRole('ROLE_MODULE_USER','support')
  AttivioUserRole('ROLE_MODULE_USER','production')
 

Or collectionId specific roles, like:

  AttivioUserRole('ROLE_MODULE_USER','collection001')
  AttivioUserRole('ROLE_MODULE_USER','collection002')
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBGROUP_ANY Represents that all subroups match.

Constructor Summary

Constructors

Constructor and Description
AttivioRole() Constructor intended for use by serialization code.
AttivioRole(Enum<?> role) Constructs a user role via an enum value for the role name.
AttivioRole(Enum<?> role, String subgroup) Constructs a user role with an enum value for name and a subgroup.
AttivioRole(String name) Constructs a user role from a role name.
AttivioRole(String name, String subgroup) Constructs a user role from name and subgroup.

Method Summary

Modifier and Type	Method and Description
AttivioRole	clone()
boolean	equals(Object obj)
String	getName()
String	getSubgroup()
int	hashCode()
void	setName(String name) Sets the role name.
void	setSubgroup(String subgroup) Sets the subgroup
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUBGROUP_ANY

public static final String SUBGROUP_ANY

Represents that all subroups match.

See Also:

Constant Field Values

Constructor Detail

AttivioRole

public AttivioRole()

Constructor intended for use by serialization code.

AttivioRole

public AttivioRole(String name,
                   String subgroup)

Constructs a user role from name and subgroup.

Parameters:

name - the name

subgroup - the subgroup or resource

AttivioRole

public AttivioRole(String name)

Constructs a user role from a role name.

Parameters:

name - the name

AttivioRole

public AttivioRole(Enum<?> role)

Constructs a user role via an enum value for the role name.

Parameters:

role - any Enum which maps to role names.

AttivioRole

public AttivioRole(Enum<?> role,
                   String subgroup)

Constructs a user role with an enum value for name and a subgroup.

Parameters:

role - any Enum which maps to role names.

subgroup - Subgroup or resource.

Method Detail

getName

public String getName()

Returns:

the role name

setName

public void setName(String name)

Sets the role name.

Parameters:

name - the role name

getSubgroup

public String getSubgroup()

Returns:

the subgroup

setSubgroup

public void setSubgroup(String subgroup)

Sets the subgroup

Parameters:

subgroup -

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

clone

public AttivioRole clone()
                  throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException