com.ibm.itim.pim.authority
Interface SharedAccessAuthorizationStrategy

public interface SharedAccessAuthorizationStrategy

IBM Confidential OCO Source Materials (C) Copyright IBM Corp. 2012, 2015 All Rights Reserved. The source code for this program is not published or otherwise divested of its trade secrets, irrespective of what has been deposited with the U.S. Copyright Office.

Method Summary

java.util.Collection<CredentialComponent>	getAuthorizedSharedAccesses(PersonEntity personEntity, boolean isExcludeCheckedOutAccount, SharedAccessSearchFilter filter, SearchParameters searchParam, SearchResultsStatus searchStatus) Finds the authorized shared accesses for a given user.
boolean	isCheckoutAllowed(PersonEntity personEntity, CredentialComponent sharedAccess) Determines if the given user is authorized to check out a shared accesses.
boolean	isViewPasswordAllowed(PersonEntity personEntity, Credential credential) Determines if the given user is authorized to view the password of a shared accesses.

Method Detail

getAuthorizedSharedAccesses

java.util.Collection<CredentialComponent> getAuthorizedSharedAccesses(PersonEntity personEntity,
                                                                      boolean isExcludeCheckedOutAccount,
                                                                      SharedAccessSearchFilter filter,
                                                                      SearchParameters searchParam,
                                                                      SearchResultsStatus searchStatus)
                                                                      throws SharedAccessAuthorityException

Finds the authorized shared accesses for a given user.

Parameters:

personEntity - PersonEntity of an authenticated user.

isExcludeCheckedOutAccount - boolean indicating whether to exclude checked out accounts

filter - SharedAccessSearchFilter specifying the search attribute values. If the value is null, all authorized shared accesses are returned.

searchParam - SearchParameters specifying the search limit. Note: Other search parameters are ignored.

searchStatus - SearchResultsStatus holding the status of the search.

Returns:

The Collection of CredentialComponent object.

Throws:

SharedAccessAuthorityException - Thrown if an error occurs during the evaluation.

isCheckoutAllowed

boolean isCheckoutAllowed(PersonEntity personEntity,
                          CredentialComponent sharedAccess)
                          throws SharedAccessAuthorityException

Determines if the given user is authorized to check out a shared accesses.

Parameters:

personEntity - PersonEntity of an authenticated user.

sharedAccess - CredentialComponent representing a credential or a pool.

Returns:

true if the user is authorized to check out the specified shared access; false otherwise.

Throws:

SharedAccessAuthorityException - Thrown if an error occurs during the evaulation.

isViewPasswordAllowed

boolean isViewPasswordAllowed(PersonEntity personEntity,
                              Credential credential)
                              throws SharedAccessAuthorityException

Determines if the given user is authorized to view the password of a shared accesses.

Parameters:

personEntity - PersonEntity of an authenticated user.

credential - the credential.

Returns:

true if the user is authorized to view the password of the specified credential; false otherwise.

Throws:

SharedAccessAuthorityException - Thrown if an error occurs during the evaluation.