Instalando o Serviço de Dados REST

Este tópico descreve como instalar o serviço de dados REST do WebSphere eXtreme Scale em um servidor da Web.

Antes de Iniciar

Requisitos de Software

O serviço de dados REST do WebSphere eXtreme Scale é um aplicativo da Web Java que pode ser implementado para qualquer servidor de aplicativos que suporte a especificação de servlet Java, Versão 2.3 e um ambiente de tempo de execução Java, Versão 5 ou posterior.

O software a seguir é necessário:
  • Java Standard Edition 5 ou posterior
  • Contêiner do servlet da Web, Versão 2.3 ou posterior, que inclui uma das opções a seguir:
    • WebSphere Application Server Versão 6.1.0.25 ou posterior
    • WebSphere Application Server Versão 7.0.0.5 ou posterior
    • WebSphere Community Edition Versão 2.1.1.3 ou posterior
    • Apache Tomcat Versão 5.5 ou posterior
  • WebSphere eXtreme Scale, Versão 7.1 ou posterior, incluindo o teste.

Sobre Esta Tarefa

O serviço de dados REST do WebSphere eXtreme Scale inclui um único arquivo wxsrestservice.war. O arquivo wxsrestservice.war inclui um único servlet que age como um gateway entre os aplicativos clientes do WCF Data Services ou qualquer outro cliente HTTP REST e uma grade de dados.

O serviço de dados REST inclui uma amostra que o permite criar rapidamente uma grade de dados e interagir com ela usando o cliente do eXtreme Scale ou o serviço de dados REST. Consulte o Configurando Serviços de Dados REST para obter detalhes sobre como usar a amostra.

Quando o WebSphere eXtreme Scale 7.1 é instalado ou o teste do eXtreme Scale Versão 7.1 é extraído, os seguintes diretórios e arquivos são incluídos:
  • restservice_home/lib
    O diretório lib contém esses arquivos:
    • wxsrestservice.ear – O archive do aplicativo corporativo do serviço de dados REST para uso com WebSphere Application Server e WebSphere Application Server CE.
    • wxsrestservice.war – O módulo da Web de serviço de dados REST para uso com Apache Tomcat.

    O arquivo wxsrestservice.ear inclui o arquivo wxsrestservice.war e os dois são estreitamente acoplados ao tempo de execução do WebSphere WebSphere eXtreme Scale. Se for feito o upgrade do WebSphere eXtreme Scale para uma nova versão um se um fix pack for aplicado, o arquivo wxsrestservice.war ou o arquivo wxsrestservice.ear precisarão ter seu upgrade feito manualmente para a versão instalada neste diretório.

  • restservice_home/gettingstarted

    O diretório gettingstarted contém uma amostra simples que demonstra como usar o serviço de dados REST do WebSphere eXtreme Scale com uma grade de dados.

Procedimento

Empacote e implemente o serviço de dados REST.

O serviço de dados REST é projetado como um módulo WAR autocontido. Para configurar o serviço de dados REST, você deve primeiro empacotar a configuração do serviço de dados REST e os arquivos de configuração opcionais do WebSphere eXtreme Scale em um arquivo ou diretório JAR. Essa compactação de aplicativo é referida pelo tempo de execução do servidor de contêiner de Web. O diagrama a seguir ilustra os arquivos usados pelo serviço de dados REST do eXtreme Scale.

Figura 1. Arquivos do Serviço de Dados REST do WebSphere eXtreme Scale
Arquivos do Serviço de Dados REST do WebSphere eXtreme Scale

O diretório ou JAR de configuração do serviço REST deve conter o seguinte arquivo:

wxsRestService.properties: O arquivo wxsRestService.properties inclui as opções de configuração para o serviço de dados REST. Isso inclui terminais de serviço de catálogo, nomes de ObjectGrid para expor, opções de rastreio e mais. Consulte Arquivo de Propriedades do Serviço de Dados REST.

Os arquivos de cliente do ObjectGrid a seguir são opcionais:
  • META-INF/objectGridClient.xml: O arquivo XML de substituição do cliente do ObjectGrid é usado para se conectar à grade de dados remota. Por padrão, esse arquivo não é necessário. Se este arquivo não estiver presente, o serviço REST usará a configuração do servidor, desativando o cache próximo.
    O nome do arquivo pode ser substituído com o uso da propriedade de configuração do serviço de dados REST do objectGridClientXML. Se fornecido, esse arquivo XML deverá incluir:
    1. Qualquer ObjectGrid que desejar expor ao serviço de dados REST.
    2. Inclua uma referência para o arquivo XML do descritor de entidade associado a cada configuração de ObjectGrid.
  • META-INF/arquivos XML do descritor de entidades: Um ou mais arquivos XML do descritor de entidades serão necessários apenas se o cliente precisar substituir a definição de entidade do cliente. O arquivo XML do descritor de entidade deve ser utilizado junto com o arquivo descritor XML de substituição de cliente do ObjectGrid.
  • Classes de entidade Classes de entidade anotadas ou um arquivo XML de descritor de entidade podem ser utilizados para descrever os metadados da entidade. O serviço REST exigirá classes de entidades no caminho da classe apenas se os servidores eXtreme Scale forem configurados com classes de metadados de entidades e um descritor XML de entidade de substituição do cliente não for usado.

    Um exemplo com o arquivo de configuração requerido mínimo, no qual as entidades são definidas em XML nos servidores:

    restserviceconfig.jar:
    wxsRestService.properties
    O arquivo de propriedades contém:
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid

    Um exemplo com uma entidade, arquivos XML de substituição e classes de entidade:

    restserviceconfig.jar:
    wxsRestService.properties
    O arquivo de propriedades contém:
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid
    com/acme/entities/Customer.class
    META-INF/objectGridClient.xml
    O arquivo XML do descritor de ObjectGrid cliente contém:
    <objectGrid
    name="CustomerGrid" entityMetadataXMLFile="emd.xml"/>
    META-INF/emd.xml
    O arquivo XML do descritor de metadados da entidade contém:
    <entity
    class-name="com.acme.entities.Customer" name="Customer"/>