Funções LDAP no Jitterbit Design Studio

LDAP (Protocolo Leve de Acesso a Diretórios) é um protocolo que permite pesquisar e atualizar um diretório. É suportado por diversos servidores de diretório, como Microsoft Active Directory e Netscape Directory Server. Um diretório geralmente contém informações sobre usuários e recursos de rede, mas pode conter qualquer tipo de dado.

Essas funções permitem que scripts e transformações se conectem a um diretório usando LDAP.

O padrão de uso segue estas etapas:

• LDAPConnect: Estabelece uma conexão com o servidor
• LDAPAdd, LDAPReplace, LDAPRemove,...: Coloca ações na fila a serem executadas
• LDAPExecute: Executa a fila no servidor

Para pesquisa, você pode seguir este padrão:

• LDAPConnect: Estabelece uma conexão com o servidor
• LDAPSearch: Executa a pesquisa no servidor e retorna o resultado

Definir senhas LDAP programaticamente

A partir da versão 9.9 do Harmony, as senhas LDAP podem ser definidas usando essas funções LDAP. A senha precisa ser convertida para binário antes de ser definida. (A senha pode precisar ser colocada entre aspas duplas antes da conversão para binário, pois o Active Directory exige que os valores estejam entre aspas duplas.) Este fragmento de script mostra como isso pode ser realizado:

LDAPConnect("<TAG>Project Name/Targets/LDAPTarget</TAG>");
$plain = '"J1tterb1t!@#"';
$pwd = StringToHex($plain);
$i=0;
$newPwd = "";
While($i < Length($pwd)/2,
    $newPwd = $newPwd + Mid($pwd, $i * 2, 2) + "00";
    $i = $i+1;
);
$newPwd = HexToBinary($newPwd);

LDAPReplace("unicodePwd", $newPwd);
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

ArrayToMultipleValues

Declaração

string ArrayToMultipleValues(array arr)

Sintaxe

ArrayToMultipleValues(<arr>)

Parâmetros obrigatórios

• arr: Um array com valores a serem usados para preencher um atributo LDAP de múltiplos valores

Descrição

Indica que um array deve ser usado para preencher um atributo LDAP de múltiplos valores ao mapear para um destino LDAP. O array é convertido para XML e interpretado quando o servidor LDAP é escrito.

Exemplos

// Create two LDAP attributes using an array
arr = Array();

// Length(arr) will always return the index of
// the next-after-last element of an array
arr[Length(arr)] = "First instance";
arr[Length(arr)] = "Second instance";

// The array will be converted to the string
// "<JB_Array><it>First instance</it><it>Second instance</it></JB_Array>"
result = ArrayToMultipleValues(arr);

LDAPAdd

Declaração

bool LDAPAdd(string ldapType, string ldapValue)

Sintaxe

LDAPAdd(<ldapType>, <ldapValue>)

Parâmetros obrigatórios

• ldapType: O tipo de registro ou atributo LDAP
• ldapValue: O valor a ser adicionado para o tipo

Descrição

Para usar esta função, a função LDAPConnect deve ser utilizada primeiro para estabelecer uma conexão com o diretório LDAP.

Após a conexão ser estabelecida, a função LDAPAdd() é usada para adicionar entradas e atributos ao diretório LDAP conectado. O valor é adicionado ao nó especificado na função LDAPExecute, que deve ser chamada imediatamente em seguida para que as alterações tenham efeito.

Exemplos

// Adding a user entry to a directory:
LDAPAdd("objectClass", "user");
LDAPAdd("cn", "wright");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

// Adding attributes to a user:
LDAPAdd("description", "Thinks a lot.");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPConnect

Declaração

bool LDAPConnect(string ldapEndpointId)
bool LDAPConnect(string hostname, string user, string password[, int mode, long port])

Sintaxe

LDAPConnect(<ldapEndpointId>)
LDAPConnect(<hostname>, <user>, <password>[, <mode>, <port>])

Parâmetros obrigatórios

• ldapEndpointId: (Primeira forma) Uma fonte ou destino LDAP no projeto atual
• hostname: (Segunda forma) Nome do host de um servidor LDAP ao qual se conectar; pode incluir uma porta, como directory.example.com:10389
• user: (Segunda forma) Nome de usuário para se conectar ao host LDAP
• password: (Segunda forma) Senha a ser usada para se conectar ao host LDAP

Parâmetros opcionais

• mode: (Segunda forma) Modo de conexão; um dos:
  • 0: Conexão não segura; porta padrão: 389
  • 1: Conexão segura; porta padrão: 389
  • 2: Conexão segura usando LDAP sobre SSL; porta padrão: 636
• port: (Segunda forma) Porta a ser usada para se conectar ao host LDAP (-1 indica que deve usar as portas LDAP padrão)

Descrição

Conecta-se a um diretório usando LDAP. O endpoint LDAP deve ser definido no projeto atual ou especificado usando a segunda forma do comando. Veja as instruções sobre inserir itens do projeto.

Veja também a função LDAPExecute.

Exemplos

// Connects to an LDAP Target
connected = LDAPConnect("<TAG>Project Name/Targets/LDAPTarget</TAG>");

// Connects to an LDAP server using hostname:port, username, password, mode
connected = LDAPConnect("directory.company.example.com:10389", "admin", $adminpassword, 0);

LDAPDeleteEntry

Declaração

bool LDAPDeleteEntry(string distinguishedName)

Sintaxe

LDAPDeleteEntry(<distinguishedName>)

Parâmetros obrigatórios

• distinguishedName: Um nome distinto LDAP a ser removido do servidor atualmente conectado

Descrição

Para usar esta função, a função LDAPConnect deve ser usada primeiro para estabelecer uma conexão com o diretório LDAP.

Após estabelecer a conexão, a função LDAPDeleteEntry é usada para remover uma entrada especificada por um nome distinto.

Veja também as funções LDAPConnect e LDAPExecute.

Exemplos

LDAPDeleteEntry("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPExecute

Declaração

bool LDAPExecute(string distinguishedName)

Sintaxe

LDAPExecute(<distinguishedName>)

Parâmetros obrigatórios

• distinguishedName: Um nome distinto LDAP no servidor atualmente conectado

Descrição

Para usar esta função, a função LDAPConnect deve ser utilizada primeiro para estabelecer uma conexão com o diretório LDAP.

Após a conexão ser estabelecida, a função LDAPExecute() é usada para executar uma ou mais modificações (adicionar, remover, substituir) que foram previamente especificadas com as funções LDAPAdd, LDAPRemove ou LDAPReplace.

Veja também as funções LDAPConnect e LDAPExecute.

Exemplos

// Adding LDAP entries and executing them
LDAPAdd("description", "Thinks a lot.");
LDAPReplace("telephoneNumber", "(510) 555 1000");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPRemove

Declaração

bool LDAPRemove(string ldapType, string ldapValue)

Sintaxe

LDAPRemove(<ldapType>, <ldapValue>)

Parâmetros obrigatórios

• ldapType: O tipo de atributo LDAP
• ldapValue: O valor a ser removido para o tipo de atributo especificado

Descrição

Para usar esta função, a função LDAPConnect deve ser utilizada primeiro para estabelecer uma conexão com o diretório LDAP.

Uma vez que a conexão é estabelecida, a função LDAPRemove é usada para remover um atributo de um tipo especificado e com um valor especificado.

Se o tipo de atributo desse valor não for encontrado, um erro é gerado. Veja também as funções LDAPConnect e LDAPExecute.

Exemplos

// Removing an LDAP entry and executing it
LDAPRemove("telephoneNumber", "(510) 555-1000");
LDAPAdd("telephoneNumber", "(510) 555-2000");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPRename

Declaração

bool LDAPRename(string distinguishedName, string newRDN[, string newParent, bool deleteOldRDN])

Sintaxe

LDAPRename(<distinguishedName>, <newRDN>[, <newParent>, <deleteOldRDN>])

Parâmetros obrigatórios

• distinguishedName: O caminho da entrada do diretório (nome distinto) a ser renomeada
• newRDN: O novo nome distinto relativo

Parâmetros opcionais

• newParent: O nome distinto do novo pai desta entrada; o padrão é vazio
• deleteOldRDN: Se true, o antigo nome distinto relativo será deletado; o padrão é false

Descrição

Para usar esta função, a função LDAPConnect deve ser utilizada primeiro para estabelecer uma conexão com o diretório LDAP.

Uma vez que a conexão é estabelecida, a função LDAPRename é usada para alterar o nome distinto de uma entrada no diretório conectado.

Veja também as funções LDAPConnect e LDAPExecute.

Exemplos

LDAPRename("telephoneNumber", "telephoneNumberHome");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPReplace

Declaração

bool LDAPReplace(string ldapType, string ldapValue)

Sintaxe

LDAPReplace(<ldapType>, <ldapValue>)

Parâmetros obrigatórios

• ldapType: O tipo de registro ou atributo LDAP
• ldapValue: O novo valor a ser definido para o tipo

Descrição

Para usar esta função, a função LDAPConnect deve ser utilizada primeiro para estabelecer uma conexão com o diretório LDAP.

Uma vez que a conexão é estabelecida, a função LDAPReplace é usada para substituir o valor de um atributo existente por um novo valor.

Veja também as funções LDAPConnect e LDAPExecute.

Exemplos

// Substituindo uma entrada LDAP e executando-a
LDAPReplace("telephoneNumber", "(510) 555-1000");
LDAPExecute("CN=wright,CN=Users,DC=company,DC=example,DC=com");

LDAPSearch

Declaração

string LDAPSearch(string path, string filter, int detail, string attribute1[, ... string attributeN])

Sintaxe

LDAPSearch(<path>, <filter>, <detail>, <attribute1>[, ... <attributeN>])

Parâmetros obrigatórios

• path: O nome distinto usado como base da pesquisa
• filter: Um filtro de pesquisa em forma de string, conforme definido pelo RFC 4515**
  
• detail: Detalhes a serem retornados:
  • 0: Passar para retornar uma string simples que é o primeiro atributo encontrado que corresponde ao filtro
  • 1: Passar para retornar uma representação XML dos resultados da pesquisa. Isso pode ser definido como um elemento de dados usando a função Set e, em seguida, acessado mais tarde usando Get e uma consulta XPath usando a função SelectSingleNode.
  • 2: Passar para retornar um array bidimensional, onde cada linha representa uma entrada LDAP e onde os elementos da linha são os valores dos atributos. Acesse os elementos usando a função Get.
• attribute,... attributeN: Um atributo a ser incluído no resultado da pesquisa (em outras palavras, o atributo que você está procurando). Atributos adicionais podem ser especificados; separe-os por vírgulas.

Descrição

Para usar esta função, a função LDAPConnect deve ser usada primeiro para estabelecer uma conexão com o diretório LDAP.

Uma vez que a conexão é estabelecida, a função LDAPSearch é usada para pesquisar dentro do diretório conectado.

Veja também as funções LDAPConnect e LDAPExecute.

Controlando variáveis do Jitterbit

Essas variáveis do Jitterbit afetam a pesquisa:

Exemplos

// Connecting to an LDAP server using a password set
// in a global variable ("$ldapPassword") and then performing a search
LDAPConnect("directory.company.example.com", "ghvwright", $ldapPassword, 0);
directorySearchResults = LDAPSearch("CN=Users,DC=company,DC=example,DC=com",
  "(&(objectCategory=person)(objectClass=user))", 1, "name", "whenCreated",
  "description", "telephoneNumber");