com.sssw.fw.usermgr.api
Interface EbiUserInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiUserInfo

extends EbiFrameworkElement

This provides an interface to the User Info object which contains user information from user registration (mainly for Internet users).

Field Summary

static String

EL_FW_USER User element type

Method Summary

String	getAttributeValue(EbiContext context, String attrname) Gets user attribute by specified attribute name
String	getAttributeValue(String attrName) Deprecated.
String[]	getAttributeValues(EbiContext context, String attrName) Gets user attribute values by a specified attribute name.
byte[]	getBlobAttributeContent(EbiContext context, String attrname) Gets a user blob attribute content.
String	getUserAuthenticatedRealmName() Gets User's authenticated realm name.
Collection	getUserBlobAttrInfoList() Deprecated. this method is not supported by the new jndi persistence provider
String	getUserEmailAddress() Gets User's email address.
Collection	getUserExtendedInfoList() Deprecated. this method is not supported by the new jndi persistence provider
String	getUserFirstName() Gets User's first name.
String	getUserID() Gets User Identifier.
String	getUserLastName() Gets User's last name.
String	getUserUUID() Gets User UUID.
void	removeAttributeValue(EbiContext context, String attrName) Remove user attribute.
void	removeAttributeValue(EbiContext context, String attrName, String attrvalue) Remove user attribute value that matches the specified value.
void	removeAttributeValue(String attrName) Deprecated.
void	removeAttributeValues(EbiContext context, String attrName) Remove all values for a specified user attribute.
void	removeBlobAttributeContent(EbiContext context, String attrname) Remove a user blob attribute content.
void	setAttributeValue(EbiContext context, String attrName, String attrValue) Sets user's attribute value.
void	setAttributeValue(EbiContext context, String attrName, String oldValue, String newValue) Sets an attribute value for a specified user attribute.
void	setAttributeValue(String attrName, String attrValue) Deprecated.
void	setAttributeValues(EbiContext context, String attrName, String[] values) Sets attribute values for a specified user attribute.
void	setBlobAttributeContent(EbiContext context, String attrname, byte[] content) Sets a user blob attribute content.
void	setUserAuthenticatedRealmName(String realmName) Sets User's authenticated realm name.
void	setUserEmailAddress(String emailAddress) Sets the user's email address.
void	setUserFirstName(String firstName) Sets the user's first name.
void	setUserID(String userID) Sets a user identifier.
void	setUserLastName(String lastName) Sets the user's last name.
void	setUserUUID(String IID) Set User UUID.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_FW_USER

public static final String EL_FW_USER

User element type

Method Detail

getUserUUID

public String getUserUUID()

Gets User UUID.

Returns:

the user UUID.

setUserUUID

public void setUserUUID(String IID)

Set User UUID.

Parameters:

user - UUID.

getUserID

public String getUserID()

Gets User Identifier.

Returns:

a User Identifier String.

setUserID

public void setUserID(String userID)

Sets a user identifier.

Parameters:

userID - a user id.

getUserFirstName

public String getUserFirstName()

Gets User's first name.

Returns:

user's first name.

setUserFirstName

public void setUserFirstName(String firstName)

Sets the user's first name.

Parameters:

firstName - user's first name.

getUserLastName

public String getUserLastName()

Gets User's last name.

Returns:

user's last name.

setUserLastName

public void setUserLastName(String lastName)

Sets the user's last name.

Parameters:

lastName - user's last name.

getUserEmailAddress

public String getUserEmailAddress()

Gets User's email address.

Returns:

user's email address.

setUserEmailAddress

public void setUserEmailAddress(String emailAddress)

Sets the user's email address.

Parameters:

emailAddress - user's email address.

getUserAuthenticatedRealmName

public String getUserAuthenticatedRealmName()

Gets User's authenticated realm name.

Returns:

user's authenticated realm name.

setUserAuthenticatedRealmName

public void setUserAuthenticatedRealmName(String realmName)

Sets User's authenticated realm name.

Parameters:

realmName - name of user's authenticated realm.

getAttributeValue

public String getAttributeValue(String attrName)

Deprecated.

Gets user attribute by a specified attribute name

Parameters:

attrName - the name of a specified user attribute.

Returns:

user's attribute value for the specified attribute.

getAttributeValue

public String getAttributeValue(EbiContext context,
                                String attrname)
                         throws EboUnrecoverableSystemException,
                                EboSecurityException

Gets user attribute by specified attribute name

Parameters:

context - an EbiContext object.

attrName - the name of a specified user attribute.

Returns:

user's attribute value for the specified attribute.

getAttributeValues

public String[] getAttributeValues(EbiContext context,
                                   String attrName)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Gets user attribute values by a specified attribute name. This method supports multi-valued attributes.

Parameters:

context - an EbiContext object.

attrName - the name of a specified user attribute.

Returns:

attribute values for the specified attribute.

setAttributeValue

public void setAttributeValue(String attrName,
                              String attrValue)

Deprecated.

Sets user's attribute value.

Parameters:

attrName - the name of a specified user attribute.

attrValue - the value of the specified attribute.

setAttributeValue

public void setAttributeValue(EbiContext context,
                              String attrName,
                              String attrValue)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Sets user's attribute value.

Make sure that a user uuid is already generated for this instance. If not, you need to call setUserUUID(null), which will generate a user uuid for you. Or, if you want to provide an uuid for this instance, you may call setUserUUID(uuid).

Parameters:

context - an EbiContext object.

attrName - the name of a specified user attribute.

attrValue - the value of the specified attribute.

setAttributeValue

public void setAttributeValue(EbiContext context,
                              String attrName,
                              String oldValue,
                              String newValue)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Sets an attribute value for a specified user attribute.

Parameters:

context - an EbiContext object.

attrName - the name of a specified user attribute.

oldValue - the old value to be replaced.

newValue - the new value.

setAttributeValues

public void setAttributeValues(EbiContext context,
                               String attrName,
                               String[] values)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Sets attribute values for a specified user attribute.

Parameters:

context - an EbiContext object.

attrName - the name of a specified user attribute.

values - new values that replace the old ones.

removeAttributeValue

public void removeAttributeValue(String attrName)

Deprecated.

Remove user attribute.

Parameters:

attrName - the name of the attribute that needs to be removed.

removeAttributeValue

public void removeAttributeValue(EbiContext context,
                                 String attrName)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Remove user attribute. For multi-valued attributes, this method removes the first value in the list.

Parameters:

context - an EbiContext object

attrName - the name of the attribute that needs to be removed.

removeAttributeValue

public void removeAttributeValue(EbiContext context,
                                 String attrName,
                                 String attrvalue)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Remove user attribute value that matches the specified value.

Parameters:

context - an EbiContext object

attrName - the name of the attribute that needs to be removed.

attrValue - the value specified needs to be removed

removeAttributeValues

public void removeAttributeValues(EbiContext context,
                                  String attrName)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Remove all values for a specified user attribute.

Parameters:

context - an EbiContext object

attrName - the name of the attribute that needs to be removed.

getBlobAttributeContent

public byte[] getBlobAttributeContent(EbiContext context,
                                      String attrname)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a user blob attribute content.

Parameters:

context - an EbiContext object.

attrname - a blob attribute name.

Returns:

content for the specified user blob attribute.

setBlobAttributeContent

public void setBlobAttributeContent(EbiContext context,
                                    String attrname,
                                    byte[] content)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Sets a user blob attribute content.

Make sure that a user uuid is already generated for this instance. If not, you need to call setUserUUID(null), which will generate a user uuid for you. Or, if you want to provide an uuid for this instance, you may call setUserUUID(uuid).

Parameters:

attrname - a user blob attribute name.

content - the content of the blob attribute.

Returns:

true if the content for the blob attribute is stored successfully, false otherwise.

removeBlobAttributeContent

public void removeBlobAttributeContent(EbiContext context,
                                       String attrname)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Remove a user blob attribute content.

Parameters:

attrname - the name of the attribute that needs to be removed.

getUserExtendedInfoList

public Collection getUserExtendedInfoList()

Deprecated.

this method is not supported by the new jndi persistence provider

Get the user extended attributes list.

Returns:

an array of EbiUserExtInfo objects.

getUserBlobAttrInfoList

public Collection getUserBlobAttrInfoList()

Deprecated.

this method is not supported by the new jndi persistence provider

Get the user blob attribute list.

Returns:

an array of EbiUserBlobAttrInfo objects.