sailpoint.server

Interface IdnRuleUtil

public interface IdnRuleUtil

Utility class containing methods customers can use within a rules to perform common tasks. sailpoint.server.IdnRuleUtil is available in rules as "idn" variable, e.g. "idn.countAccounts("someAppId")". This utility class allows us to abstract out the use of SailPointContext in rules so that we can one day not pass a context to the rule at all.

Method Summary

Modifier and Type	Method and Description
boolean	accountExistsByDisplayName(java.lang.String applicationName, java.lang.String displayName) Determines if an account currently exists on an application using the display name.
boolean	accountExistsByNativeIdentity(java.lang.String applicationName, java.lang.String nativeIdentity) Determines if an account currently exists on an application using the native identity.
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.
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.
int	countAccounts(java.lang.String applicationName) Counts the number of accounts on an application.
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.
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
java.lang.String	getAccountAttribute(Account account, java.lang.String attribute) Gets the String value of an attribute from an account on an application.
java.lang.String	getAccountAttribute(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute) Gets the String value of an attribute from an account on an application.
boolean	getAccountAttributeBool(Account account, java.lang.String attribute) Gets the boolean value of an attribute from an account on an application.
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.
int	getAccountAttributeInt(Account account, java.lang.String attribute) Gets the int value of an attribute from an account on an application.
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.
Account	getAccountByDisplayName(java.lang.String applicationName, java.lang.String displayName) Gets an account on an application using the display name.
Account	getAccountByNativeIdentity(java.lang.String applicationName, java.lang.String nativeIdentity) Gets an account on an application using the native identity.
java.lang.String	getFirstAccountNativeIdentity(java.lang.String applicationName, java.lang.String identityName) Get the first account for the application and identityName and return the first accounts native sailpoint.object.Identity.
Identity	getIdentityById(java.lang.String id) Fetch an identity by the internal id.
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.
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.
java.lang.Object	getRawAccountAttribute(Account account, java.lang.String attribute) Gets the value of an attribute from an account on an application.
java.lang.Object	getRawAccountAttribute(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute) Gets the value of an attribute from an account on an application.
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.

Method Detail

accountExistsByNativeIdentity

boolean accountExistsByNativeIdentity(java.lang.String applicationName,
                                      java.lang.String nativeIdentity)
                               throws 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:

GeneralException - wrapping underlying DB related errors

accountExistsByDisplayName

boolean accountExistsByDisplayName(java.lang.String applicationName,
                                   java.lang.String displayName)
                            throws 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:

GeneralException - wrapping underlying DB related errors

getAccountByNativeIdentity

Account getAccountByNativeIdentity(java.lang.String applicationName,
                                   java.lang.String nativeIdentity)
                            throws 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:

GeneralException - wrapping underlying DB related errors

getAccountByDisplayName

Account getAccountByDisplayName(java.lang.String applicationName,
                                java.lang.String displayName)
                         throws 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:

GeneralException - wrapping underlying DB related errors

getFirstAccountNativeIdentity

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

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

Parameters:

applicationName - The name of the application

identityName - The name of the identity

Returns:

The first link's nativeIdentity

Throws:

GeneralException - wrapping underlying DB related errors

countAccounts

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

Counts the number of accounts on an application.

Parameters:

applicationName - The application name.

Returns:

The total number of accounts.

Throws:

GeneralException - wrapping underlying DB related errors

getRawAccountAttribute

java.lang.Object getRawAccountAttribute(java.lang.String applicationName,
                                        java.lang.String nativeIdentity,
                                        java.lang.String attribute)
                                 throws 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:

GeneralException - wrapping underlying DB related errors

getRawAccountAttribute

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

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.

Throws:

GeneralException

getAccountAttribute

java.lang.String getAccountAttribute(java.lang.String applicationName,
                                     java.lang.String nativeIdentity,
                                     java.lang.String attribute)
                              throws 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:

GeneralException - wrapping underlying DB related errors

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)
                         throws GeneralException

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:

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)
                     throws java.lang.IllegalStateException

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)
                                    throws java.lang.IllegalStateException

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 sailpoint.object.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)
                    throws GeneralException

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:

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)
                                         throws GeneralException

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:

GeneralException - wrapping underlying DB related errors

getManagedAttributeDetails

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

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:

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 sailpoint.object.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)
                                                              throws java.lang.IllegalStateException

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)
                                          throws java.lang.IllegalStateException

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.