openconnector

Interface ConnectorServices

public interface ConnectorServices

A ConnectorServices interface for the things we are currently doing with direct access to sailpoint packages. Every Connector gets an Application [sailpoint.connector] or ConnectorConfig [openconnector] and ConnectorServices implementation. The services provides access from sailpoint api and tools like running rules, database lockups etc.

Created by ketan.avalaskar.

Method Summary

Modifier and Type	Method and Description
OpenMessagePart	createEmptyMessage() Creates an empty message instance.
OpenMessagePart	createErrorMessage(java.lang.String key, java.lang.Object... args) Creates Message instance with given key and arguments.
OpenMessagePart	createInfoMessage(java.lang.String key, java.lang.Object... args) Creates Message instance with given key and arguments.
OpenMessagePart	createWarnMessage(java.lang.String key, java.lang.Object... args) Creates Message instance with given key and arguments.
java.lang.String	decrypt(java.lang.String src) Decrypt an encrypted string.
java.lang.Object	deepCopy(java.lang.Object obj) Perform a deep copy of the object.
default java.util.Map<java.lang.String,java.lang.Object>	getAttributes(java.lang.Class clazz, java.util.Map<java.lang.String,java.lang.Object> searchAttributes, java.util.List<java.lang.String> attributes) Returns the attribute-value key-pair from the requested SailPointObject.
default boolean	getFeatureFlagValue(java.lang.String name, boolean defaultValue) Extract value for featureFlag name provided.
java.lang.Object	getObject(java.lang.Class cls, java.lang.String name) Retrieve an object by name.
default boolean	getProductFlagValue(java.lang.String name, boolean defaultValue) Get value for requested product flag (Org feature).
java.lang.Object	runRule(java.lang.Object rule, java.util.Map<java.lang.String,java.lang.Object> ruleContext) Run a rule and return the result or null if there is no result.
java.lang.Object	runRule(java.lang.String ruleName, java.util.Map<java.lang.String,java.lang.Object> ruleContext) Deprecated. As of release 8.1, replaced by ConnectorServices.runRule(Object, Map)
void	saveObject(java.lang.Object obj) Save an entire object.
void	setApplicationAttribute(java.lang.String appName, java.lang.String atrName, java.lang.Object value) Save attribute in the Application.
void	setApplicationAttributes(java.lang.String appName, java.util.Map<java.lang.String,java.lang.Object> atrMap) Save attribute map in the Application.
default java.util.Map<java.lang.String,java.lang.Object>	syncCredentialsInApplication(java.util.Map<java.lang.String,java.lang.Object> configAttr) Sync latest credential from Vault to application.

Method Detail

runRule

java.lang.Object runRule(java.lang.Object rule,
                         java.util.Map<java.lang.String,java.lang.Object> ruleContext)
                  throws java.lang.Exception

Run a rule and return the result or null if there is no result.

Parameters:

rule - The Rule name text Or entire Rule object to run.

ruleContext - A name/value map of parameters to pass into the rule.

Returns:

The result of the execution of the Rule, or null if there is no result.

Throws:

java.lang.Exception

runRule

@Deprecated
java.lang.Object runRule(java.lang.String ruleName,
                                     java.util.Map<java.lang.String,java.lang.Object> ruleContext)
                              throws java.lang.Exception

Deprecated. As of release 8.1, replaced by ConnectorServices.runRule(Object, Map)

Run a rule and return the result or null if there is no result.

Parameters:

ruleName - The Rule name text Or entire Rule object to run.

ruleContext - A name/value map of parameters to pass into the rule.

Returns:

The result of the execution of the Rule, or null if there is no result.

Throws:

java.lang.Exception

getObject

java.lang.Object getObject(java.lang.Class cls,
                           java.lang.String name)
                    throws java.lang.Exception

Retrieve an object by name. Ideally instead of using this method, Connectors should use getAttributeValue() because usually it is particular attribute that Connectors are interested in instead of an entire Object. Not useful for openconnectors as it cannot have dependency on SailPointObjects.

Parameters:

cls - - Class that represents SailPointObject.

name - - Name of the object.

Returns:

- SailPointObject by given name.

Throws:

java.lang.Exception

saveObject

void saveObject(java.lang.Object obj)
         throws java.lang.Exception

Save an entire object.

This method is not useful in case application also works for IDN and CloudGateway, as we don't have access to the database and will not able to update the application. Hence the connector must be used only for IdentityIQ.

Parameters:

obj - - Object that needs to save.

Throws:

java.lang.Exception

getAttributes

default java.util.Map<java.lang.String,java.lang.Object> getAttributes(java.lang.Class clazz,
                                                                       java.util.Map<java.lang.String,java.lang.Object> searchAttributes,
                                                                       java.util.List<java.lang.String> attributes)
                                                                throws java.lang.Exception

Returns the attribute-value key-pair from the requested SailPointObject. The searchAttributes should always produce a "unique/ single" search result.

Note: In case zero or more than one results are produced, then it will be treated as erroneous condition.

Parameters:

clazz - Class object of the requested object

searchAttributes - Map of attributes to be used for search

attributes - List of attribute values requested

Returns:

Map of attributes and their respective values

Throws:

java.lang.Exception

setApplicationAttribute

void setApplicationAttribute(java.lang.String appName,
                             java.lang.String atrName,
                             java.lang.Object value)
                      throws java.lang.Exception

Save attribute in the Application.

Parameters:

appName - - Name of the application.

atrName - - Name of the attribute.

value - - Value of the attribute.

Throws:

java.lang.Exception

setApplicationAttributes

void setApplicationAttributes(java.lang.String appName,
                              java.util.Map<java.lang.String,java.lang.Object> atrMap)
                       throws java.lang.Exception

Save attribute map in the Application. Accept Map of attributes so that locking will happen only once.

Parameters:

appName - - Name of the application.

atrMap - - Mape of attributes.

Throws:

java.lang.Exception

decrypt

java.lang.String decrypt(java.lang.String src)
                  throws java.lang.Exception

Decrypt an encrypted string.

Parameters:

src - - Encrypted string.

Returns:

- Decrypted string.

Throws:

java.lang.Exception

deepCopy

java.lang.Object deepCopy(java.lang.Object obj)
                   throws java.lang.Exception

Perform a deep copy of the object. This differs from clone() which has historically done a shallow copy.

Parameters:

obj - Object to be copied/cloned

Returns:

copy/clone of the calling the object

Throws:

java.lang.Exception

getFeatureFlagValue

default boolean getFeatureFlagValue(java.lang.String name,
                                    boolean defaultValue)

Extract value for featureFlag name provided. Method implementation specific to IdentityNow.

Parameters:

name -

defaultValue -

Returns:

value for the given featureFlag.

getProductFlagValue

default boolean getProductFlagValue(java.lang.String name,
                                    boolean defaultValue)

Get value for requested product flag (Org feature). Method implementation specific to IdentityNow.

Parameters:

name -

defaultValue -

Returns:

value for the given product flag.

syncCredentialsInApplication

default java.util.Map<java.lang.String,java.lang.Object> syncCredentialsInApplication(java.util.Map<java.lang.String,java.lang.Object> configAttr)

Sync latest credential from Vault to application. Method implementation is specific to IdentityNow.

Parameters:

configAttr - Current application configuration attributes

createEmptyMessage

OpenMessagePart createEmptyMessage()

Creates an empty message instance.

createInfoMessage

OpenMessagePart createInfoMessage(java.lang.String key,
                                  java.lang.Object... args)

Creates Message instance with given key and arguments. Message key can be a valid key from a resource bundle, or plain text. Message type is defaulted to Type.Info.

Parameters:

key - ResourceBundle message key, or a plain text message.

args - Message format arguments.

createWarnMessage

OpenMessagePart createWarnMessage(java.lang.String key,
                                  java.lang.Object... args)

Creates Message instance with given key and arguments. Message key can be a valid key from a resource bundle, or plain text. Message type is defaulted to Type.Warn.

Parameters:

key - ResourceBundle message key, or a plain text message.

args - Message format arguments.

createErrorMessage

OpenMessagePart createErrorMessage(java.lang.String key,
                                   java.lang.Object... args)

Creates Message instance with given key and arguments. Message key can be a valid key from a resource bundle, or plain text. Message type is defaulted to Type.Error.

Parameters:

key - ResourceBundle message key, or a plain text message.

args - Message format arguments.