public interface IdnRuleUtil
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EQUALS_FILTER |
static java.lang.String |
STARTS_WITH_FILTER |
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<Account> |
findAccountsByAttribute(java.lang.String applicationName,
java.lang.String identityName,
java.lang.String attributeName,
java.lang.Object attributeValue)
Method that will return a list of accounts for the given Identity that matches the
attributeName and values passed to the method.
|
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.util.List<Account> |
getAllAccounts(java.lang.String applicationName,
java.lang.String identityName)
Given the name of the application and the identity name return the list of
Account objects found for the identity.
|
Account |
getFirstAccount(java.lang.String applicationName,
java.lang.String identityName)
Get the first account found for the application and identityName.
|
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 Identity.
|
java.lang.String |
getFirstAccountNativeIdentityByAttribute(java.lang.String applicationName,
java.lang.String identityName,
java.lang.String attributeName,
java.lang.Object attributeValue)
Method that will find the first nativeIdentity based on the attributeName and attributeValue
being passed in.
|
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.
|
java.lang.String |
getSourceAttributeBySourceId(java.lang.String sourceId,
java.lang.String attributeName)
Get a single Source string attribute from an Application using the applicationId
|
java.lang.String |
getSourceAttributeBySourceName(java.lang.String sourceName,
java.lang.String attributeName)
Get a single Source string attribute from an Application using the applicationId
|
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.
|
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.
|
static final java.lang.String STARTS_WITH_FILTER
static final java.lang.String EQUALS_FILTER
boolean accountExistsByNativeIdentity(java.lang.String applicationName, java.lang.String nativeIdentity) throws sailpoint.tools.GeneralException
applicationName
- The application name.nativeIdentity
- The native identity of the account.sailpoint.tools.GeneralException
boolean accountExistsByDisplayName(java.lang.String applicationName, java.lang.String displayName) throws sailpoint.tools.GeneralException
applicationName
- The application name.displayName
- The display name of the account.sailpoint.tools.GeneralException
Account getAccountByNativeIdentity(java.lang.String applicationName, java.lang.String nativeIdentity) throws sailpoint.tools.GeneralException
applicationName
- The application name.nativeIdentity
- The native identity of the account.sailpoint.tools.GeneralException
Account getAccountByDisplayName(java.lang.String applicationName, java.lang.String displayName) throws sailpoint.tools.GeneralException
applicationName
- The application name.displayName
- The display name of the account.sailpoint.tools.GeneralException
java.util.List<Account> getAllAccounts(java.lang.String applicationName, java.lang.String identityName) throws sailpoint.tools.GeneralException
applicationName
- The name of the applicationidentityName
- The name of the identitysailpoint.tools.GeneralException
- wrapping underlying DB related errorsAccount getFirstAccount(java.lang.String applicationName, java.lang.String identityName) throws sailpoint.tools.GeneralException
applicationName
- The name of the applicationidentityName
- The name of the Identitysailpoint.tools.GeneralException
- wrapping underlying DB related errorsjava.lang.String getFirstAccountNativeIdentity(java.lang.String applicationName, java.lang.String identityName) throws sailpoint.tools.GeneralException
applicationName
- The name of the applicationidentityName
- The name of the identitysailpoint.tools.GeneralException
- wrapping underlying DB related errorsjava.lang.String getFirstAccountNativeIdentityByAttribute(java.lang.String applicationName, java.lang.String identityName, java.lang.String attributeName, java.lang.Object attributeValue) throws sailpoint.tools.GeneralException
applicationName
- The name of the applicationidentityName
- The name of the identity we are usingattributeName
- The name of the attribute we are to matchattributeValue
- The value of the attribute we are to matchsailpoint.tools.GeneralException
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
applicationName
- The name of the applicationidentityName
- The name of the identity we are usingattributeName
- The name of the attribute we are to matchattributeValue
- The value of the attribute we are to match
getsailpoint.tools.GeneralException
int countAccounts(java.lang.String applicationName) throws sailpoint.tools.GeneralException
applicationName
- The application name.sailpoint.tools.GeneralException
java.lang.Object getRawAccountAttribute(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute) throws sailpoint.tools.GeneralException
applicationName
- The application name.nativeIdentity
- The native identity of the account.attribute
- The name of the attribute to retrieve.sailpoint.tools.GeneralException
java.lang.Object getRawAccountAttribute(Account account, java.lang.String attribute)
account
- The account on the application.attribute
- The name of the attribute to retrieve.java.lang.String getAccountAttribute(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute) throws sailpoint.tools.GeneralException
applicationName
- The application name.nativeIdentity
- The native identity of the account.attribute
- The name of the attribute to retrieve.sailpoint.tools.GeneralException
java.lang.String getAccountAttribute(Account account, java.lang.String attribute)
account
- The account on the application.attribute
- The name of the attribute to retrieve.boolean getAccountAttributeBool(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute)
applicationName
- The application name.nativeIdentity
- The native identity of the account.attribute
- The name of the attribute to retrieve.sailpoint.tools.GeneralException
- wrapping underlying DB related errorsboolean getAccountAttributeBool(Account account, java.lang.String attribute)
account
- The account on the application.attribute
- The name of the attribute to retrieve.int attrSearchCountAccounts(java.util.List<java.lang.String> sourceIds, java.lang.String attributeName, java.lang.String operation, java.util.List<java.lang.String> values)
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.java.lang.IllegalStateException
- wrapping underlying errorsjava.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)
sourceIds
- The list of Application ids that represent the sources of the dataattributeName
- 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.java.lang.IllegalStateException
- wrapping underlying errorsint getAccountAttributeInt(java.lang.String applicationName, java.lang.String nativeIdentity, java.lang.String attribute)
applicationName
- The application name.nativeIdentity
- The native identity of the account.attribute
- The name of the attribute to retrieve.sailpoint.tools.GeneralException
- wrapping underlying DB related errorsint getAccountAttributeInt(Account account, java.lang.String attribute)
account
- The account on the application.attribute
- The name of the attribute to retrieve.java.lang.String getManagedAttributeDescription(java.lang.String sourceId, java.lang.String name, java.lang.String value, ManagedAttribute.Type type)
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).sailpoint.tools.GeneralException
- wrapping underlying DB related errorsManagedAttributeDetails getManagedAttributeDetails(java.lang.String sourceId, java.lang.String name, java.lang.String value, ManagedAttribute.Type type)
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).sailpoint.tools.GeneralException
- wrapping underlying DB related errorsIdentity getIdentityById(java.lang.String id)
id
- The id to use when fetching an identity objectjava.util.List<Identity> findIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName, java.lang.String operation, java.lang.String value, java.lang.String sortAttribute)
attributeName
- The attribute that should be searched, must be searchable and non-nulloperation
- The operation to be used when searching; only Equals and StartsWith are supportedvalue
- The value that should match and must be non-nullsortAttribute
- 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 orderjava.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 searchint countIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName, java.lang.String operation, java.lang.String value)
attributeName
- The attribute that should be searched, must be searchable and non-nulloperation
- The operation to be used when searching; only Equals and StartsWith are supportedvalue
- The value that should match and must be non-nulljava.lang.IllegalStateException
- when attribute provided is not searchable,
when operation is not StartsWith or Equals,
or if there are issues during the count operationboolean isUniqueLDAPValue(java.lang.String identityNameOrId, java.lang.String applicationNameOrId, java.lang.String attributeName, java.lang.String attributeValue)
identityNameOrId
- The name or ID of the identity we are usingapplicationNameOrId
- The name or ID of the source we are targetingattributeName
- The name of the attribute we want to validateattributeValue
- The value of the attribute we want to validatejava.lang.String getSourceAttributeBySourceId(java.lang.String sourceId, java.lang.String attributeName) throws sailpoint.tools.GeneralException
sourceId
- The id of the sourceattributeName
- The name/key of the attribute to returnsailpoint.tools.GeneralException
- wrapping underlying DB related errorsjava.lang.String getSourceAttributeBySourceName(java.lang.String sourceName, java.lang.String attributeName) throws sailpoint.tools.GeneralException
sourceName
- (internal name i.e. application.getName() vs displayName of the applicationattributeName
- The name/key of the attribute to returnsailpoint.tools.GeneralException
- wrapping underlying DB related errorsboolean isUniqueAccountId(java.lang.String identityNameOrId, java.lang.String applicationNameOrId, java.lang.String accountId)
identityNameOrId
- The name or ID of the identity we are usingapplicationNameOrId
- The name or ID of the source we are targetingaccountId
- The accountId we are trying to validate