com.ibm.websphere.wim
Interface ProfileService
- All Superinterfaces:
- SchemaConstants
- All Known Subinterfaces:
- LocalService, Service, WIMService, WIMServiceLocal
- All Known Implementing Classes:
- LocalServiceProvider, ServiceProvider
public interface ProfileService
- extends SchemaConstants
The profile service interface.
Fields inherited from interface com.ibm.websphere.wim.SchemaConstants |
ASYNC_MODE, CACHE_MODE, CACHE_MODE_CLEAR_ENTITY, CACHE_MODE_CLEARALL, CHANGETYPE_ADD, CHANGETYPE_ALL, CHANGETYPE_DELETE, CHANGETYPE_MODIFY, CHANGETYPE_RENAME, COPYRIGHT_NOTICE, DATA_TYPE_ADDRESS_TYPE, DATA_TYPE_ANY_SIMPLE_TYPE, DATA_TYPE_ANY_URI, DATA_TYPE_BASE_64_BINARY, DATA_TYPE_BOOLEAN, DATA_TYPE_BYTE, DATA_TYPE_DATE, DATA_TYPE_DATE_TIME, DATA_TYPE_DOUBLE, DATA_TYPE_ENTITY_TYPE, DATA_TYPE_GROUP_TYPE, DATA_TYPE_IDENTIFIER_TYPE, DATA_TYPE_INT, DATA_TYPE_LANG_TYPE, DATA_TYPE_LONG, DATA_TYPE_PERSON_TYPE, DATA_TYPE_SHORT, DATA_TYPE_STRING, DATA_TYPE_TOKEN, DO_ACTION_NOT_ALLOW, DO_ANCESTOR_CONTROL, DO_CACHE_CONTROL, DO_CHANGE_CONTROL, DO_CHANGE_RESPONSE_CONTROL, DO_CHECK_GROUP_MEMBERSHIP_CONTROL, DO_CHECKPOINT, DO_CHECKPOINT_TYPE, DO_CHILDREN, DO_CONTEXT, DO_CONTEXT_PROPERTIES, DO_CONTEXTS, DO_CONTROLS, DO_DATATYPE_CONTROL, DO_DELETE_CONTROL, DO_DESCENDANT_CONTROL, DO_DOCUMENT_ROOT, DO_ENTITIES, DO_ENTITY, DO_ENTITY_CONFIGURATION, DO_ENTITY_SCHEMA, DO_ENTITY_TYPE_CONTROL, DO_EXTENSION_PROPERTIY_SCHEMA, DO_EXTENSION_PROPERTY_DATATYPE_CONTROL, DO_EXTENSION_PROPERTY_DEFINITION_CONTROL, DO_EXTENSION_PROPERTY_SCHEMA, DO_EXTERNAL_NAME_CONTROL, DO_GROUP, DO_GROUP_MEMBER_CONTROL, DO_GROUP_MEMBERSHIP_CONTROL, DO_GROUPS, DO_IDENTIFIER, DO_IDENTIFIER_TYPE, DO_LOGIN_ACCOUNT, DO_LOGIN_CONTROL, DO_MEMBERS, DO_META_DATA, DO_ORGCONTAINER, DO_PAGE_CONTROL, DO_PAGE_RESPONSE_CONTROL, DO_PARENT, DO_PERSON, DO_PERSON_ACCOUNT, DO_PRINCIPAL, DO_PROPERTIES, DO_PROPERTY_CONTROL, DO_PROPERTY_DATA_TYPES, DO_PROPERTY_DEFINITION_CONTROL, DO_PROPERTY_SCHEMA, DO_REPOSITORY_IDS, DO_REQUEST_CONTROL, DO_RESPONSE_CONTROL, DO_ROOT, DO_ROOT_TYPE, DO_SCHEMA, DO_SEARCH_CONTROL, DO_SEARCH_RESPONSE_CONTROL, DO_SORT_CONTROL, DO_SORT_KEY_TYPE, DO_SORT_KEYS, DO_VIEW_CONTROL, DO_VIEW_IDENTIFIER_TYPE, DO_VIEW_IDENTIFIERS, IS_REQUIRED, META_DATABASE_APPLICATION_ID, META_DATABASE_CASE_EXACT_MATCH, META_DATABASE_CLASSNAME, META_DATABASE_DESCRIPTION, META_DATABASE_IS_COMPOSITE, META_DATABASE_META_NAME, META_DATABASE_MULTI_VALUED, META_DATABASE_READ_ONLY, META_DATABASE_VALUE_LENGTH, META_LDAP_OBJECT_CLASS_FOR_CREATE, META_LDAP_OBJECT_CLASSES, META_LDAP_OBJECT_CLASSES_FOR_CREATE, META_LDAP_RDN_ATTRIBUTES, META_LDAP_SEARCH_BASES, META_LDAP_SEARCH_FILTER, META_REPOSITORY_DATA_TYPE, META_REPOSITORY_PROPERTY_NAME, PROP_ACTION_NAME, PROP_APPLICABLE_ENTITY_TYPE_NAMES, PROP_ASCENDING_ORDER, PROP_CERTIFICATE, PROP_CHANGETYPE, PROP_CHANGETYPES, PROP_COMPLETE, PROP_COOKIE, PROP_COUNT_LIMIT, PROP_CREATE_TIMESTAMP, PROP_DATA_TYPE, PROP_DEFAULT_PARENT, PROP_DELETE_DESCENDANTS, PROP_ENTITY_NAME, PROP_ENTITY_TYPE_NAME, PROP_ENTITY_TYPE_NAMES, PROP_EXTERNAL_ID, PROP_EXTERNAL_NAME, PROP_HAS_MORE_RESULTS, PROP_IN_GROUP, PROP_KEY, PROP_LANG, PROP_LEVEL, PROP_LEVEL_IMMEDIATE, PROP_LEVEL_NESTED, PROP_MAPPED_PROPERTIES, PROP_MODIFY_MODE, PROP_MODIFY_TIMESTAMP, PROP_MULTI_VALUED, PROP_NAME, PROP_NS_PREFIX, PROP_NS_URI, PROP_PARENT_ENTITY_NAME, PROP_PASSWORD, PROP_PRINCIPAL_NAME, PROP_PROPERTIES, PROP_PROPERTY_NAME, PROP_PROPERTY_NAMES, PROP_RDN_PROPERTY, PROP_REALM, PROP_REPOSITORY_CHECKPOINT, PROP_REPOSITORY_ID, PROP_REQUIRED_ENTITY_TYPE_NAMES, PROP_REQUIRED_INTERACTION_STYLE, PROP_RETURN_DELETED, PROP_RETURN_SUB_TYPE, PROP_SEARCH_BASES, PROP_SEARCH_EXPRESSION, PROP_SEARCH_LIMIT, PROP_SIZE, PROP_SORT_LOCALE, PROP_TICKET, PROP_TIME_LIMIT, PROP_TOTAL_SIZE, PROP_TREEVIEW, PROP_UNIQUE_ID, PROP_UNIQUE_NAME, PROP_VALIDATED, PROP_VALUE, PROP_VALUE_LENGTH, PROP_VALUES, PROP_VIEW_ENTRY_NAME, PROP_VIEW_ENTRY_UNIQUE_ID, PROP_VIEW_NAME, PROP_WMM_ADAPTER_CLASS_NAME, SYNC_MODE, SYNC_OR_ASYNC_MODE, TYPE_CONTEXT, TYPE_ENTITY, TYPE_GROUP, TYPE_IDENTIFIER, TYPE_LOGIN_ACCOUNT, TYPE_META_DATA, TYPE_ORG_CONTAINER, TYPE_PERSON, TYPE_PERSON_ACCOUNT, VALUE_ALL_PROPERTIES, VALUE_CONTEXT_REALM_KEY, VALUE_CONTEXT_TRUST_ENTITY_TYPE_KEY, VALUE_MODIFY_MODE_ASSIGN, VALUE_MODIFY_MODE_REPLACE, VALUE_MODIFY_MODE_UNASSIGN, VALUE_WILD_CARD, WIM_MODEL_PACKAGE, WIM_NS_PREFIX, WIM_NS_URI |
Method Summary |
commonj.sdo.DataObject |
create(commonj.sdo.DataObject root)
Creates the entity under the given root data object. |
commonj.sdo.DataObject |
delete(commonj.sdo.DataObject root)
Deletes the entity specified in the root data object. |
commonj.sdo.DataObject |
get(commonj.sdo.DataObject root)
Returns information of the specified entity or entities. |
commonj.sdo.DataObject |
login(commonj.sdo.DataObject root)
Authenticates the LoginAccount data object in the specified root data object. |
commonj.sdo.DataObject |
search(commonj.sdo.DataObject root)
Searches the profile repositories for entities matching the given search
expression and returns them with the requested properties. |
commonj.sdo.DataObject |
update(commonj.sdo.DataObject root)
Updates entity specified in the root data object. |
ASSIGN_MODE
static final int ASSIGN_MODE
- See Also:
- Constant Field Values
REPLACE_ASSIGN_MODE
static final int REPLACE_ASSIGN_MODE
- See Also:
- Constant Field Values
UNASSIGN_MODE
static final int UNASSIGN_MODE
- See Also:
- Constant Field Values
ALL_LEVELS
static final int ALL_LEVELS
- See Also:
- Constant Field Values
create
commonj.sdo.DataObject create(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Creates the entity under the given root data object.
This method is used for creating an entity. Empty root data object
can be obtained from createRootDataObject API. The entity needed to be created
can be added under the root data object along with the properties.
The output root data object of the create method contains the created entity data object
which contains its identifier.
- Parameters:
root
- The root data object which contains the entity to be created.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- The root data object which contains the created entity and its identifier.
get
commonj.sdo.DataObject get(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Returns information of the specified entity or entities.
The entity or entities to be retrieved are added under the root data object.
Controls can be added under the root data object to specify what kind of information is returned.
The entity or entities to be retrieved need to be added under the root data object with the identifiers specified.
By specifying different controls, different information can be returned.
For example, PropertyControl is used for returning the properties of the
entity/entities. GroupMembershipControl is used for returning groups the
entity/entities belongs to.
- Parameters:
root
- The root data object containing the request information.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- The root data object containing the requested information.
delete
commonj.sdo.DataObject delete(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Deletes the entity specified in the root data object. Only one entity can be delete at one time.
- Parameters:
root
- The root data object which contains the entity to delete.
The identifier of the entity should be specified.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- The root data object containing the deleted entity and its descendants
(if there are any), with their identifiers.
update
commonj.sdo.DataObject update(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Updates entity specified in the root data object.
There are two ways to update. The caller can create a empty root data object and specify
the changes needed. All the changes will replace the existing values. The caller can also
call get API method to get the values to be updated, make the changes, then send back to update.
- Parameters:
root
- The root data object containing entity with changes need to update.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- The root data object containing the updated entity with its identifier.
search
commonj.sdo.DataObject search(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Searches the profile repositories for entities matching the given search
expression and returns them with the requested properties.
The search method is used to search entities. Only the entities which match
the search expression will be returned.
The following four controls are
related to search: SearchControl, PageControl, SortControl,
PageResponseControl, and SortResponseControl. The SearchControl contains
the property name list which you want to return from the search operation.
For example, you want to get uid, cn for all the people whose sn equals to "Doe".
The search expression is also included in the SearchControl. If you want to
use the paged search function, the PageControl is needed.
- Parameters:
root
- the root data object containing the control(s) related to search.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- the root data object containing the entities matching the search expression.
login
commonj.sdo.DataObject login(commonj.sdo.DataObject root)
throws WIMException,
java.rmi.RemoteException
- Authenticates the LoginAccount data object in the specified root data object.
User can be authenticated either using loginId/password or using X509Certificate.
The successfully authenticated LoginAccount data object will be returned with requested properties
specified in the LoginControl.
- Parameters:
root
- the root data object containing the LoginAccount to authenticate.
- Throws:
WIMException
java.rmi.RemoteException
- Return:
- the root data object containing the LoginAccount which is successfully authenticated.