Histórico da Página
Informações | ||
---|---|---|
| ||
Página destinada a atualizações anteriores ao Fluig Plataforma 1.6. Acesse a página original para atualizações a partir do Fluig Plataforma1.6: Integrando widget com serviços REST. |
Índice
Índice | ||||||||
---|---|---|---|---|---|---|---|---|
|
Produto: TOTVS Fluig Plataforma
Versão: Anteriores a 1.6.x
Objetivo
O objetivo desse guia é apresentar a integração de widgets com serviços REST.
Integração de widget com serviços REST
Para obter dados de uma fonte externa ao seu sistemaà plataforma, a forma mais aconselhável é via por chamada REST. Vamos criar um rest REST dentro da própria do próprio widget, para isso devemos seguir alguns passos.
Informações |
---|
Dúvidas para criar a o widget? Siga o guia. |
...
Primeiro devemos criar uma classe chamada ApplicationConfig que extende a classe Application.
Bloco de código | ||
---|---|---|
| ||
package com.fluig.kitintranet.news.proxy.rest.config; import javax.ws.rs.ApplicationPath; import javax.ws.rs.core.Application; @ApplicationPath("api/rest") public class ApplicationConfig extends Application{ //não é necessário código, precisamos apenas para o @ApplicationPath } |
Em seguida Depois devemos criar a classe REST que desejamos acessar.
Bloco de código | ||
---|---|---|
| ||
package com.fluig.kitintranet.news.proxy.rest; import com.totvs.technology.wcm.sdk.rest.WCMRest; import javax.ws.rs.Consumes; import javax.ws.rs.POST; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; @Path("/news") public class NewsRest extends WCMRest { @POST @Path("feed") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) public Response getRSSFeedTest(String requestParams) { //código } } |
...
Em seguida, temos de que alterar os arquivos jboss-web.xml.
Bloco de código | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <jboss-web> <context-root>/news</context-root> <disable-cross-context>false</disable-cross-context> <security-domain>TOTVSTech</security-domain> <security-role> <role-name>user</role-name> <principal-name>totvstech</principal-name> </security-role> <security-role> <role-name>totvstech</role-name> <principal-name>totvstech</principal-name> </security-role> <security-role> <role-name>sysadmin</role-name> <principal-name>wcmadmin</principal-name> </security-role> <security-role> <role-name>admin</role-name> <principal-name>wcmadmin</principal-name> </security-role> <valve> <class-name>com.totvs.technology.auth.saml.TOTVSAuthenticatorValve</class-name> </valve> </jboss-web> |
...
Também temos de que alterar o arquivo web.xml para que possamos acessar esse REST.
Bloco de código | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0"> <session-config> <session-timeout> 30 </session-timeout> </session-config> <!-- REST --> <security-constraint> <display-name>REST</display-name> <web-resource-collection> <web-resource-name>REST</web-resource-name> <description>REST</description> <url-pattern>/api/rest/*</url-pattern> </web-resource-collection> <auth-constraint> <description>REST</description> <role-name>user</role-name> </auth-constraint> </security-constraint> <login-config> <auth-method>FORM</auth-method> <realm-name>TOTVSTech</realm-name> <form-login-config> <form-login-page>/login.jsp</form-login-page> <form-error-page>/loginfail.jsp</form-error-page> </form-login-config> </login-config> <security-role> <role-name>totvstech</role-name> </security-role> <security-role> <role-name>user</role-name> </security-role> <security-role> <role-name>sysadmin</role-name> </security-role> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app> |
Após isso estamos capazes de Depois disso, é possível utilizar o REST que se encontra dentro da do widget utilizando um por meio do método chamado WCMAPI.Read que iremos utilizá-lo , utilizado para fazer chamadas REST.
Bloco de código | ||
---|---|---|
| ||
var that = this; WCMAPI.Read({ type: "POST", url: WCMAPI.getServerURL() + '/news/api/rest/news/feed', async: true, data: feed, success: function funcao(data) { that.appendNews(data.content.channel.items); }, error: function () { that.showLoadingError(); } }); |
O método WCMAPI.getServerURL() traz a url URL do server servidor que utilizaremos será utilizado para montar a url URL da chamada restREST. Em seguida, concatenamos o caminho do REST que pretendemos chamar. Neste caso, neste caso utilizamos o seguinte caminho caminho: '/news/api/rest/news/feed'. SendoOnde:
- '/news': é o código
...
- do widget
...
- ;
- '/api/rest': é o @Path da classe ApplicationConfig.java
...
- ;
- '/news': é o @Path da classe NewsRest.java
...
- ;
- '/feed': é o @Path do método
...
- da classe NewsRest.java que desejamos chamar.
Pom.xml
Por fim, temos de declarar a dependencia dependência ao módulo foundation-security-authentication-saml no pom.xml da do widget.
Bloco de código | ||
---|---|---|
| ||
<dependency> <groupId>com.fluig</groupId> <artifactId>foundation-security-authentication-saml</artifactId> <scope>compile</scope> </dependency> |
...