com.sapportals.wcm.util.channels
Class RecipientFactory

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.factories.AbstractObjectFactory
        |
        +--com.sapportals.wcm.util.channels.RecipientFactory

public class RecipientFactory

extends AbstractObjectFactory

A factory to retrieve IRecipient s.

See Also:

IRecipient

Inner classes inherited from class com.sapportals.wcm.util.factories.AbstractObjectFactory

AbstractObjectFactory.ObjectClassEntry

Fields inherited from class com.sapportals.wcm.util.factories.AbstractObjectFactory

CONFIG_OBJECTLIST_SEPARATOR, CONFIG_OBJECTLIST_TAG, CONFIG_SINGLETON_DEFAULT, CONFIG_SINGLETON_TAG, m_ID, m_LogName, m_ObjectMap, m_Properties, MULTI, SINGLETON

Constructor Summary

RecipientFactory(java.lang.String id)
Create a RecipientFactory with a given id.
Note : This constructor has to be public (although it should be protected), to allow dynamic creation via AbstractClassFactory() .

Method Summary

IRecipientList	createRecipientList() Create an empty IRecipientList .
static RecipientFactory	getInstance() Get an instance of the RecipientFactory .
IRecipient	getRecipient(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Get an IRecipient for the given user-management object.
IRecipient	getRecipient(java.lang.String id, int type) Get a IRecipient for the given id and type.

Methods inherited from class com.sapportals.wcm.util.factories.AbstractObjectFactory

getAllObjectInstances, getFactoryInstance, getObjectConstructorParameters, getObjectConstructorParameterTypes, getObjectInstance, loadObjectMap, loadObjectMap, newObjectListEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

RecipientFactory

public RecipientFactory(java.lang.String id)
                 throws WcmException

Create a RecipientFactory with a given id.
Note : This constructor has to be public (although it should be protected), to allow dynamic creation via AbstractClassFactory() .

Parameters:

id - a String with the unique id for the factory.

Throws:

WcmException - Exception raised in failure situation

Method Detail

getInstance

public static RecipientFactory getInstance()
                                    throws WcmException

Get an instance of the RecipientFactory .

Returns:

an instance of the RecipientFactory .

Throws:

WcmException - if no factory instance is available.

getRecipient

public IRecipient getRecipient(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
                        throws WcmException

Get an IRecipient for the given user-management object.

Parameters:

principal - a IUMPrincipal with user-management object (an IUser , IGroup or IRole ).

Returns:

an IRecipient for the given user-management object, null if the recipient does not exist.

Throws:

WcmException - if the recipient could not be retrieved.

getRecipient

public IRecipient getRecipient(java.lang.String id,
                               int type)
                        throws WcmException

Get a IRecipient for the given id and type.

Parameters:

id - a String with the IRecipient 's system id.

type - an int with the type of the recipient (IUSER , IGROUP or IROLE , see com.sap.wp.security.IUMPrincipal ).

Returns:

an IRecipient for the given id and type, null if the recipient does not exist.

Throws:

WcmException - if the recipient could not be retrieved.

createRecipientList

public IRecipientList createRecipientList()
                                   throws WcmException

Create an empty IRecipientList .

Returns:

an empty IRecipientList .

Throws:

WcmException - if the list could not be created.