com.sapportals.wcm.util.acl

Class UMPrincipalRaw

java.lang.Object
  com.sapportals.wcm.util.acl.UMPrincipalRaw

All Implemented Interfaces:

com.sapportals.portal.security.usermanagement.IGroup, com.sapportals.portal.security.usermanagement.IRole, com.sapportals.portal.security.usermanagement.IUMPrincipal, com.sapportals.portal.security.usermanagement.IUser, Serializable, Principal

public final class UMPrincipalRaw
extends Object
implements com.sapportals.portal.security.usermanagement.IUMPrincipal, com.sapportals.portal.security.usermanagement.IUser, com.sapportals.portal.security.usermanagement.IGroup, com.sapportals.portal.security.usermanagement.IRole

special implementation for a non existing user, tagged by IUMPrincipalRaw.

See Also:

Serialized Form

Nested Class Summary

static class

UMPrincipalRaw.TypeInfo

Field Summary

static UMPrincipalRaw.TypeInfo	PTI_GROUP
static UMPrincipalRaw.TypeInfo	PTI_ROLE
static UMPrincipalRaw.TypeInfo	PTI_UME
static UMPrincipalRaw.TypeInfo	PTI_USER

Fields inherited from interface com.sapportals.portal.security.usermanagement.IUser

ACCESSIBILITYLEVEL, ANONYMOUS, CITY, COMPANY, COUNTRY, CURRENCY, DATEFORMAT, DEFAULT_ACCESSIBILITY_LEVEL, DEPARTMENT, EMAIL, FAX, FIRSTNAME, LASTNAME, LOCALE, MOBILE, POBOX, POSITION, PREFERREDLANGUAGE, SALUTATION, STATE, STREETADDRESS, TELEPHONE, TIMEZONE, TITLE, ZIP

Fields inherited from interface com.sapportals.portal.security.usermanagement.IGroup

EVERYBODY

Fields inherited from interface com.sapportals.portal.security.usermanagement.IRole

ADMIN

Fields inherited from interface com.sapportals.portal.security.usermanagement.IUMPrincipal

DEFAULT_ROLE, DEFAULT_ROLE_DISPLAYNAME, DESCRIPTION, DISPLAYID, DISPLAYNAME, IGROUP, IROLE, IUMEPRINCIPAL, IUSER, USERMAPPING

Constructor Summary

UMPrincipalRaw(UMPrincipalRaw.TypeInfo pti, String id, boolean fakeIt)

Method Summary

boolean	containsGroup(String arg0)
boolean	containsUser(String arg0)
static com.sap.security.api.IPrincipal	ensureUMPrincipal(com.sap.security.api.IPrincipal principal) Ensure that the given IUMPrincipal objects comes from the Usermanagement
boolean	equals(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
boolean	equals(Object obj)
int	getAccessibilityLevel()
String[]	getAllChildGroups()
String[]	getAllChildUsers()
String[]	getAllGroups()
String[]	getAllParentGroups()
String[]	getAllUsers()
String[]	getChildGroups()
String	getCity()
String	getCompanyName()
String	getCountry()
String	getCurrency()
DateFormat	getDateFormat()
String	getDefaultNamespace()
String	getDefaultRole()
String	getDepartment()
String	getDescription()
String[]	getDirectChildGroups()
String[]	getDirectChildUsers()
String[]	getDirectGroups()
String[]	getDirectParentGroups()
String[]	getDirectRoles()
String[]	getDirectUsers()
String	getDisplayId()
String	getDisplayName()
String[]	getEmail()
String[]	getFax()
String	getFirstName()
String[]	getGroups()
String	getId()
static com.sap.security.api.IPrincipal	getInstance(String id, UMPrincipalRaw.TypeInfo pti)
String[]	getKeys()
String[]	getKeys(String arg)
String	getLastName()
Locale	getLocale()
com.sapportals.portal.security.usermanagement.ILogonDataBroker	getMappingInfo()
String[]	getMobile()
String	getName()
String[]	getNamespaces()
String[]	getParentGroups()
String	getPobox()
String	getPosition()
String	getPreferredLanguage()
HashMap	getRawUserMappingData(String s)
String[]	getRoleAttributes(String s)
String[]	getRoles()
String	getSalutation()
String	getState()
String	getStreetAddress()
String[]	getTelephone()
TimeZone	getTimeZoneObject()
String	getTitle()
Object	getTransientAttribute(String key)
Enumeration	getTransientAttributeNames()
int	getType()
static UMPrincipalRaw.TypeInfo	getTypeInfo(com.sap.security.api.IPrincipal principal)
static UMPrincipalRaw.TypeInfo	getTypeInfo(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
static UMPrincipalRaw.TypeInfo	getTypeInfoByDB(int dbtag)
static UMPrincipalRaw.TypeInfo	getTypeInfoByUM(int umType)
com.sap.security.api.IGroup	getUMEGroup()
String	getUMEId()
com.sap.security.api.IRole	getUMERole()
com.sap.security.api.IUser	getUMEUser()
static com.sap.security.api.IPrincipal	getUser(String userid)
String[]	getUsers()
String[]	getValuesForKey(String s)
String[]	getValuesForKey(String s, String s2)
String[]	getValuesForRoleAttribute(String s, String s1)
String	getZip()
int	hashCode()
boolean	isAdmin()
boolean	isAuthenticated()
boolean	isExternal()
boolean	isGroup()
boolean	isInGroup(String s)
boolean	isInRole(String arg0)
static boolean	isKnown(com.sap.security.api.IPrincipal principal)
void	refresh()
void	removeTransientAttribute(String key)
void	setTransientAttribute(String key, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

toString

Field Detail

PTI_USER

public static final UMPrincipalRaw.TypeInfo PTI_USER

PTI_GROUP

public static final UMPrincipalRaw.TypeInfo PTI_GROUP

PTI_ROLE

public static final UMPrincipalRaw.TypeInfo PTI_ROLE

PTI_UME

public static final UMPrincipalRaw.TypeInfo PTI_UME

Constructor Detail

UMPrincipalRaw

public UMPrincipalRaw(UMPrincipalRaw.TypeInfo pti,
                      String id,
                      boolean fakeIt)
               throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

Method Detail

isKnown

public static boolean isKnown(com.sap.security.api.IPrincipal principal)

getTypeInfo

public static UMPrincipalRaw.TypeInfo getTypeInfo(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)

getTypeInfo

public static UMPrincipalRaw.TypeInfo getTypeInfo(com.sap.security.api.IPrincipal principal)

getTypeInfoByUM

public static UMPrincipalRaw.TypeInfo getTypeInfoByUM(int umType)

getTypeInfoByDB

public static UMPrincipalRaw.TypeInfo getTypeInfoByDB(int dbtag)

getUser

public static com.sap.security.api.IPrincipal getUser(String userid)

getInstance

public static com.sap.security.api.IPrincipal getInstance(String id,
                                                          UMPrincipalRaw.TypeInfo pti)

ensureUMPrincipal

public static final com.sap.security.api.IPrincipal ensureUMPrincipal(com.sap.security.api.IPrincipal principal)

Ensure that the given IUMPrincipal objects comes from the Usermanagement

Parameters:

principal - ensure its UM existence

Returns:

principal with same ID as represented by Usermanagement

getDefaultRole

public String getDefaultRole()

Specified by:

getDefaultRole in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getRoles

public String[] getRoles()

Specified by:

getRoles in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getDirectRoles

public String[] getDirectRoles()

Specified by:

getDirectRoles in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getRoleAttributes

public String[] getRoleAttributes(String s)

Specified by:

getRoleAttributes in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getValuesForRoleAttribute

public String[] getValuesForRoleAttribute(String s,
                                          String s1)

Specified by:

getValuesForRoleAttribute in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getGroups

public String[] getGroups()

Specified by:

getGroups in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getValuesForKey

public String[] getValuesForKey(String s)

Specified by:

getValuesForKey in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getKeys

public String[] getKeys()

Specified by:

getKeys in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

refresh

public void refresh()

Specified by:

refresh in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

isInGroup

public boolean isInGroup(String s)

Specified by:

isInGroup in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

isGroup

public boolean isGroup()

Specified by:

isGroup in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getType

public int getType()

Specified by:

getType in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getId

public String getId()

Specified by:

getId in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

equals

public boolean equals(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)

Specified by:

equals in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getAllParentGroups

public String[] getAllParentGroups()

Specified by:

getAllParentGroups in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getDirectParentGroups

public String[] getDirectParentGroups()

Specified by:

getDirectParentGroups in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getRawUserMappingData

public HashMap getRawUserMappingData(String s)

Specified by:

getRawUserMappingData in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getDescription

public String getDescription()

Specified by:

getDescription in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getDisplayId

public String getDisplayId()

Specified by:

getDisplayId in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

getUMEId

public String getUMEId()

Specified by:

getUMEId in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.sapportals.portal.security.usermanagement.IUMPrincipal

Specified by:

equals in interface Principal

Overrides:

equals in class Object

containsGroup

public boolean containsGroup(String arg0)

Specified by:

containsGroup in interface com.sapportals.portal.security.usermanagement.IGroup

Specified by:

containsGroup in interface com.sapportals.portal.security.usermanagement.IRole

containsUser

public boolean containsUser(String arg0)

Specified by:

containsUser in interface com.sapportals.portal.security.usermanagement.IGroup

Specified by:

containsUser in interface com.sapportals.portal.security.usermanagement.IRole

getAllChildGroups

public String[] getAllChildGroups()

Specified by:

getAllChildGroups in interface com.sapportals.portal.security.usermanagement.IGroup

getAllChildUsers

public String[] getAllChildUsers()

Specified by:

getAllChildUsers in interface com.sapportals.portal.security.usermanagement.IGroup

getChildGroups

public String[] getChildGroups()

Specified by:

getChildGroups in interface com.sapportals.portal.security.usermanagement.IGroup

getDirectChildGroups

public String[] getDirectChildGroups()

Specified by:

getDirectChildGroups in interface com.sapportals.portal.security.usermanagement.IGroup

getDirectChildUsers

public String[] getDirectChildUsers()

Specified by:

getDirectChildUsers in interface com.sapportals.portal.security.usermanagement.IGroup

getParentGroups

public String[] getParentGroups()

Specified by:

getParentGroups in interface com.sapportals.portal.security.usermanagement.IGroup

getUMEGroup

public com.sap.security.api.IGroup getUMEGroup()

Specified by:

getUMEGroup in interface com.sapportals.portal.security.usermanagement.IGroup

getUsers

public String[] getUsers()

Specified by:

getUsers in interface com.sapportals.portal.security.usermanagement.IGroup

isInRole

public boolean isInRole(String arg0)

Specified by:

isInRole in interface com.sapportals.portal.security.usermanagement.IGroup

Specified by:

isInRole in interface com.sapportals.portal.security.usermanagement.IUser

getAllGroups

public String[] getAllGroups()

Specified by:

getAllGroups in interface com.sapportals.portal.security.usermanagement.IRole

getAllUsers

public String[] getAllUsers()

Specified by:

getAllUsers in interface com.sapportals.portal.security.usermanagement.IRole

getDirectGroups

public String[] getDirectGroups()

Specified by:

getDirectGroups in interface com.sapportals.portal.security.usermanagement.IRole

getDirectUsers

public String[] getDirectUsers()

Specified by:

getDirectUsers in interface com.sapportals.portal.security.usermanagement.IRole

getUMERole

public com.sap.security.api.IRole getUMERole()

Specified by:

getUMERole in interface com.sapportals.portal.security.usermanagement.IRole

getAccessibilityLevel

public int getAccessibilityLevel()

Specified by:

getAccessibilityLevel in interface com.sapportals.portal.security.usermanagement.IUser

getCity

public String getCity()

Specified by:

getCity in interface com.sapportals.portal.security.usermanagement.IUser

getCompanyName

public String getCompanyName()

Specified by:

getCompanyName in interface com.sapportals.portal.security.usermanagement.IUser

getCountry

public String getCountry()

Specified by:

getCountry in interface com.sapportals.portal.security.usermanagement.IUser

getCurrency

public String getCurrency()

Specified by:

getCurrency in interface com.sapportals.portal.security.usermanagement.IUser

getDateFormat

public DateFormat getDateFormat()

Specified by:

getDateFormat in interface com.sapportals.portal.security.usermanagement.IUser

getDefaultNamespace

public String getDefaultNamespace()

Specified by:

getDefaultNamespace in interface com.sapportals.portal.security.usermanagement.IUser

getDepartment

public String getDepartment()

Specified by:

getDepartment in interface com.sapportals.portal.security.usermanagement.IUser

getEmail

public String[] getEmail()

Specified by:

getEmail in interface com.sapportals.portal.security.usermanagement.IUser

getFax

public String[] getFax()

Specified by:

getFax in interface com.sapportals.portal.security.usermanagement.IUser

getFirstName

public String getFirstName()

Specified by:

getFirstName in interface com.sapportals.portal.security.usermanagement.IUser

getName

public String getName()

Specified by:

getName in interface Principal

getKeys

public String[] getKeys(String arg)

Specified by:

getKeys in interface com.sapportals.portal.security.usermanagement.IUser

getLastName

public String getLastName()

Specified by:

getLastName in interface com.sapportals.portal.security.usermanagement.IUser

getLocale

public Locale getLocale()

Specified by:

getLocale in interface com.sapportals.portal.security.usermanagement.IUser

getMappingInfo

public com.sapportals.portal.security.usermanagement.ILogonDataBroker getMappingInfo()

Specified by:

getMappingInfo in interface com.sapportals.portal.security.usermanagement.IUser

getMobile

public String[] getMobile()

Specified by:

getMobile in interface com.sapportals.portal.security.usermanagement.IUser

getNamespaces

public String[] getNamespaces()

Specified by:

getNamespaces in interface com.sapportals.portal.security.usermanagement.IUser

getPobox

public String getPobox()

Specified by:

getPobox in interface com.sapportals.portal.security.usermanagement.IUser

getPosition

public String getPosition()

Specified by:

getPosition in interface com.sapportals.portal.security.usermanagement.IUser

getPreferredLanguage

public String getPreferredLanguage()

Specified by:

getPreferredLanguage in interface com.sapportals.portal.security.usermanagement.IUser

getSalutation

public String getSalutation()

Specified by:

getSalutation in interface com.sapportals.portal.security.usermanagement.IUser

getState

public String getState()

Specified by:

getState in interface com.sapportals.portal.security.usermanagement.IUser

getStreetAddress

public String getStreetAddress()

Specified by:

getStreetAddress in interface com.sapportals.portal.security.usermanagement.IUser

getTelephone

public String[] getTelephone()

Specified by:

getTelephone in interface com.sapportals.portal.security.usermanagement.IUser

getTimeZoneObject

public TimeZone getTimeZoneObject()

Specified by:

getTimeZoneObject in interface com.sapportals.portal.security.usermanagement.IUser

getTransientAttribute

public Object getTransientAttribute(String key)

Specified by:

getTransientAttribute in interface com.sapportals.portal.security.usermanagement.IUser

getTitle

public String getTitle()

Specified by:

getTitle in interface com.sapportals.portal.security.usermanagement.IUser

getUMEUser

public com.sap.security.api.IUser getUMEUser()

Specified by:

getUMEUser in interface com.sapportals.portal.security.usermanagement.IUser

getZip

public String getZip()

Specified by:

getZip in interface com.sapportals.portal.security.usermanagement.IUser

getTransientAttributeNames

public Enumeration getTransientAttributeNames()

Specified by:

getTransientAttributeNames in interface com.sapportals.portal.security.usermanagement.IUser

getValuesForKey

public String[] getValuesForKey(String s,
                                String s2)

Specified by:

getValuesForKey in interface com.sapportals.portal.security.usermanagement.IUser

isAdmin

public boolean isAdmin()

Specified by:

isAdmin in interface com.sapportals.portal.security.usermanagement.IUser

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface com.sapportals.portal.security.usermanagement.IUser

isExternal

public boolean isExternal()

Specified by:

isExternal in interface com.sapportals.portal.security.usermanagement.IUser

removeTransientAttribute

public void removeTransientAttribute(String key)

Specified by:

removeTransientAttribute in interface com.sapportals.portal.security.usermanagement.IUser

setTransientAttribute

public void setTransientAttribute(String key,
                                  Object value)

Specified by:

setTransientAttribute in interface com.sapportals.portal.security.usermanagement.IUser

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM