Field Detail

• STARTS_WITH_FILTER

  static final java.lang.String STARTS_WITH_FILTER

  See Also:

  Constant Field Values

• EQUALS_FILTER

  static final java.lang.String EQUALS_FILTER

  See Also:

  Constant Field Values

Method Detail

• accountExistsByNativeIdentity

  boolean accountExistsByNativeIdentity(java.lang.String applicationName,
                                        java.lang.String nativeIdentity)
                                 throws sailpoint.tools.GeneralException

  Determines if an account currently exists on an application using the native identity.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  Returns:

  True if the account exists, false otherwise.

  Throws:

  sailpoint.tools.GeneralException

• accountExistsByDisplayName

  boolean accountExistsByDisplayName(java.lang.String applicationName,
                                     java.lang.String displayName)
                              throws sailpoint.tools.GeneralException

  Determines if an account currently exists on an application using the display name.

  Parameters:

  applicationName - The application name.

  displayName - The display name of the account.

  Returns:

  True if the account exists, false otherwise.

  Throws:

  sailpoint.tools.GeneralException

• getAccountByNativeIdentity

  Account getAccountByNativeIdentity(java.lang.String applicationName,
                                     java.lang.String nativeIdentity)
                              throws sailpoint.tools.GeneralException

  Gets an account on an application using the native identity.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  Returns:

  The Account representing the account or null if not found. If more than one found then the first Account in the exists is returned.

  Throws:

  sailpoint.tools.GeneralException

• getAccountByDisplayName

  Account getAccountByDisplayName(java.lang.String applicationName,
                                  java.lang.String displayName)
                           throws sailpoint.tools.GeneralException

  Gets an account on an application using the display name.

  Parameters:

  applicationName - The application name.

  displayName - The display name of the account.

  Returns:

  The Account representing the account or null if not found. If more than one found then the first Account in the exists is returned.

  Throws:

  sailpoint.tools.GeneralException

• getAllAccounts

  java.util.List<Account> getAllAccounts(java.lang.String applicationName,
                                         java.lang.String identityName)
                                  throws sailpoint.tools.GeneralException

  Given the name of the application and the identity name return the list of Account objects found for the identity.

  Parameters:

  applicationName - The name of the application

  identityName - The name of the identity

  Returns:

  List of AccountObjects required

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getFirstAccount

  Account getFirstAccount(java.lang.String applicationName,
                          java.lang.String identityName)
                   throws sailpoint.tools.GeneralException

  Get the first account found for the application and identityName. IF there is more than one account the first account will be returned.

  Parameters:

  applicationName - The name of the application

  identityName - The name of the Identity

  Returns:

  The account object

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getFirstAccountNativeIdentity

  java.lang.String getFirstAccountNativeIdentity(java.lang.String applicationName,
                                                 java.lang.String identityName)
                                          throws sailpoint.tools.GeneralException

  Get the first account for the application and identityName and return the first accounts native Identity.

  Parameters:

  applicationName - The name of the application

  identityName - The name of the identity

  Returns:

  The first link's nativeIdentity

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getFirstAccountNativeIdentityByAttribute

  java.lang.String getFirstAccountNativeIdentityByAttribute(java.lang.String applicationName,
                                                            java.lang.String identityName,
                                                            java.lang.String attributeName,
                                                            java.lang.Object attributeValue)
                                                     throws sailpoint.tools.GeneralException

  Method that will find the first nativeIdentity based on the attributeName and attributeValue being passed in. This method will iterate over the list of Accounts associated to the Identity for the Source specified.

  Parameters:

  applicationName - The name of the application

  identityName - The name of the identity we are using

  attributeName - The name of the attribute we are to match

  attributeValue - The value of the attribute we are to match

  Returns:

  The first non-null AND non-empty nativeIdentity that matches the passed in identity, attributeName and attributeValue. When matching attributeValue if the values are both null they are equal, if the value is an empty string it'll be transformed to a null.

  Throws:

  sailpoint.tools.GeneralException

• findAccountsByAttribute

  java.util.List<Account> findAccountsByAttribute(java.lang.String applicationName,
                                                  java.lang.String identityName,
                                                  java.lang.String attributeName,
                                                  java.lang.Object attributeValue)
                                           throws sailpoint.tools.GeneralException

  Method that will return a list of accounts for the given Identity that matches the attributeName and values passed to the method.

  Parameters:

  applicationName - The name of the application

  identityName - The name of the identity we are using

  attributeName - The name of the attribute we are to match

  attributeValue - The value of the attribute we are to match get

  Returns:

  accounts that match the given identity, source, attribute and value, empty list if no accounts are found.

  Throws:

  sailpoint.tools.GeneralException

• countAccounts

  int countAccounts(java.lang.String applicationName)
             throws sailpoint.tools.GeneralException

  Counts the number of accounts on an application.

  Parameters:

  applicationName - The application name.

  Returns:

  The total number of accounts.

  Throws:

  sailpoint.tools.GeneralException

• getRawAccountAttribute

  java.lang.Object getRawAccountAttribute(java.lang.String applicationName,
                                          java.lang.String nativeIdentity,
                                          java.lang.String attribute)
                                   throws sailpoint.tools.GeneralException

  Gets the value of an attribute from an account on an application.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or null if the attribute does not exist.

  Throws:

  sailpoint.tools.GeneralException

• getRawAccountAttribute

  java.lang.Object getRawAccountAttribute(Account account,
                                          java.lang.String attribute)

  Gets the value of an attribute from an account on an application.

  Parameters:

  account - The account on the application.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or null if the attribute does not exist.

• getAccountAttribute

  java.lang.String getAccountAttribute(java.lang.String applicationName,
                                       java.lang.String nativeIdentity,
                                       java.lang.String attribute)
                                throws sailpoint.tools.GeneralException

  Gets the String value of an attribute from an account on an application.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or null if the attribute does not exist.

  Throws:

  sailpoint.tools.GeneralException

• getAccountAttribute

  java.lang.String getAccountAttribute(Account account,
                                       java.lang.String attribute)

  Gets the String value of an attribute from an account on an application.

  Parameters:

  account - The account on the application.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or null if the attribute does not exist.

• getAccountAttributeBool

  boolean getAccountAttributeBool(java.lang.String applicationName,
                                  java.lang.String nativeIdentity,
                                  java.lang.String attribute)

  Gets the boolean value of an attribute from an account on an application.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or false if the attribute does not exist.

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getAccountAttributeBool

  boolean getAccountAttributeBool(Account account,
                                  java.lang.String attribute)

  Gets the boolean value of an attribute from an account on an application.

  Parameters:

  account - The account on the application.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or false if the attribute does not exist.

• attrSearchCountAccounts

  int attrSearchCountAccounts(java.util.List<java.lang.String> sourceIds,
                              java.lang.String attributeName,
                              java.lang.String operation,
                              java.util.List<java.lang.String> values)

  Count the accounts that match the searchable attribute and value.

  Parameters:

  sourceIds - The list of Application ids that represent the sources of the data.

  attributeName - The name of the searchable account attribute. The name parameter is required.

  operation - The operation to use when matching, it'll either be Equals or StartsWith.

  values - The list of values of that searchable attribute to match. The values parameter is required.

  Returns:

  The number of accounts that match the parameters provided.

  Throws:

  java.lang.IllegalStateException - wrapping underlying errors

• attrSearchGetIdentityName

  java.lang.String attrSearchGetIdentityName(java.util.List<java.lang.String> sourceIds,
                                             java.lang.String attributeName,
                                             java.lang.String operation,
                                             java.util.List<java.lang.String> values)

  Get the identity name for the account matching the specified criteria.

  Parameters:

  sourceIds - The list of Application ids that represent the sources of the data

  attributeName - The name of the searchable account attribute. The name parameter is required.

  operation - The operation to use when matching, it'll either be Equals or StartsWith.

  values - The list of values of that searchable attribute to match. The values parameter is required.

  Returns:

  The name of the Identity that matched the account that match the parameters provided.

  Throws:

  java.lang.IllegalStateException - wrapping underlying errors

• getAccountAttributeInt

  int getAccountAttributeInt(java.lang.String applicationName,
                             java.lang.String nativeIdentity,
                             java.lang.String attribute)

  Gets the int value of an attribute from an account on an application.

  Parameters:

  applicationName - The application name.

  nativeIdentity - The native identity of the account.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or zero if the attribute does not exist.

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getAccountAttributeInt

  int getAccountAttributeInt(Account account,
                             java.lang.String attribute)

  Gets the int value of an attribute from an account on an application.

  Parameters:

  account - The account on the application.

  attribute - The name of the attribute to retrieve.

  Returns:

  The attribute value or zero if the attribute does not exist.

• getManagedAttributeDescription

  java.lang.String getManagedAttributeDescription(java.lang.String sourceId,
                                                  java.lang.String name,
                                                  java.lang.String value,
                                                  ManagedAttribute.Type type)

  Finds ManagedAttribute description by provided sourceId/name/value/type.

  Parameters:

  sourceId - The sourceId used to query the ManagedAttribute.

  name - The name of the attribute used to query the ManagedAttribute.

  value - The value of the attribute used to query the ManagedAttribute.

  type - The type of the attribute used to query the ManagedAttribute (see enum ManagedAttribute.Type). Defaults to Entitlement (if null provided).

  Returns:

  ManagedAttribute's description if found or else null.

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getManagedAttributeDetails

  ManagedAttributeDetails getManagedAttributeDetails(java.lang.String sourceId,
                                                     java.lang.String name,
                                                     java.lang.String value,
                                                     ManagedAttribute.Type type)

  Finds ManagedAttribute by sourceId/name/value/type and returns its details in ManagedAttributeDetails model.

  Parameters:

  sourceId - The sourceId used to query the ManagedAttribute.

  name - The name of the attribute used to query the ManagedAttribute.

  value - The value of the attribute used to query the ManagedAttribute.

  type - The type of the attribute used to query the ManagedAttribute (see enum ManagedAttribute.Type). Defaults to Entitlement (if null provided).

  Returns:

  ManagedAttributeDetails if found or else null.

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getIdentityById

  Identity getIdentityById(java.lang.String id)

  Fetch an identity by the internal id.

  Parameters:

  id - The id to use when fetching an identity object

  Returns:

  A DTO representing the Identity, will throw if identity was not found

• findIdentitiesBySearchableIdentityAttribute

  java.util.List<Identity> findIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName,
                                                                       java.lang.String operation,
                                                                       java.lang.String value,
                                                                       java.lang.String sortAttribute)

  Find and return the users that match the incoming attributeName, operation, value ordered by the specified sortAttribute

  Parameters:

  attributeName - The attribute that should be searched, must be searchable and non-null

  operation - The operation to be used when searching; only Equals and StartsWith are supported

  value - The value that should match and must be non-null

  sortAttribute - The attribute that should be used while sorting Default ordering will be on uid if not specified and this also must be searchable Sort will always be in ascending order

  Returns:

  The List of users that match the passed in parameters. The max number returned values will be limited to 50.

  Throws:

  java.lang.IllegalStateException - when attribute provided is not searchable, when operation is not StartsWith or Equals, the sortAttribute is not searahable, or if there are issues during the search

• countIdentitiesBySearchableIdentityAttribute

  int countIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName,
                                                   java.lang.String operation,
                                                   java.lang.String value)

  Count and return the number of users that match the incoming attributeName, operation and value.

  Parameters:

  attributeName - The attribute that should be searched, must be searchable and non-null

  operation - The operation to be used when searching; only Equals and StartsWith are supported

  value - The value that should match and must be non-null

  Returns:

  The number of identities that match the parameters

  Throws:

  java.lang.IllegalStateException - when attribute provided is not searchable, when operation is not StartsWith or Equals, or if there are issues during the count operation

• isUniqueLDAPValue

  boolean isUniqueLDAPValue(java.lang.String identityNameOrId,
                            java.lang.String applicationNameOrId,
                            java.lang.String attributeName,
                            java.lang.String attributeValue)

  A method that can be used to call LDAP type connectors to look for unique values. The connector is called with a specific search filter based on the attributeName and value that is passed into this method. If there is a value returned the values is considered to be non-unique.

  Parameters:

  identityNameOrId - The name or ID of the identity we are using

  applicationNameOrId - The name or ID of the source we are targeting

  attributeName - The name of the attribute we want to validate

  attributeValue - The value of the attribute we want to validate

  Returns:

  true if the value is unique AND false otherwise. If the application or identity can't be found an IllegalStateException will be thrown.

• getSourceAttributeBySourceId

  java.lang.String getSourceAttributeBySourceId(java.lang.String sourceId,
                                                java.lang.String attributeName)
                                         throws sailpoint.tools.GeneralException

  Get a single Source string attribute from an Application using the applicationId

  Parameters:

  sourceId - The id of the source

  attributeName - The name/key of the attribute to return

  Returns:

  The value if found in the attributes

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• getSourceAttributeBySourceName

  java.lang.String getSourceAttributeBySourceName(java.lang.String sourceName,
                                                  java.lang.String attributeName)
                                           throws sailpoint.tools.GeneralException

  Get a single Source string attribute from an Application using the applicationId

  Parameters:

  sourceName - (internal name i.e. application.getName() vs displayName of the application

  attributeName - The name/key of the attribute to return

  Returns:

  The value if found in the attributes

  Throws:

  sailpoint.tools.GeneralException - wrapping underlying DB related errors

• isUniqueAccountId

  boolean isUniqueAccountId(java.lang.String identityNameOrId,
                            java.lang.String applicationNameOrId,
                            java.lang.String accountId)

  A method that will call getObject() on the connector for the Account type and test if an account with the given accountId exists. If the account exists the method will return false, otherwise true.

  Parameters:

  identityNameOrId - The name or ID of the identity we are using

  applicationNameOrId - The name or ID of the source we are targeting

  accountId - The accountId we are trying to validate

  Returns:

  true if the account is unique, false otherwise