Implementar el SDK de Catalyst en AppSail

Catalyst te permite implementar los paquetes del SDK de los entornos de desarrollo compatibles en tus aplicaciones AppSail para entornos de ejecución administrados por Catalyst. Esto te permite aprovechar otros servicios y componentes de Catalyst en la funcionalidad de tu aplicación. Puedes implementar los SDKs de desarrollo de varios entornos de programación en tu aplicación como se especifica a continuación.

Implement Catalyst Java SDK

Puedes descargar el paquete del SDK de Catalyst Java desde la configuración de Developer Tools en tu consola de Catalyst e incluirlo en el código fuente de tu aplicación. Luego puedes implementar el SDK de Catalyst Java en el código de tu aplicación e inicializarlo. Consulta la ayuda del SDK de Catalyst Java para obtener detalles sobre las diversas funcionalidades del kit de herramientas del SDK y fragmentos de código de ejemplo.

Los pasos para implementar e inicializar el SDK de Catalyst para diferentes versiones de API de servlets Java se demuestran con códigos de ejemplo a continuación.

En todos los casos, Catalyst requiere que implementes la interfaz AuthHeaderProvider del paquete del SDK de Catalyst Java. La implementación define el método getHeader() que devuelve el valor del encabezado de la solicitud. Luego puedes pasar un objeto de la clase de implementación al método init(), para inicializar el SDK.

Java Servlet API versions <=4

Código de ejemplo para aplicaciones Java que usan servlets Java de versiones de API menores o iguales a 4.0 (javax.servlet):

Clase de implementación:

package com.zoho.catalyst.appsail.demo.utils;
import javax.servlet.http.HttpServletRequest;
import com.zc.auth.AuthHeaderProvider;
public class AuthProviderImpl implements AuthHeaderProvider {
 HttpServletRequest request;
 public AuthProviderImpl(HttpServletRequest request) {
  this.request = request;
 }
 @Override
 public String getHeaderValue(String key) {
  return request.getHeader(key);
 }
}

Inicialización:

AuthProviderImpl authProviderImpl = new AuthProviderImpl(req);
CatalystSDK.init(authProviderImpl)

Java Servlet API versions >=5

Código de ejemplo para aplicaciones Java que usan servlets Java de versiones de API mayores o iguales a 5.0 (jakarta.servlet):

Clase de implementación:

import com.zc.auth.AuthHeaderProvider;
import jakarta.servlet.http.HttpServletRequest;
public class AuthProviderImpl implements AuthHeaderProvider {
    private HttpServletRequest request;
    AuthProviderImpl(HttpServletRequest request) {
        this.request = request;
    }
    @Override
    public String getHeaderValue(String s) {
        return request.getHeader(s);
    }
}

Inicialización:

CatalystSDK.init(new AuthProviderImpl((HttpServletRequest) servletRequest));

Si estás desarrollando una aplicación Java con la herramienta de construcción Maven, puedes incluir el SDK de Catalyst Java como una dependencia en el archivo de configuración de Maven (pom.xml), en lugar de descargar y agregar el SDK en tu código fuente manualmente.

Para agregar el SDK de Catalyst en un proyecto Maven, simplemente agrega el repositorio de Zoho (publicado en MvnRepository) en el archivo pom.xml como se muestra a continuación:

<repositories>
	<repository>
      <id>java-sdk</id>
      <url>https://maven.zohodl.com</url>
    </repository>
  </repositories>

Luego puedes agregar el SDK de Java como dependencia en pom.xml como se muestra a continuación:

<dependencies>
    <dependency>
      <groupId>com.zoho.catalyst</groupId>
      <artifactId>java-sdk</artifactId>
      <version>1.15.0</version>
    </dependency>
 </dependencies>

Implement Catalyst Node.js SDK

Puedes instalar el paquete del SDK de Catalyst Node.js ejecutando el siguiente comando en tu terminal e incluyéndolo en el código fuente de tu aplicación:

npm install zcatalyst-sdk-node --save

Esto instalará la última versión compatible del SDK de Node.js. También puedes instalar una versión compatible específica de esta manera:

npm install zcatalyst-sdk-node@2.1.1 --save

Luego puedes inicializar el SDK de Node.js en el código de tu aplicación como se muestra en el código de ejemplo a continuación. Esto pasa el objeto de solicitud al método initialize().

const catalyst = require('zcatalyst-sdk-node')
const express = require('express')
const app = express()
app.get((req, res) => {
let catalystApp = catalyst.initialize(req);
//Tu código va aquí 
})
app.listen(process.env("X_ZOHO_CATALYST_LISTEN_PORT") || 9000)

Consulta la ayuda del SDK de Catalyst Node.js para obtener detalles. La documentación del SDK también proporciona fragmentos de código de ejemplo para todas las funcionalidades compatibles.

Implement Catalyst Python SDK

Puedes instalar el SDK de Catalyst Python para tu solución AppSail ejecutando el siguiente comando en tu terminal e incluyéndolo en el código fuente de tu aplicación:

pip install zcatalyst-sdk -t .

Luego puedes importar el SDK de Python en tu código para tu aplicación Catalyst. El SDK necesitará ser inicializado con el objeto de solicitud antes de cada solicitud.

A continuación se muestra un fragmento de código de ejemplo para importar e inicializar el SDK de Python en una aplicación web Flask:

from flask import Flask, request, g
import os
import zcatalyst_sdk
from zcatalyst_sdk.catalyst_app import CatalystApp
app = Flask(__name__)
@app.before_request
def before_request():
    if request.path.startswith('/admin'):
        return 'Unauthorized', 401
    # si el usuario está autorizado
    g.zc_app = zcatalyst_sdk.initialize(req=request)
@app.route('/')
def index():
    return 'Web App with Python Flask!'
@app.route('/cache')
def cache():
    app: CatalystApp = g.zc_app
    resp = app.cache().segment().put('key', 'value')
    return resp, 200
listen_port = os.getenv('X_ZOHO_CATALYST_LISTEN_PORT', 9000)
app.run(host='0.0.0.0', port = listen_port)

Consulta la ayuda del SDK de Catalyst Python para obtener detalles sobre las diversas funcionalidades del kit de herramientas del SDK y fragmentos de código de ejemplo.