com.sapportals.wcm.service.urlgenerator

Interface IUserManagementRidGenerator

public interface IUserManagementRidGenerator

Generic interface for the generation of user management specific RIDs.

Copyright (c) SAP AG 2002-2004

Field Summary

static String	MT_PHOTO
static String	MT_RDF
static String	MT_VCARD

Method Summary

com.sapportals.wcm.util.uri.RID	getGroupResourceRid(String groupId)
com.sapportals.wcm.util.uri.IRidSet	getPrincipalCollectionRidSet()
com.sapportals.wcm.util.uri.RID	getPrincipalResourceRid(String principalId) Returns the RID of the specified principal.
com.sapportals.wcm.util.uri.RID	getRoleResourceRid(String roleId)
com.sapportals.wcm.util.uri.RID	getUserResourceRid(String userId)
com.sapportals.wcm.util.uri.RID	getUserResourceRid(String userId, String mimetype)

Field Detail

MT_PHOTO

static final String MT_PHOTO

See Also:

Constant Field Values

MT_RDF

static final String MT_RDF

See Also:

Constant Field Values

MT_VCARD

static final String MT_VCARD

See Also:

Constant Field Values

Method Detail

getPrincipalResourceRid

com.sapportals.wcm.util.uri.RID getPrincipalResourceRid(String principalId)

Returns the RID of the specified principal. This method is only useful when using the new usermanagement. The old usermanagement should always return null .

Parameters:

principalId - id of the principal

Returns:

RID for resource representing the principal

getGroupResourceRid

com.sapportals.wcm.util.uri.RID getGroupResourceRid(String groupId)

Parameters:

groupId - id of the group

Returns:

RID for resource representing the group

getPrincipalCollectionRidSet

com.sapportals.wcm.util.uri.IRidSet getPrincipalCollectionRidSet()

Returns:

set of all collections representing principals (users, groups and roles)

getRoleResourceRid

com.sapportals.wcm.util.uri.RID getRoleResourceRid(String roleId)

Parameters:

roleId - id of the role

Returns:

RID for resource representing the role

getUserResourceRid

com.sapportals.wcm.util.uri.RID getUserResourceRid(String userId)

Parameters:

userId - id of the user

Returns:

RID for resource representing the user

getUserResourceRid

com.sapportals.wcm.util.uri.RID getUserResourceRid(String userId,
                                                   String mimetype)
                                                   throws ResourceException

Parameters:

userId - id of the user

mimetype - MIME type of requested user data

Returns:

RID for resource representing the user in the given mime type

Throws:

ResourceException - when mime type not available

Access Rights

This class can be accessed from:

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