com.attivio.sdk.security

Class AttivioPrincipal

java.lang.Object

com.attivio.sdk.security.AttivioPrincipal

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AttivioPrincipal>, Principal

public class AttivioPrincipal
extends Object
implements Principal, Serializable, Comparable<AttivioPrincipal>, Cloneable

Represents a principal (a user or a group).

A principal is characterized by three attributes:

• realm ID - the ID of the security realm in which the principal is defined
• principal ID - the unique ID of the principal
• principal name - the name of the principal

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttivioPrincipal.PrincipalType Contains the possible principal types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS Constant to signify anonymous (realm or user).
static AttivioPrincipal	ANONYMOUS_USER Represents the anonymous user (whose realm ID, principal ID, and principal name are ANONYMOUS).
static String	ANONYMOUS_USER_GUID The GUID of the anonymous user.
protected UUID	correlationId correlation id if set
static String	FIELD_PRINCIPAL_ID The name of the field that stores the principal ID.
static String	FIELD_PRINCIPAL_NAME The name of the field that stores the principal name.
static String	FIELD_REALM_ID The name of the field that stores the security realm ID.
protected Set<AttivioGroupMembership>	groupMemberships Any group memberships of this principal.
static String	PARAMETER_PRINCIPAL_ID The CGI parameter or query request property for the principal ID.
static String	PARAMETER_PRINCIPAL_NAME The CGI parameter or query request property for the principal name.
static String	PARAMETER_REALM_ID The CGI parameter or query request property for the realm ID.
static String	PRIN_NAME_UNKNOWN The constant for the 'unknown' principal name.
protected String	principalId The principal ID.
protected String	principalName The principal name.
protected AttivioPrincipal.PrincipalType	principalType The principal type.
protected BaseTypesMap<String,Object>	properties Any additional properties.
protected String	realmId The security realm ID.
protected Set<AttivioRole>	roles Optional roles used by the Security Client API authorization.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttivioPrincipal() The default constructor.
	AttivioPrincipal(AttivioPrincipalKey principalKey, String principalName, AttivioPrincipal.PrincipalType principalType) Constructs an Attivio principal from a principal key, name, and type.
	AttivioPrincipal(String realmId, String principalId, String principalName, AttivioPrincipal.PrincipalType principalType) Creates an Attivio principal object from a realm ID, a principal ID, a principal name, and a principal type.

Method Summary

Modifier and Type	Method and Description
void	addGroupMembership(AttivioGroupMembership groupMembership) Adds a group membership to the set of this principal's group memberships.
void	addRole(AttivioRole role) Add a role to the principal.
AttivioPrincipal	clone()
int	compareTo(AttivioPrincipal other) {inheritDoc}
boolean	equals(Object obj) {inheritDoc}
static AttivioPrincipal	fromPrincipalString(String principalString) Creates an attivio principal from a principal string in the form of realmId:principalId:principalName
UUID	getCorrelationId() Get the correlation ID used to tie different instances of the same document sent in back to their original source.
Set<AttivioGroupMembership>	getGroupMemberships()
String	getName()
String	getPassword()
String	getPrincipalId()
AttivioPrincipalKey	getPrincipalKey()
String	getPrincipalName()
String	getPrincipalString()
AttivioPrincipal.PrincipalType	getPrincipalType()
BaseTypesMap<String,Object>	getProperties()
Object	getProperty(String propName)
String	getRealmId()
Set<AttivioRole>	getRoles()
Set<AttivioRole>	getRoles(Enum<?> enumRole) Return all AttivioRole objects that have the same name as the given Enum.
Set<AttivioRole>	getRoles(String roleName) Return all AttivioRole objects that have the given role name.
int	hashCode() {inheritDoc}
boolean	hasRole(Enum<?> enumRole) Equivalent to hasRule(enumRole, AttivioRole.SUBGROUP_ANY);
boolean	hasRole(Enum<?> enumRole, String subgroup)
boolean	hasRole(String role) Equivalent to hasRule(role , AttivioRole.SUBGROUP_ANY);
boolean	hasRole(String roleName, String subgroup)
boolean	isAnonymous()
static boolean	isAnonymous(AttivioPrincipalKey prinKey)
static boolean	isAnonymous(String realmId, String principalId)
boolean	isGroup()
boolean	isUser()
boolean	removeGroupMembership(AttivioGroupMembership groupMembership) Removes a group membership from the set of this principal's group memberships.
void	setCorrelationId(UUID correlationId) Set the correlation id
void	setGroupMemberships(Set<AttivioGroupMembership> groupMemberships) Sets the group memberships for this principal.
void	setPassword(String password) Set a password with this principal
void	setPrincipalId(String principalId) Sets the principal ID.
void	setPrincipalName(String principalName) Sets the principal name.
void	setPrincipalType(AttivioPrincipal.PrincipalType principalType) Set the principal type
void	setProperty(String propName, Object propValue) Sets a property on the principal.
void	setRealmId(String realmId) Sets the realm ID.
void	setRoles(Set<AttivioRole> roles) Set roles for this principal.
String	toString() {inheritDoc}

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Detail

PRIN_NAME_UNKNOWN

public static final String PRIN_NAME_UNKNOWN

The constant for the 'unknown' principal name.

See Also:

Constant Field Values

ANONYMOUS

public static final String ANONYMOUS

Constant to signify anonymous (realm or user).

See Also:

Constant Field Values

ANONYMOUS_USER

public static final AttivioPrincipal ANONYMOUS_USER

Represents the anonymous user (whose realm ID, principal ID, and principal name are ANONYMOUS).

ANONYMOUS_USER_GUID

public static final String ANONYMOUS_USER_GUID

The GUID of the anonymous user.

FIELD_REALM_ID

public static final String FIELD_REALM_ID

The name of the field that stores the security realm ID.

See Also:

Constant Field Values

FIELD_PRINCIPAL_ID

public static final String FIELD_PRINCIPAL_ID

The name of the field that stores the principal ID.

See Also:

Constant Field Values

FIELD_PRINCIPAL_NAME

public static final String FIELD_PRINCIPAL_NAME

The name of the field that stores the principal name.

See Also:

Constant Field Values

PARAMETER_REALM_ID

public static final String PARAMETER_REALM_ID

The CGI parameter or query request property for the realm ID.

See Also:

Constant Field Values

PARAMETER_PRINCIPAL_ID

public static final String PARAMETER_PRINCIPAL_ID

The CGI parameter or query request property for the principal ID.

See Also:

Constant Field Values

PARAMETER_PRINCIPAL_NAME

public static final String PARAMETER_PRINCIPAL_NAME

The CGI parameter or query request property for the principal name.

See Also:

Constant Field Values

realmId

protected String realmId

The security realm ID.

principalId

protected String principalId

The principal ID.

principalName

protected String principalName

The principal name.

principalType

protected AttivioPrincipal.PrincipalType principalType

The principal type.

roles

protected Set<AttivioRole> roles

Optional roles used by the Security Client API authorization.

groupMemberships

protected Set<AttivioGroupMembership> groupMemberships

Any group memberships of this principal.

correlationId

protected UUID correlationId

correlation id if set

properties

protected BaseTypesMap<String,Object> properties

Any additional properties.

Constructor Detail

AttivioPrincipal

protected AttivioPrincipal()

The default constructor.

AttivioPrincipal

public AttivioPrincipal(String realmId,
                        String principalId,
                        String principalName,
                        AttivioPrincipal.PrincipalType principalType)

Creates an Attivio principal object from a realm ID, a principal ID, a principal name, and a principal type.

Parameters:

realmId - the security realm ID; may not be null or empty

principalId - the principal ID; may not be null or empty

principalName - the principal name; may be null or empty

principalType - the principal type; may not be null or empty

AttivioPrincipal

public AttivioPrincipal(AttivioPrincipalKey principalKey,
                        String principalName,
                        AttivioPrincipal.PrincipalType principalType)

Constructs an Attivio principal from a principal key, name, and type.

Parameters:

principalKey - the principal key; may not be null

principalName - the principal name; may be null or empty

principalType - the principal type; may not be null or empty

Method Detail

setRealmId

public void setRealmId(String realmId)

Sets the realm ID.

Parameters:

realmId - the realm ID

getRealmId

public String getRealmId()

Returns:

the security realm ID

setPrincipalId

public void setPrincipalId(String principalId)

Sets the principal ID.

Parameters:

principalId - the principal ID

getPrincipalId

public String getPrincipalId()

Returns:

the principal ID

getPrincipalKey

public AttivioPrincipalKey getPrincipalKey()

Returns:

the principal key

getPrincipalString

public String getPrincipalString()

Returns:

string in the form of realmId:principalId:principalName

fromPrincipalString

public static AttivioPrincipal fromPrincipalString(String principalString)

Creates an attivio principal from a principal string in the form of realmId:principalId:principalName

Parameters:

principalString -

Returns:

the created principal

getName

public String getName()

Specified by:

getName in interface Principal

Returns:

the principal name; may be null or empty if not filled in

setPrincipalName

public void setPrincipalName(String principalName)

Sets the principal name.

Parameters:

principalName - the principal name

getPrincipalName

public String getPrincipalName()

Returns:

the principal name; may be null or empty if not filled in

getPrincipalType

public AttivioPrincipal.PrincipalType getPrincipalType()

Returns:

the principal type

setPrincipalType

public void setPrincipalType(AttivioPrincipal.PrincipalType principalType)

Set the principal type

Parameters:

principalType -

isAnonymous

public boolean isAnonymous()

Returns:

true if this principal represents the anonymous

isAnonymous

public static boolean isAnonymous(String realmId,
                                  String principalId)

Parameters:

realmId - the realm ID

principalId - the principal ID

Returns:

true if the principal denoted by the realm ID and the principal ID is anonymous

isAnonymous

public static boolean isAnonymous(AttivioPrincipalKey prinKey)

Parameters:

prinKey - the principal key

Returns:

true if the principal denoted by the given key is anonymous

isUser

public boolean isUser()

Returns:

true if the principal represents a user

isGroup

public boolean isGroup()

Returns:

true if the principal represents a group

getRoles

public Set<AttivioRole> getRoles()

Returns:

the roles

getRoles

public Set<AttivioRole> getRoles(String roleName)

Return all AttivioRole objects that have the given role name.

Parameters:

roleName - the role name to match

Returns:

the matching roles

hasRole

public boolean hasRole(String roleName,
                       String subgroup)

Parameters:

roleName - role name

subgroup - subgroup id,resource id, or AttivioRole.SUBGROUP_ANY

Returns:

true, if the principal has the given role/subgroup.

hasRole

public boolean hasRole(Enum<?> enumRole,
                       String subgroup)

Parameters:

enumRole - enum used for roles

subgroup - subgroup ID, resource ID, or AttivioRole.SUBGROUP_ANY

Returns:

true, if the principal has the given role/subgroup.

hasRole

public boolean hasRole(Enum<?> enumRole)

Equivalent to hasRule(enumRole, AttivioRole.SUBGROUP_ANY);

Parameters:

enumRole - enum used for roles

Returns:

true, if the principal has the given role

hasRole

public boolean hasRole(String role)

Equivalent to hasRule(role , AttivioRole.SUBGROUP_ANY);

Parameters:

role - role name

Returns:

true, if the principal has the given role

getRoles

public Set<AttivioRole> getRoles(Enum<?> enumRole)

Return all AttivioRole objects that have the same name as the given Enum.

Parameters:

enumRole - enum used for roles

Returns:

matching roles

addRole

public void addRole(AttivioRole role)

Add a role to the principal.

setRoles

public void setRoles(Set<AttivioRole> roles)

Set roles for this principal.

Parameters:

roles - the roles to set

getGroupMemberships

public Set<AttivioGroupMembership> getGroupMemberships()

Returns:

the group memberships for this principal

setGroupMemberships

public void setGroupMemberships(Set<AttivioGroupMembership> groupMemberships)

Sets the group memberships for this principal.

Parameters:

groupMemberships - the group memberships

addGroupMembership

public void addGroupMembership(AttivioGroupMembership groupMembership)

Adds a group membership to the set of this principal's group memberships.

Parameters:

groupMembership - the group membership to add

removeGroupMembership

public boolean removeGroupMembership(AttivioGroupMembership groupMembership)

Removes a group membership from the set of this principal's group memberships.

Parameters:

groupMembership - the group membership to remove

Returns:

true if the group membership was present and removed

getCorrelationId

public UUID getCorrelationId()

Get the correlation ID used to tie different instances of the same document sent in back to their original source.

Returns:

correlation id or null if not set

setCorrelationId

public void setCorrelationId(UUID correlationId)

Set the correlation id

Parameters:

correlationId -

setProperty

public void setProperty(String propName,
                        Object propValue)

Sets a property on the principal.

Parameters:

propName - the property name

propValue - the property value

setPassword

public void setPassword(String password)

Set a password with this principal

Parameters:

password -

getPassword

public String getPassword()

Returns:

null or a password if set on the principal

getProperty

public Object getProperty(String propName)

Parameters:

propName - the name of the property

Returns:

the property value

getProperties

public BaseTypesMap<String,Object> getProperties()

hashCode

public int hashCode()

{inheritDoc}

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

{inheritDoc}

Specified by:

equals in interface Principal

Overrides:

equals in class Object

toString

public String toString()

{inheritDoc}

Specified by:

toString in interface Principal

Overrides:

toString in class Object

compareTo

public int compareTo(AttivioPrincipal other)

{inheritDoc}

Specified by:

compareTo in interface Comparable<AttivioPrincipal>

clone

public AttivioPrincipal clone()

Overrides:

clone in class Object