Biblioteca cliente de Azure Mixed Reality para Java: versión 1.2.18

Artículo
10/25/2023

Mixed Reality servicios, como Azure Spatial Anchors, Azure Remote Rendering y otros, usan el servicio de token de seguridad (STS) de Mixed Reality para la autenticación. Este paquete admite el intercambio de credenciales de cuenta de Mixed Reality para un token de acceso desde el STS que se puede usar para acceder a Mixed Reality servicios.

Código | fuentePaquete (Maven) | Documentación | de referencia de API Documentación del producto

Diagrama de autenticación del servicio Mixed Reality

Introducción

Requisitos previos

Debe tener una suscripción de Azure.
Debe tener una cuenta con un servicio de Azure Mixed Reality:
- Azure Remote Rendering
- Azure Spatial Anchors
Kit de desarrollo de Java (JDK), versión 8 o posterior.
Apache Maven.
Familiaridad con los conceptos de autenticación y credenciales de Azure.Identity.

Inclusión del paquete

Inclusión del archivo BOM

Incluya azure-sdk-bom en el proyecto para depender de la versión de disponibilidad general (GA) de la biblioteca. En el fragmento de código siguiente, reemplace el marcador de posición {bom_version_to_target} por el número de versión. Para más información sobre la lista de materiales, consulte EL ARCHIVO LÉAME BOM del SDK de AZURE.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

y, a continuación, incluya la dependencia directa en la sección dependencias sin la etiqueta de versión, como se muestra a continuación.

<dependencies>
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-mixedreality-authentication</artifactId>
    </dependency>
</dependencies>

Inclusión de dependencias directas

Si quiere depender de una versión determinada de la biblioteca que no está presente en la lista de materiales, agregue la dependencia directa al proyecto como se indica a continuación.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-mixedreality-authentication</artifactId>
    <version>1.2.18</version>
</dependency>

Autenticar el cliente

Mixed Reality servicios admiten varias formas diferentes de autenticación:

Autenticación de clave de cuenta
- Las claves de cuenta le permiten empezar a trabajar rápidamente con Mixed Reality servicios. Sin embargo, antes de implementar la aplicación en la producción, es recomendable actualizarla para que pueda usar la autenticación de Azure AD.
Autenticación de tokens de Azure Active Directory (AD)
- Si va a compilar una aplicación empresarial y su empresa usa Azure AD como sistema de identidades, puede usar en la aplicación la autenticación de Azure AD basada en el usuario. A continuación, conceda acceso a las cuentas de Mixed Reality mediante los grupos de seguridad de Azure AD existentes. Igualmente, también puede conceder acceso directamente a los usuarios de la organización.
- En caso contrario, es recomendable que obtenga los tokens de Azure AD de un servicio web que sea compatible con la aplicación. Se recomienda este método para aplicaciones de producción, ya que permite evitar insertar las credenciales para acceder a un servicio de Mixed Reality en la aplicación cliente.

Consulte aquí para obtener instrucciones e información detalladas.

Conceptos clave

MixedRealityStsClient

MixedRealityStsClient es la biblioteca cliente que se usa para acceder al STS de Mixed Reality para obtener un token de acceso.

Los tokens obtenidos del STS de Mixed Reality tienen una duración de 24 horas.

Ejemplos

Creación del cliente

Para un cliente sincrónico:

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildClient();

Para un cliente asincrónico (tenga en cuenta la llamada a buildAsyncClient en lugar de buildClient):

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsAsyncClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildAsyncClient();

Recuperación de un token de acceso

AzureKeyCredential keyCredential = new AzureKeyCredential(accountKey);
MixedRealityStsClient client = new MixedRealityStsClientBuilder()
    .accountDomain(accountDomain)
    .accountId(accountId)
    .credential(keyCredential)
    .buildClient();

AccessToken token = client.getToken();

Consulte los ejemplos de autenticación anteriores para ver escenarios de autenticación más complejos.

Uso del token de acceso en una biblioteca cliente de Mixed Reality

Algunas Mixed Reality bibliotecas cliente pueden aceptar un token de acceso en lugar de una credencial. Por ejemplo:

// getMixedRealityAccessTokenFromWebService is a hypothetical method that retrieves
// a Mixed Reality access token from a web service. The web service would use the
// MixedRealityStsClient and credentials to obtain an access token to be returned
// to the client.
AccessToken accessToken = getMixedRealityAccessTokenFromWebService();

SpatialAnchorsAccount account = new SpatialAnchorsAccount(accountId, accountDomain);
SpatialAnchorsClient client = new SpatialAnchorsClient(account, accessToken);

Nota: El SpatialAnchorsClient uso anterior es hipotético y puede que no refleje la biblioteca real. Consulte la documentación de la biblioteca cliente que está usando para determinar si se puede admitir y cómo se puede admitir.

Solución de problemas

Describir errores y excepciones comunes, cómo "desempaquetarlos" si es necesario e incluir instrucciones para el control y la recuperación con gracia.

Proporcione información para ayudar a los desarrolladores a evitar la limitación u otros errores aplicados por el servicio que podrían encontrar. Por ejemplo, proporcione instrucciones y ejemplos para usar directivas de reintentos o de conexión en la API.

Si el paquete o un paquete relacionado lo admiten, incluya sugerencias para registrar o habilitar la instrumentación para ayudarles a depurar su código.

Pasos siguientes

Bibliotecas cliente que admiten la autenticación con la autenticación de Mixed Reality

Próximamente, las bibliotecas que admiten la autenticación de Mixed Reality.

Contribuciones

Este proyecto agradece las contribuciones y sugerencias. La mayoría de las contribuciones requieren que acepte un Contrato de licencia para el colaborador (CLA) que declara que tiene el derecho a concedernos y nos concede los derechos para usar su contribución. Para más detalles, visite https://cla.microsoft.com.

Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará de forma automática si tiene que aportar un CLA y completar la PR adecuadamente (por ejemplo, la etiqueta, el comentario). Solo siga las instrucciones que le dará el bot. Solo será necesario que lo haga una vez en todos los repositorios con nuestro CLA.

Este proyecto ha adoptado el Código de conducta de Microsoft Open Source. Para más información, consulte las preguntas más frecuentes del código de conducta o póngase en contacto con opencode@microsoft.com si tiene cualquier otra pregunta o comentario.

Impresiones

Compartir a través de