Package com.ibm.wsspi.security.wim

Interface CustomRepository

public interface CustomRepository

CustomRepository interface (com.ibm.wsspi.security.wim.CustomRepository) is used to implement the custom repository as a user feature.

  • The CustomRepository interface provides similar read capabilities that the UserRegistry interface provides UserRegistry , but additionally, it supports write capabilities such as create, delete, and update.
  • The CustomRepository interface also provides the ability to add customized attributes to both users and groups. Customized attributes are any attributes which the current schema does not already have pre-defined.

See Also:
  • UserRegistry

  • Method Details

    • getRepositoryBaseEntries

      Map<String,String> getRepositoryBaseEntries()

    • getRepositoriesForGroups

      String[] getRepositoriesForGroups()

    • get

      Root get(Root root) throws WIMException
      Returns information of the specified entities. The 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. This method is used for retrieving information of an entity or entities. The entities to retrieve need to add 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.
      Returns:
      The root data object containing the requested information.
      Throws:
      WIMException

    • search

      Root search(Root root) throws WIMException
      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. There are 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 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.
      Returns:
      the root data object containing the entities matching the search expression.
      Throws:
      WIMException

    • login

      Root login(Root root) throws WIMException
      Authenticates the account data object in the specified root data object. User can be authenticated either using loginId/password or using X509Certificate. The successfully authenticated account data object will be returned with requested properties.
      Parameters:
      root - the root data object containing the account to authenticate.
      Returns:
      the root data object containing the account which is successfully authenticated.
      Throws:
      WIMException

    • getRealm

      String getRealm()
      Returns the realm name
      Returns:

    • delete

      Root delete(Root root) throws WIMException
      Delete the entity specified in the root data object.
      Parameters:
      root - The root data object which contains the entity to delete. The identifier of the entity should be specified.
      Returns:
      The root data object containing the deleted entity and its descendants (if there are any), with their identifiers.
      Throws:
      WIMException

    • create

      Root create(Root root) throws WIMException
      Creates the entity under the given root data object. This method is used for creating an entity. Empty root data object can be got from getRootDataObject API. The entity needed to create 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.
      Returns:
      The root data object which contains the created entity and its identifier.
      Throws:
      WIMException

    • update

      Root update(Root root) throws WIMException
      Updates entity specified in the root data object. The caller can create an empty root data object and specify the changes needed. All the changes will replace the existing values.
      Parameters:
      root - The root data object containing entity with changes need to update.
      Returns:
      The root data object containing the updated entity with its identifier.
      Throws:
      WIMException