Para utilizar os recursos do componente SDK, existem alguns pré-requisitos e exigências a serem seguidos, como:
Esta documentação é destinada ao desenvolvedor, cliente e parceiro do fluig que deseja consumir interna e externamente os recursos disponíveis na API Pública e no componente SDK.
As operações na API Pública estão disponíveis através de chamadas REST, que são consumidas via HTTP.
As operações no componente SDK estão disponíveis após configuração do fluig-sdk-api no classpath da aplicação, dessa forma, através de um ServiceLocator, é realizada a chamada ao serviço desejado.
Para utilizar um serviço da API Pública, deve ser utilizado o protocolo OAuth de autenticação, que através das chaves ConsumerKey, ConsumerSecret, configurados no OAuthConsumer é gerado através do OAuthProvider com um novo TokenAccess e um TokenSecret.
Para utilizar o recursos do componente SDK, existem alguns pré-requisitos e exigências a serem seguidos, como:
<?xml version="1.0" encoding="UTF-8"?> <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <mirrors> <mirror> <id>nexus</id> <mirrorOf>*</mirrorOf> <name>Fluig Nexus Repository.</name> <url>http://nexus.fluig.com/content/groups/public</url> </mirror> </mirrors> </settings> |
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <dependencyManagement> <dependencies> <dependency> <groupId>com.fluig</groupId> <artifactId>fluig-sdk-bom</artifactId> <version>1.5.0</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>com.fluig</groupId> <artifactId>foundation-security-authentication-saml</artifactId> <scope>compile</scope> </dependency> <dependency> <groupId>com.fluig</groupId> <artifactId>fluig-sdk-api</artifactId> </dependency> <dependency> <groupId>com.fluig</groupId> <artifactId>fluig-sdk-common</artifactId> </dependency> <dependency> <groupId>javax</groupId> <artifactId>javaee-api</artifactId> <scope>provided</scope> </dependency> </dependencies> <build> <finalName>fluigsdk.sample</finalName> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.2</version> <configuration> <filteringDeploymentDescriptors>true</filteringDeploymentDescriptors> <failOnMissingWebXml>false</failOnMissingWebXml> <archive> <manifestEntries> <Dependencies>org.slf4j, com.fluig.api, com.fluig.api.common</Dependencies> </manifestEntries> </archive> </configuration> </plugin> </plugins> </build> </project> |
jboss-web.xml
<?xml version="1.0" encoding="UTF-8"?> <jboss-web> <context-root>/sample</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> |
web.xml
<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> |
Veja a seguir o exemplo para a chamado ao serviço no SDK:
private UserService getUserServiceSDK() throws SDKException { return new FluigAPI().getUserService(); } |
ArticleService
CardIndexService
CardService
CollaborationSDKService
CommunityService
ContentFilesService
DocumentService
FavoritesService
FolderDocumentService
GlobalParameterService
GroupService
I18NService
PageService
PostService
SecurityService
SocialBreadcrumbService
TasksService
TenantService
UserService
WorkflowService
Este recursos está disponível apenas para eventos javascript de Workflow, que podem ser encontrados aqui. |
Os serviços disponíveis para serem invocados à partir dos eventos de javascript do Workflow podem ser encontrados aqui.
Exemplo para utilização do componente SDK via eventos de javascript
function beforeTaskCreate(colleagueId){ log.info(fluigAPI.getUserService().getCurrent());} |
Exemplo serviço SDK