Se não IBM® Software Hub houver um conector predefinido para uma determinada fonte de dados, um administrador pode criar um conector personalizado JDBC para a fonte de dados. Os usuários podem usar o conector personalizado JDBC para se conectar a várias instâncias da fonte de dados de maneira consistente.
- Quais funções e permissões você precisa para concluir esta tarefa?
- Para concluir esta tarefa, você deve ter a função de administrador para o Platform assets catalog.
- Para obter as permissões necessárias para carregar um arquivo JAR, IBM Software Hub consulte Importação de drivers d JDBC.
- Quando você precisa concluir essa tarefa?
- Conclua esta tarefa quando desejar que os usuários possam se conectar de maneira consistente a uma fonte de dados que não possui um tipo predefinido no IBM Software Hub.
Se você estiver conectando-se a apenas uma fonte de dados e os usuários não precisarem de um método repetível para se conectar a ela, os usuários podem criar uma conexão Genérica JDBC.
- Restrição
- Quaisquer conexões criadas a partir de um conector personalizado JDBC não funcionarão se você exportar o projeto e depois importá-lo para uma instância IBM Software Hub diferente. Você deve excluir as conexões e recriar o conector e as conexões na nova instância.
Antes de iniciar
Como parte da configuração, você precisará de um ou mais arquivos de driver (arquivos JAR JDBC ). Consulte a documentação fornecida pelo fornecedor do driver JDBC para obter essas informações:
- Identifique e obtenha o(s) arquivo(s) JAR necessário(s) para a fonte de dados. Você pode fazer o upload dos arquivos com antecedência ou enquanto cria o conector.
- Identifique o nome da classe do driver. Você também pode encontrar a classe do driver inspecionando os arquivos JAR, seguindo estas etapas:
- Abra o arquivo JAR como um arquivo compactado. Se você não tiver um programa que possa abrir um arquivo JAR, altere a extensão do arquivo para
zip.
- Vá para o META-INF/services/ diretório dentro do arquivo.
- Extraia o arquivo chamado java.sql.Driver e abra-o em um editor de texto. A lista de classes de drivers válidas está listada no arquivo java.sql.Driver .
Normalmente, os drivers têm um arquivo JAR com um nome de classe de driver. Se o driver contiver vários arquivos JAR ou definir vários nomes de classes de driver, consulte a documentação do fornecedor para determinar as seguintes informações:
- O nome do arquivo JAR principal
- O nome da classe principal do driver
Quaisquer outros arquivos JAR no driver são geralmente dependências de terceiros para o arquivo JAR principal.
- Identifique o formato para o JDBC URL.
- Identifique as propriedades necessárias para se conectar à fonte de dados. Para cada propriedade, determine se a propriedade:
- Tem um valor variável ou fixo
- Tem um valor padrão
- É obrigatório ou opcional
- É usado para definir credenciais, como nome de usuário ou senha
- É usado para suporte SSL
Assista a este vídeo para ver como criar um conector personalizado para o JDBC.
Sobre esta tarefa
Para criar um conector personalizado do JDBC, siga as etapas para criar um formulário de conexão reutilizável que os usuários usarão para criar conexões reais. Você carrega um ou mais arquivos JAR do driver JDBC. Em seguida, crie um modelo JDBC URL para o banco de dados e insira as propriedades do driver JDBC. Você personaliza e testa as propriedades da conexão e o layout do formulário de conexão. O conector fica disponível para os usuários após você concluir todas as etapas e criá-lo.
Procedimento
- Faça login no cliente IBM Software Hub web. No menu de navegação, selecione .
- Selecione e clique em Novo conector.
O assistente
Criar conector é aberto.
- Exibir informações : insira valores para os campos obrigatórios Nome do conector e Descrição.
- No campo Nome do conector, insira um nome exclusivo que os usuários reconhecerão. O nome aparecerá na página Nova conexão, que lista todos os conectores. Ele também aparecerá no formulário Criar conexão que os usuários usarão para criar a conexão.
- No campo Descrição, forneça informações que ajudem os usuários a identificar o conector. A descrição aparecerá em Detalhes no painel lateral que se abre quando um usuário seleciona o conector na página Nova conexão. Também estará na seção Visão geral da conexão do formulário de conexão.
Depois de clicar em Avançar, você pode salvar o conector como rascunho e voltar para finalizá-lo mais tarde.
- JDBC driver : Carregue e selecione os arquivos do driver JDBC para o conector. Em seguida, insira o nome da classe do driver.
- Defina as propriedades do conector Propriedades da conexão.
As propriedades podem ser variáveis ou valores fixos.
- Variáveis: os usuários fornecem os valores para as variáveis quando criam uma conexão. Use a sintaxe
${variable}. As variáveis devem ser uma ou mais palavras em minúsculas separadas pelo caractere sublinhado (_). As variáveis não podem conter espaços nem começar com um caractere sublinhado ou um número. Por exemplo, variáveis válidas são ${hostname} ou ${host_name}.
- Valores fixos: as propriedades com valores especificados são codificadas. Eles são usados pela conexão, mas não são exibidos no formulário de conexão.
- Insira o modelo JDBC URL. O JDBC URL identifica o banco de dados. As propriedades JDBCURL normalmente incluem variáveis para o nome do host, número da porta e nome do banco de dados. O endereço URL deve começar com o prefixo
jdbc:. Exemplo de modelos JDBC URL :
jdbc:db2://${hostname}:${port}/${dbname}
jdbc:informix-sqli://${hostname}:${port}/${dbname}:informixserver=${informix_server_name}
jdbc:oracle:thin:@${hostname}:${port}:SID
jdbc:sqlserver://${hostname}:${port};databasename=${database_name}
- Selecione propriedades predefinidas, como autenticação por nome de usuário e senha.
Se o servidor estiver configurado para SSL, insira a propriedade no modelo URL. Marque a caixa de seleção
O conector suporta SSL para ativar os campos necessários para usar SSL.
Observação: você precisará inserir propriedades na seção “ URL ” (Propriedades adicionais) e na seção “Additional properties” (Propriedades adicionais). Por exemplo, você precisará inserir sslConnection=true.
- Na seção Propriedades de desempenho, selecione ou insira propriedades que possam melhorar a eficiência da conexão.
- Clique em Propriedades adicionais e insira quaisquer outras propriedades para se conectar à fonte de dados. Consulte a documentação do fornecedor do driver para obter informações sobre as propriedades compatíveis. Use esses campos para inserir um método de autenticação diferente se a fonte de dados não usar autenticação por nome de usuário e senha.
Exemplos de propriedades com valores fixos. Essas propriedades não serão visíveis para os usuários no formulário de conexão.
loggerLevel=TRACE
encrypt=true
Exemplos de propriedades com variáveis. Essas propriedades serão visíveis para os usuários no formulário de conexão. Você especifica o nome de exibição, o valor padrão, a ajuda ao passar o mouse e o texto do espaço reservado na próxima etapa.
charset=${charset}
readtimeout=${read_timeout}
Exemplo
- URL modelo:
jdbc:db2://${hostname}:${port}/${dbname}
- Propriedades predefinidas: autenticação por nome de usuário e senha.
Exemplos de valores que o usuário irá inserir no formulário de conexão:
- hostname=server1
- port=50000
- dbname=meu_banco_de_dados
- username=user_1
- senha=*****
O JDBC URL será: jdbc:db2://server1:50000/my_database
As propriedades com valores fixos não estarão no formulário de conexão, mas serão usadas pelo conector.
- Configuração do formulário de conexão : defina como cada propriedade variável aparecerá no formulário de conexão. Por exemplo, aqui você pode modificar o nome de exibição, inserir o valor padrão e especificar se uma propriedade é obrigatória ou opcional.
Clique em
Visualizar e testar para ver como o formulário de conexão será exibido aos usuários. Você pode inserir valores e clicar em
Testar conexão para confirmar se o conector está configurado corretamente.
Os seguintes campos são incluídos automaticamente em todos os formulários de conexão e não podem ser excluídos ou alterados:
- Configuração de credenciais para uso pessoal ou compartilhado
- Mascarar credenciais sensíveis recuperadas por meio de chamadas API
- Método de entrada para credenciais e certificados. (Este campo determina a seleção para inserir valores em texto simples ou usando segredos de um cofre.)
As configurações do formulário são salvas quando você visualiza a conexão ou clica em Avançar.
- Resumo : Revise as informações exibidas, o driver JDBC, as propriedades da conexão e a configuração do formulário de conexão e, em seguida, execute uma das seguintes ações:
- Cancelar o conector. O conector não será criado. Se você estiver editando um rascunho, suas alterações serão perdidas, mas o rascunho permanecerá.
- Clique em Voltar para retornar à etapa de configuração do formulário de conexão ou clique em editar (
) para retornar a qualquer etapa anterior.
- Salve o conector como rascunho.
- Crie o conector. Se você criar o conector, ele ficará ativo e disponível para os usuários selecionarem na lista de conexões na página Nova conexão.
Importante:
- Nem todos os campos ou propriedades podem ser alterados após a criação do conector. Consulte Gerenciando conectores personalizados do JDBC.
- Se você editar o conector após criá-lo, isso poderá interromper quaisquer conexões, ativos de dados conectados ou tarefas que os usuários já tenham criado com ele.
O quê fazer em seguida
Teste o conector para garantir que ele funcione nos serviços e com as ferramentas que você usa para se conectar à fonte de dados.