The org.jboss.portal.identity.User interface represents a user and exposes the following operations:

 /** The user identifier. */
 public Object getId();

 /** The user name. */
 public String getUserName();

 /** Set the password using proper encoding. */
 public void updatePassword(String password);

 /** Return true if the password is valid. */
 public boolean validatePassword(String password);
 

// Always use it like this:
user.getId().toString();

// Do not use it like this:

// We would get a Long object if we are using the database implementation
(Long)user.getId();

// We would get a String with an LDAP server
(String)user.getId();

The org.jboss.portal.identity.Role interface represents a Role and exposes the following operations:

/** The role identifier. */
public Object getId();

/** The role name used in security rules. This name can not be modified */
public String getName();

/** The role display name used on screens. This name can be modified */
public String getDisplayName();

/** */
public void setDisplayName(String name);

The org.jboss.portal.identity.UserModule interface exposes operations for users management:

/**Retrieve a user by its name.*/
User findUserByUserName(String userName)
   throws IdentityException, IllegalArgumentException, NoSuchUserException;

/**Retrieve a user by its id.*/
User findUserById(Object id)
   throws IdentityException, IllegalArgumentException, NoSuchUserException;

/**Retrieve a user by its id.*/
User findUserById(String id)
   throws IdentityException, IllegalArgumentException, NoSuchUserException;

/** Creates a new user with the specified name.*/
User createUser(String userName, String password)
   throws IdentityException, IllegalArgumentException;

/** Remove a user.*/
void removeUser(Object id)
   throws IdentityException, IllegalArgumentException;

/** Get a range of users.*/
Set findUsers(int offset, int limit)
   throws IdentityException, IllegalArgumentException;

/** Get a range of users.*/
Set findUsersFilteredByUserName(String filter, int offset, int limit)
   throws IdentityException, IllegalArgumentException;

/**Returns the number of users.*/
int getUserCount() throws IdentityException, IllegalArgumentException;

The org.jboss.portal.identity.RoleModule interface exposes operations for roles management:

/** Retrieves a role by its name*/
Role findRoleByName(String name)
   throws IdentityException, IllegalArgumentException;

/**Retrieve a collection of role from the role names.*/
Set findRolesByNames(String[] names)
   throws IdentityException, IllegalArgumentException;

/** Retrieves a role by its id.*/
Role findRoleById(Object id)
   throws IdentityException, IllegalArgumentException;

/** Retrieves a role by its id.*/
Role findRoleById(String id)
   throws IdentityException, IllegalArgumentException;

/** Create a new role with the specified name.*/
Role createRole(String name, String displayName)
   throws IdentityException, IllegalArgumentException;

/** Remove a role.*/
void removeRole(Object id)
   throws IdentityException, IllegalArgumentException;

/** Returns the number of roles. */
int getRolesCount()
   throws IdentityException;

/** Get all the roles */
Set findRoles()
   throws IdentityException;/** Retrieves a role by its name*/
Role findRoleByName(String name)
   throws IdentityException, IllegalArgumentException;

/**Retrieve a collection of role from the role names.*/
Set findRolesByNames(String[] names)
   throws IdentityException, IllegalArgumentException;

/** Retrieves a role by its id.*/
Role findRoleById(Object id)
   throws IdentityException, IllegalArgumentException;

/** Retrieves a role by its id.*/
Role findRoleById(String id)
   throws IdentityException, IllegalArgumentException;

/** Create a new role with the specified name.*/
Role createRole(String name, String displayName)
   throws IdentityException, IllegalArgumentException;

/** Remove a role.*/
void removeRole(Object id)
   throws IdentityException, IllegalArgumentException;

/** Returns the number of roles. */
int getRolesCount()
   throws IdentityException;

/** Get all the roles */
Set findRoles() throws IdentityException;

The MembershipModule interface exposes operations for obtaining or managing relationships beetween users and roles. The role of this service is to decouple relationship information from user and roles. Indeed while user role relationship is pretty straightforward with a relational database (using a many to many relationship with an intermediary table), with an LDAP server there a different ways to define relationships between users and roles.

/** Return the set of role objects that a given user has.*/
Set getRoles(User user) throws IdentityException, IllegalArgumentException;

Set getUsers(Role role) throws IdentityException, IllegalArgumentException;

/** Creates a relationship beetween a role and set of users. Other roles that have
    assotiontions with those users remain unaffected.*/
void assignUsers(Role role, Set users) throws IdentityException, IllegalArgumentException;

/** Creates a relationship beetween a user and set of roles. This operation will erase any
    other assotientions beetween the user and roles not specified in the provided set.*/
void assignRoles(User user, Set roles) throws IdentityException, IllegalArgumentException;

/** Returns role members based on rolename - depreciated method ethod here only
    for compatibility with old RoleModule interface */
Set findRoleMembers(String roleName, int offset, int limit, String userNameFilter)
   throws IdentityException, IllegalArgumentException;

The UserProfileModule interface exposes operations to access and manage informations stored in User profile:

public Object getProperty(User user, String propertyName)
   throws IdentityException, IllegalArgumentException;

public void setProperty(User user, String name, Object property)
   throws IdentityException, IllegalArgumentException;

public Map getProperties(User user)
   throws IdentityException, IllegalArgumentException;

public ProfileInfo getProfileInfo()
   throws IdentityException;

The ProfileInfo interface can be obtained using the UserProfileModule and exposes meta information of a profile:

/** Returns a Map o PropertyInfo objects describing profile properties */
public Map getPropertiesInfo();

public PropertyInfo getPropertyInfo(String name);

PropertyInfo interface expose methods to obtain information about accessible property in User profile

public static final String ACCESS_MODE_READ_ONLY = "read-only";
public static final String ACCESS_MODE_READ_WRITE = "read-write";
public static final String USAGE_MANDATORY = "mandatory";
public static final String USAGE_OPTIONAL = "optional";
public static final String MAPPING_DB_TYPE_COLUMN = "column";
public static final String MAPPING_DB_TYPE_DYNAMIC = "dynamic";

public String getName();

public String getType();

public String getAccessMode();

public String getUsage();

public LocalizedString getDisplayName();

public LocalizedString getDescription();

public String getMappingDBType();

public String getMappingLDAPValue();

public String getMappingDBValue();

public boolean isMappedDB();

public boolean isMappedLDAP();

RegisterMBeans - defines if IdentityServiceController should register components which are instantiated as mbeans

ConfigFile - defines the location of the main identity services configuration file. It describes and configures all the components like UserModule, RoleModule... that need to be instantiated

DefaultConfigFile - defines the location of the configuration file containing the default values. For each component defined in ConfigFile, the IdentityServiceController will obtain a set of default options from this file. That helps to keep the main main configuration file simple, short and easy to read. Potentially it provides more powerful customizations.