【问题标题】:Openidm - Access source or target values in connector groovy scriptOpenidm - 在连接器 groovy 脚本中访问源值或目标值
【发布时间】:2015-03-20 14:07:46
【问题描述】:

我目前正在构建自己的 Openidm 连接器,以使用基于 ScriptedRest2DJ 示例的 Groovy 框架连接器来配置外部系统。

我正在实现 searchScript.groovy 文件以在目标系统上搜索资源(用户),并且我想在我的请求中传递源系统的当前用户 UID。

这里是 SearchScript.groovy 源代码:

import groovyx.net.http.RESTClient
import org.apache.http.client.HttpClient
import org.forgerock.openicf.connectors.scriptedrest.ScriptedRESTConfiguration
import org.forgerock.openicf.misc.scriptedcommon.OperationType
import org.identityconnectors.common.logging.Log
import org.identityconnectors.framework.common.objects.Attribute
import org.identityconnectors.framework.common.objects.AttributeUtil
import org.identityconnectors.framework.common.objects.Name
import org.identityconnectors.framework.common.objects.ObjectClass
import org.identityconnectors.framework.common.objects.OperationOptions
import org.identityconnectors.framework.common.objects.SearchResult
import org.identityconnectors.framework.common.objects.Uid
import org.identityconnectors.framework.common.objects.filter.Filter
import org.identityconnectors.framework.common.objects.AttributesAccessor

import static groovyx.net.http.Method.GET
import static groovyx.net.http.ContentType.JSON;

// imports used for CREST based REST APIs
import org.forgerock.openicf.misc.crest.CRESTFilterVisitor
import org.forgerock.openicf.misc.crest.VisitorParameter

def operation = operation as OperationType
def configuration = configuration as ScriptedRESTConfiguration
def httpClient = connection as HttpClient
def connection = customizedConnection as RESTClient
def filter = filter as Filter
def log = log as Log
def objectClass = objectClass as ObjectClass
def options = options as OperationOptions
def resultHandler = handler

log.info("Entering " + operation + " Script")

switch (objectClass) {
    case ObjectClass.ACCOUNT:
        // Search for a specific user in Alfresco
        // http://docs.alfresco.com/community/references/RESTful-PersonPersonGet.html
        def searchResult = connection.request(GET, JSON) { req ->
            uri.path = 'people'

            headers.Accept = 'application/json'

            response.success = { resp, json ->
                json.people.each() { value ->
                    resultHandler {
                        uid value.userName
                        id value.userName
                        attribute 'email', value?.email
                        attribute 'lastName', value?.lastName
                        attribute 'userName', value?.userName
                        attribute 'firstName', value?.firstName
                        attribute 'enabled', value?.enabled
                        //attribute ('groups', *(value?.groups))
                    }
                }
                json
            }
        }

        return new SearchResult(null, -1) // no remaining results
}

您如何访问脚本中的源值?我已经测试了 Uid、Id、Name、... 没有成功。

感谢您的帮助

【问题讨论】:

  • 您是否尝试访问请求中指定的 id 值(即 system/scriptedrest/account/${id}),或者您是否尝试返回从 REST 调用中读取的 id到远程系统?
  • 在启动数据协调(手动或自动)时,我的连接器会直接调用 SearchScript。我不使用 REST API 启动此脚本,因此我对这些参数一无所知,但是是的,我想检索源帐户的名称/ID 值,而不是在目标系统上。
  • 您能否使用当前 SearchScript.groovy 代码的示例部分更新您的帖子,尤其是进行 REST 调用和处理响应的部分?
  • 我刚刚发布了正在运行的源代码,但它会从 Alfresco CMS 中检索所有用户。这是正确的做法吗?

标签: groovy openidm


【解决方案1】:

为了让您的 SearchScript 不仅仅返回所有用户,您需要使用“过滤器”对象。您在脚本中声明了它,但您没有使用它 - 这是具有连接器需要知道该脚本应该在后端执行哪种“搜索”的所有详细信息的对象(通过 REST 在此案子)。过滤器对象本质上是树结构,它们的预期用途基于“Visitor Pattern”。

您的代码所基于的 scriptedrest2dj 示例显示了 CRESTFilterVisitor 的使用,它是一种特殊的方法,对于使用 OpenDJ(该示例的目标)特别有用。对于更通用的访问者实现,我建议查看 sample3 的 SearchScript.groovy。 Sample3 是使用 SQL 后端的示例,但那里显示的访问者可用于生成任何类型的查询字符串(例如您可能传递给 REST 服务的查询字符串)。

从 sample3 的过滤器代码中,这将返回代表过滤器树的值的常规映射:

def query = filter.accept(MapFilterVisitor.INSTANCE, null)

这是简单值的映射结构(例如,字段 eq “值”):

[ 
    "operation": "EQUALS|CONTAINS|STARTSWITH|ENDSWITH",
    "not": "true|false",
    "left": "fieldName",
    "right": "value"
]

这里的“左”和“右”可以被认为是等式的边。在这种情况下:'Id eq "bob"' 左边是 "Id",右边是 "bob"。 “操作”将是“EQUALS”。

这里是更复杂表达式的结构(例如simpleExpr AND simpleExpr):

[ 
    "operation": "AND|OR",
    "left": "simpleExpression|complexExpression",
    "right": "simpleExpression|complexExpression"
]

正如您在此处看到的,您可以在此映射结构中表示任意复杂的布尔表达式。根据您在特定情况下希望支持的复杂程度,您可以选择支持完全递归的表达式构建器(如示例 3 中所示),或者您可以简单地支持核心案例。

以下是您的脚本应该能够处理的各种操作的一些示例:

GET /openidm/system/scriptedrest/account?_queryId=query-all-ids

  • 这基本上就是您现在所拥有的。执行此操作时,“过滤器”对象将为空,因此您根本不需要过滤任何内容

GET /openidm/system/scriptedrest/account/bob

  • 这是一个“读取”操作,但它也是通过 SearchScript 实现的。 “读取”与针对特定 __UID__ 值的简单过滤器完全相同。完成此操作的快速而肮脏的方法是将您的过滤器对象转换为地图(就像我描述的那样),然后假设地图将只包含一个搜索特定__UID__ 的过滤器,如下所示:

    def uid = query.get('right')

然后您可以将其传递到您的 REST 调用中(可能通过将其附加到 uri.path 变量)。

理想情况下,您的搜索脚本应该能够处理更复杂的过滤器,如下所示:

GET /openidm/system/scriptedrest/account?_queryFilter=/email eq "bob@bob.com"

  • 这是对具有特定值的记录的更通用搜索。您的 REST 后端必须支持这些东西,并且您的过滤器查询构建器必须能够遍历树以构建适当的查询字符串。根据您需要使用此连接器执行的操作,可能没有必要。

【讨论】:

  • Alfresco REST 服务没有实现完整的查询/过滤系统,但我可以提供一个用户名,用于限制对一个用户的响应。我刚刚用一个简单的查询进行了测试,过滤器包含用户 UID:查询:[not:false, operation:EQUALS, left:__UID__, right:usertest1 openidm]。感谢您提供有用的回答,帮助我理解 OpenIDM REST 服务和我的 Groovy 脚本之间的联系。
猜你喜欢
  • 1970-01-01
  • 2021-10-15
  • 1970-01-01
  • 1970-01-01
  • 2021-04-22
  • 1970-01-01
  • 1970-01-01
  • 2017-12-07
  • 1970-01-01
相关资源
最近更新 更多