Package lumis.portal.principal

Class PrincipalConfig

java.lang.Object

lumis.portal.principal.PrincipalConfig

All Implemented Interfaces:

java.lang.Cloneable, java.security.Principal, ICacheEntry, ICloneableCacheEntry

Direct Known Subclasses:

PrincipalDataType.Data

@StableMinor(version="17.0",
             sinceVersion="4.0")
public class PrincipalConfig
extends java.lang.Object
implements ICloneableCacheEntry, java.security.Principal

A portal principal object. May represent an user or a group.

Since:

4.0.0

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static int	TYPE_GROUP
static int	TYPE_USER
static int	TYPE_USER_SEGMENTATION	The user segmentation principal type.

Constructor Summary

Constructors

Constructor	Description
PrincipalConfig(java.lang.String id, java.lang.String shortId, java.lang.String name, int type, int subType, java.lang.String channelId)
PrincipalConfig(GroupConfig groupConfig)
PrincipalConfig(UserConfig userConfig)

Method Summary

Modifier and Type	Method	Description
PrincipalConfig	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getChannelId()
java.lang.String	getId()
java.lang.String	getName()
java.lang.String	getProfileImageHref()	Get principal profile image href.
java.lang.String	getShortId()
int	getSubType()
int	getType()
int	hashCode()
void	setChannelId(java.lang.String channelId)
void	setName(java.lang.String name)
void	setShortId(java.lang.String shortId)
void	setSubType(int subType)
void	setType(int type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Detail

TYPE_USER

public static final int TYPE_USER

See Also:

Constant Field Values

TYPE_GROUP

public static final int TYPE_GROUP

See Also:

Constant Field Values

TYPE_USER_SEGMENTATION

public static final int TYPE_USER_SEGMENTATION

The user segmentation principal type.

Since:

11.2.0

See Also:

Constant Field Values

Constructor Detail

PrincipalConfig

public PrincipalConfig(java.lang.String id,
                       java.lang.String shortId,
                       java.lang.String name,
                       int type,
                       int subType,
                       java.lang.String channelId)

PrincipalConfig

public PrincipalConfig(UserConfig userConfig)

PrincipalConfig

public PrincipalConfig(GroupConfig groupConfig)

Method Detail

getId

public java.lang.String getId()

Returns:

Returns the id.

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

getShortId

public java.lang.String getShortId()

Returns:

Returns the shortId.

setShortId

public void setShortId(java.lang.String shortId)

getSubType

public int getSubType()

Parameters:

sybType - The sybType to set.

setSubType

public void setSubType(int subType)

getType

public int getType()

Parameters:

type - The type to set.

setType

public void setType(int type)

getChannelId

public java.lang.String getChannelId()

Returns:

Returns the channelId.

setChannelId

public void setChannelId(java.lang.String channelId)

clone

public PrincipalConfig clone()
                      throws java.lang.CloneNotSupportedException

Specified by:

clone in interface ICloneableCacheEntry

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

hashCode

public int hashCode()

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

getProfileImageHref

public java.lang.String getProfileImageHref()

Get principal profile image href.

Returns:

this principal profile image href.

Since:

8.0.0